src/gui/accessible/qaccessiblebridge.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qaccessiblebridge.h"
  43
  44 #ifndef QT_NO_ACCESSIBILITY
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 /*!
  49     \class QAccessibleBridge
  50     \brief The QAccessibleBridge class is the base class for
  51     accessibility back-ends.
  52     \internal
  53
  54     \ingroup accessibility
  55     \inmodule QtWidgets
  56
  57     Qt supports Microsoft Active Accessibility (MSAA), Mac OS X
  58     Accessibility, and the Unix/X11 AT-SPI standard. By subclassing
  59     QAccessibleBridge, you can support other backends than the
  60     predefined ones.
  61
  62     Currently, custom bridges are only supported on Unix. We might
  63     add support for them on other platforms as well if there is
  64     enough demand.
  65
  66     \sa QAccessible, QAccessibleBridgePlugin
  67 */
  68
  69 /*!
  70     \fn QAccessibleBridge::~QAccessibleBridge()
  71
  72     Destroys the accessibility bridge object.
  73 */
  74
  75 /*!
  76     \fn void QAccessibleBridge::setRootObject(QAccessibleInterface *object)
  77
  78     This function is called by Qt at application startup to set the
  79     root accessible object of the application to \a object. All other
  80     accessible objects in the application can be reached by the
  81     client using object navigation.
  82 */
  83
  84 /*!
  85     \fn void QAccessibleBridge::notifyAccessibilityUpdate(QAccessibleEvent *event)
  86
  87     This function is called by Qt to notify the bridge about a change
  88     in the accessibility information. The \a event specifies the interface,
  89     object, reason and child element that has changed.
  90
  91     \sa QAccessible::updateAccessibility()
  92 */
  93
  94 /*!
  95     \class QAccessibleBridgePlugin
  96     \brief The QAccessibleBridgePlugin class provides an abstract
  97     base for accessibility bridge plugins.
  98     \internal
  99
 100     \ingroup plugins
 101     \ingroup accessibility
 102     \inmodule QtWidgets
 103
 104     Writing an accessibility bridge plugin is achieved by subclassing
 105     this base class, reimplementing the pure virtual function create(),
 106     and exporting the class with the Q_PLUGIN_METADATA() macro.
 107
 108     \sa QAccessibleBridge, QAccessiblePlugin, {How to Create Qt Plugins}
 109 */
 110
 111 /*!
 112     Constructs an accessibility bridge plugin with the given \a
 113     parent. This is invoked automatically by the plugin loader.
 114 */
 115 QAccessibleBridgePlugin::QAccessibleBridgePlugin(QObject *parent)
 116     : QObject(parent)
 117 {
 118
 119 }
 120
 121 /*!
 122     Destroys the accessibility bridge plugin.
 123
 124     You never have to call this explicitly. Qt destroys a plugin
 125     automatically when it is no longer used.
 126 */
 127 QAccessibleBridgePlugin::~QAccessibleBridgePlugin()
 128 {
 129
 130 }
 131
 132 /*!
 133     \fn QAccessibleBridge *QAccessibleBridgePlugin::create(const QString &key)
 134
 135     Creates and returns the QAccessibleBridge object corresponding to
 136     the given \a key. Keys are case sensitive.
 137
 138     \sa keys()
 139 */
 140
 141 QT_END_NAMESPACE
 142
 143 #endif // QT_NO_ACCESSIBILITY