- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Directories
- Examples

- File List
- File Members

# qaccessibleobject.h

Go to the documentation of this file.

    00001 /****************************************************************************
    00002 **
    00003 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
    00004 ** All rights reserved.
    00005 ** Contact: Nokia Corporation (qt-info@nokia.com)
    00006 **
    00007 ** This file is part of the QtGui module of the Qt Toolkit.
    00008 **
    00009 ** $QT_BEGIN_LICENSE:LGPL$
    00010 ** Commercial Usage
    00011 ** Licensees holding valid Qt Commercial licenses may use this file in
    00012 ** accordance with the Qt Commercial License Agreement provided with the
    00013 ** Software or, alternatively, in accordance with the terms contained in
    00014 ** a written agreement between you and Nokia.
    00015 **
    00016 ** GNU Lesser General Public License Usage
    00017 ** Alternatively, this file may be used under the terms of the GNU Lesser
    00018 ** General Public License version 2.1 as published by the Free Software
    00019 ** Foundation and appearing in the file LICENSE.LGPL included in the
    00020 ** packaging of this file.  Please review the following information to
    00021 ** ensure the GNU Lesser General Public License version 2.1 requirements
    00022 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
    00023 **
    00024 ** In addition, as a special exception, Nokia gives you certain additional
    00025 ** rights.  These rights are described in the Nokia Qt LGPL Exception
    00026 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this module.
    00027 **
    00028 ** GNU General Public License Usage
    00029 ** Alternatively, this file may be used under the terms of the GNU
    00030 ** General Public License version 3.0 as published by the Free Software
    00031 ** Foundation and appearing in the file LICENSE.GPL included in the
    00032 ** packaging of this file.  Please review the following information to
    00033 ** ensure the GNU General Public License version 3.0 requirements will be
    00034 ** met: http://www.gnu.org/copyleft/gpl.html.
    00035 **
    00036 ** If you have questions regarding the use of this file, please contact
    00037 ** Nokia at qt-info@nokia.com.
    00038 ** $QT_END_LICENSE$
    00039 **
    00040 ****************************************************************************/
    00041
    00042 #ifndef QACCESSIBLEOBJECT_H
    00043 #define QACCESSIBLEOBJECT_H
    00044
    00045 #include <QtGui/qaccessible.h>
    00046
    00047 QT_BEGIN_HEADER
    00048
    00049 QT_BEGIN_NAMESPACE
    00050
    00051 QT_MODULE(Gui)
    00052
    00053 #ifndef QT_NO_ACCESSIBILITY
    00054
    00055 class QAccessibleObjectPrivate;
    00056 class QObject;
    00057
    00058 class Q_GUI_EXPORT QAccessibleObject : public QAccessibleInterface
    00059 {
    00060 public:
    00061     explicit QAccessibleObject(QObject *object);
    00062
    00063     bool isValid() const;
    00064     QObject *object() const;
    00065
    00066     // properties
    00067     QRect rect(int child) const;
    00068     void setText(Text t, int child, const QString &text);
    00069
    00070     // actions
    00071     int userActionCount(int child) const;
    00072     bool doAction(int action, int child, const QVariantList &params);
    00073     QString actionText(int action, Text t, int child) const;
    00074
    00075 protected:
    00076     virtual ~QAccessibleObject();
    00077
    00078 private:
    00079     friend class QAccessibleObjectEx;
    00080     QAccessibleObjectPrivate *d;
    00081     Q_DISABLE_COPY(QAccessibleObject)
    00082 };
    00083
    00084 class Q_GUI_EXPORT QAccessibleObjectEx : public QAccessibleInterfaceEx
    00085 {
    00086 public:
    00087     explicit QAccessibleObjectEx(QObject *object);
    00088
    00089     bool isValid() const;
    00090     QObject *object() const;
    00091
    00092     // properties
    00093     QRect rect(int child) const;
    00094     void setText(Text t, int child, const QString &text);
    00095
    00096     // actions
    00097     int userActionCount(int child) const;
    00098     bool doAction(int action, int child, const QVariantList &params);
    00099     QString actionText(int action, Text t, int child) const;
    00100
    00101 protected:
    00102     virtual ~QAccessibleObjectEx();
    00103
    00104 private:
    00105     QAccessibleObjectPrivate *d;
    00106     Q_DISABLE_COPY(QAccessibleObjectEx)
    00107 };
    00108
    00109 class Q_GUI_EXPORT QAccessibleApplication : public QAccessibleObject
    00110 {
    00111 public:
    00112     QAccessibleApplication();
    00113
    00114     // relations
    00115     int childCount() const;
    00116     int indexOfChild(const QAccessibleInterface*) const;
    00117     Relation relationTo(int, const QAccessibleInterface *, int) const;
    00118
    00119     // navigation
    00120     int childAt(int x, int y) const;
    00121     int navigate(RelationFlag, int, QAccessibleInterface **) const;
    00122
    00123     // properties and state
    00124     QString text(Text t, int child) const;
    00125     Role role(int child) const;
    00126     State state(int child) const;
    00127
    00128     // actions
    00129     int userActionCount(int child) const;
    00130     bool doAction(int action, int child, const QVariantList &params);
    00131     QString actionText(int action, Text t, int child) const;
    00132 };
    00133
    00134 #endif // QT_NO_ACCESSIBILITY
    00135
    00136 QT_END_NAMESPACE
    00137
    00138 QT_END_HEADER
    00139
    00140 #endif // QACCESSIBLEOBJECT_H