src/gui/accessible/qaccessibleplugin.cpp
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 "qaccessibleplugin.h"
       
    43 
       
    44 #ifndef QT_NO_ACCESSIBILITY
       
    45 
       
    46 #include "qaccessible.h"
       
    47 
       
    48 QT_BEGIN_NAMESPACE
       
    49 
       
    50 /*!
       
    51     \class QAccessiblePlugin
       
    52     \brief The QAccessiblePlugin class provides an abstract base for
       
    53     accessibility plugins.
       
    54 
       
    55     \ingroup plugins
       
    56     \ingroup accessibility
       
    57 
       
    58     Writing an accessibility plugin is achieved by subclassing this
       
    59     base class, reimplementing the pure virtual functions keys() and
       
    60     create(), and exporting the class with the Q_EXPORT_PLUGIN2()
       
    61     macro.
       
    62 
       
    63     \sa QAccessibleBridgePlugin, {How to Create Qt Plugins}
       
    64 */
       
    65 
       
    66 /*!
       
    67     Constructs an accessibility plugin with the given \a parent. This
       
    68     is invoked automatically by the Q_EXPORT_PLUGIN2() macro.
       
    69 */
       
    70 QAccessiblePlugin::QAccessiblePlugin(QObject *parent)
       
    71     : QObject(parent)
       
    72 {
       
    73 }
       
    74 
       
    75 /*!
       
    76     Destroys the accessibility plugin.
       
    77 
       
    78     You never have to call this explicitly. Qt destroys a plugin
       
    79     automatically when it is no longer used.
       
    80 */
       
    81 QAccessiblePlugin::~QAccessiblePlugin()
       
    82 {
       
    83 }
       
    84 
       
    85 /*!
       
    86     \fn QStringList QAccessiblePlugin::keys() const
       
    87 
       
    88     Returns the list of keys this plugin supports.
       
    89 
       
    90     These keys must be the class names that this plugin provides
       
    91     an accessibility implementation for.
       
    92 
       
    93     \sa create()
       
    94 */
       
    95 
       
    96 /*!
       
    97     \fn QAccessibleInterface *QAccessiblePlugin::create(const QString &key, QObject *object)
       
    98 
       
    99     Creates and returns a QAccessibleInterface implementation for the
       
   100     class \a key and the object \a object. Keys are case sensitive.
       
   101 
       
   102     \sa keys()
       
   103 */
       
   104 
       
   105 QT_END_NAMESPACE
       
   106 
       
   107 #endif // QT_NO_ACCESSIBILITY