blob: c6a417e063814a43bc6a1609fa09b4e2b73f18ed [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qaccessiblebridge.h"
#ifndef QT_NO_ACCESSIBILITY
QT_BEGIN_NAMESPACE
/*!
\class QAccessibleBridge
\brief The QAccessibleBridge class is the base class for
accessibility back-ends.
\internal
\ingroup accessibility
\inmodule QtWidgets
Qt supports Microsoft Active Accessibility (MSAA), \macos
Accessibility, and the Unix/X11 AT-SPI standard. By subclassing
QAccessibleBridge, you can support other backends than the
predefined ones.
Currently, custom bridges are only supported on Unix. We might
add support for them on other platforms as well if there is
enough demand.
\sa QAccessible, QAccessibleBridgePlugin
*/
/*!
\fn QAccessibleBridge::~QAccessibleBridge()
Destroys the accessibility bridge object.
*/
/*!
\fn void QAccessibleBridge::setRootObject(QAccessibleInterface *object)
This function is called by Qt at application startup to set the
root accessible object of the application to \a object. All other
accessible objects in the application can be reached by the
client using object navigation.
*/
/*!
\fn void QAccessibleBridge::notifyAccessibilityUpdate(QAccessibleEvent *event)
This function is called by Qt to notify the bridge about a change
in the accessibility information. The \a event specifies the interface,
object, reason and child element that has changed.
\sa QAccessible::updateAccessibility()
*/
/*!
\class QAccessibleBridgePlugin
\brief The QAccessibleBridgePlugin class provides an abstract
base for accessibility bridge plugins.
\internal
\ingroup plugins
\ingroup accessibility
\inmodule QtWidgets
Writing an accessibility bridge plugin is achieved by subclassing
this base class, reimplementing the pure virtual function create(),
and exporting the class with the Q_PLUGIN_METADATA() macro.
\sa QAccessibleBridge, QAccessiblePlugin, {How to Create Qt Plugins}
*/
/*!
Constructs an accessibility bridge plugin with the given \a
parent. This is invoked automatically by the plugin loader.
*/
QAccessibleBridgePlugin::QAccessibleBridgePlugin(QObject *parent)
: QObject(parent)
{
}
/*!
Destroys the accessibility bridge plugin.
You never have to call this explicitly. Qt destroys a plugin
automatically when it is no longer used.
*/
QAccessibleBridgePlugin::~QAccessibleBridgePlugin()
{
}
/*!
\fn QAccessibleBridge *QAccessibleBridgePlugin::create(const QString &key)
Creates and returns the QAccessibleBridge object corresponding to
the given \a key. Keys are case sensitive.
\sa keys()
*/
QT_END_NAMESPACE
#endif // QT_NO_ACCESSIBILITY