src/gui/accessible/qaccessibleplugin.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 <QtCore/qglobal.h>
  43
  44 #ifndef QT_NO_ACCESSIBILITY
  45
  46 #include "qaccessibleplugin.h"
  47 #include "qaccessible.h"
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 /*!
  52     \class QAccessiblePlugin
  53     \brief The QAccessiblePlugin class provides an abstract base for
  54     accessibility plugins.
  55     \internal
  56
  57     \ingroup plugins
  58     \ingroup accessibility
  59
  60     Writing an accessibility plugin is achieved by subclassing this
  61     base class, reimplementing the pure virtual function create(),
  62     and exporting the class with the Q_PLUGIN_METADATA() macro.
  63
  64     \sa QAccessibleBridgePlugin, {How to Create Qt Plugins}
  65 */
  66
  67 /*!
  68     Constructs an accessibility plugin with the given \a parent. This
  69     is invoked automatically by the plugin loader.
  70 */
  71 QAccessiblePlugin::QAccessiblePlugin(QObject *parent)
  72     : QObject(parent)
  73 {
  74 }
  75
  76 /*!
  77     Destroys the accessibility plugin.
  78
  79     You never have to call this explicitly. Qt destroys a plugin
  80     automatically when it is no longer used.
  81 */
  82 QAccessiblePlugin::~QAccessiblePlugin()
  83 {
  84 }
  85
  86 /*!
  87     \fn QAccessibleInterface *QAccessiblePlugin::create(const QString &key, QObject *object)
  88
  89     Creates and returns a QAccessibleInterface implementation for the
  90     class \a key and the object \a object. Keys are case sensitive.
  91
  92     \sa keys()
  93 */
  94
  95 QT_END_NAMESPACE
  96
  97 #endif // QT_NO_ACCESSIBILITY