katie/src/gui/accessible/qaccessiblebridge.cpp
Ivailo Monev 80d4bc168e more copyright changes
Signed-off-by: Ivailo Monev <xakepa10@laimg.moc>
2019-06-03 14:21:30 +00:00

161 lines
5 KiB
C++

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Copyright (C) 2016-2019 Ivailo Monev
**
** This file is part of the QtGui module of the Katie 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.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.
\ingroup accessibility
Qt supports Microsoft Active Accessibility (MSAA), Mac OS X
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(int reason, QAccessibleInterface *interface, int child)
This function is called by Qt to notify the bridge about a change
in the accessibility information for object wrapped by the given
\a interface.
\a reason specifies the cause of the change. It can take values
of type QAccessible::Event.
\a child is the (1-based) index of the child element that has
changed. When \a child is 0, the object itself has changed.
\sa QAccessible::updateAccessibility()
*/
/*!
\class QAccessibleBridgePlugin
\brief The QAccessibleBridgePlugin class provides an abstract
base for accessibility bridge plugins.
\ingroup plugins
\ingroup accessibility
Writing an accessibility bridge plugin is achieved by subclassing
this base class, reimplementing the pure virtual functions keys()
and create(), and exporting the class with the
Q_EXPORT_PLUGIN2() 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 Q_EXPORT_PLUGIN2()
macro.
*/
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 QStringList QAccessibleBridgePlugin::keys() const
Returns the list of keys this plugins supports.
These keys must be the names of the bridges that this
plugin provides.
\sa create()
*/
/*!
\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
#include "moc_qaccessiblebridge.h"
#endif // QT_NO_ACCESSIBILITY