1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtGui module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    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 

    53     \ingroup accessibility

    54 

    55     Qt supports Microsoft Active Accessibility (MSAA), Mac OS X

    56     Accessibility, and the Unix/X11 AT-SPI standard. By subclassing

    57     QAccessibleBridge, you can support other backends than the

    58     predefined ones.

    59 

    60     Currently, custom bridges are only supported on Unix. We might

    61     add support for them on other platforms as well if there is

    62     enough demand.

    63 

    64     \sa QAccessible, QAccessibleBridgePlugin

    65 */

    66 

    67 /*!

    68     \fn QAccessibleBridge::~QAccessibleBridge()

    69 

    70     Destroys the accessibility bridge object.

    71 */

    72 

    73 /*!

    74     \fn void QAccessibleBridge::setRootObject(QAccessibleInterface *object)

    75 

    76     This function is called by Qt at application startup to set the

    77     root accessible object of the application to \a object. All other

    78     accessible objects in the application can be reached by the

    79     client using object navigation.

    80 */

    81 

    82 /*!

    83     \fn void QAccessibleBridge::notifyAccessibilityUpdate(int reason, QAccessibleInterface *interface, int child)

    84 

    85     This function is called by Qt to notify the bridge about a change

    86     in the accessibility information for object wrapped by the given

    87     \a interface.

    88 

    89     \a reason specifies the cause of the change. It can take values

    90     of type QAccessible::Event.

    91 

    92     \a child is the (1-based) index of the child element that has

    93     changed. When \a child is 0, the object itself has changed.

    94 

    95     \sa QAccessible::updateAccessibility()

    96 */

    97 

    98 /*!

    99     \class QAccessibleBridgePlugin

   100     \brief The QAccessibleBridgePlugin class provides an abstract

   101     base for accessibility bridge plugins.

   102 

   103     \ingroup plugins

   104     \ingroup accessibility

   105 

   106     Writing an accessibility bridge plugin is achieved by subclassing

   107     this base class, reimplementing the pure virtual functions keys()

   108     and create(), and exporting the class with the

   109     Q_EXPORT_PLUGIN2() macro.

   110 

   111     \sa QAccessibleBridge, QAccessiblePlugin, {How to Create Qt Plugins}

   112 */

   113 

   114 /*!

   115     Constructs an accessibility bridge plugin with the given \a

   116     parent. This is invoked automatically by the Q_EXPORT_PLUGIN2()

   117     macro.

   118 */

   119 QAccessibleBridgePlugin::QAccessibleBridgePlugin(QObject *parent)

   120     : QObject(parent)

   121 {

   122 

   123 }

   124 

   125 /*!

   126     Destroys the accessibility bridge plugin.

   127 

   128     You never have to call this explicitly. Qt destroys a plugin

   129     automatically when it is no longer used.

   130 */

   131 QAccessibleBridgePlugin::~QAccessibleBridgePlugin()

   132 {

   133 

   134 }

   135 

   136 /*!

   137     \fn QStringList QAccessibleBridgePlugin::keys() const

   138 

   139     Returns the list of keys this plugins supports.

   140 

   141     These keys must be the names of the bridges that this

   142     plugin provides.

   143 

   144     \sa create()

   145 */

   146 

   147 /*!

   148     \fn QAccessibleBridge *QAccessibleBridgePlugin::create(const QString &key)

   149 

   150     Creates and returns the QAccessibleBridge object corresponding to

   151     the given \a key. Keys are case sensitive.

   152 

   153     \sa keys()

   154 */

   155 

   156 QT_END_NAMESPACE

   157 

   158 #endif // QT_NO_ACCESSIBILITY