Qt 4.8
qaccessiblewidget.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 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 #ifndef QACCESSIBLEWIDGET_H
43 #define QACCESSIBLEWIDGET_H
44 
45 #include <QtGui/qaccessibleobject.h>
46 
48 
50 
51 QT_MODULE(Gui)
52 
53 #ifndef QT_NO_ACCESSIBILITY
54 
56 
58 {
59 public:
60  explicit QAccessibleWidget(QWidget *o, Role r = Client, const QString& name = QString());
61 
62  int childCount() const;
63  int indexOfChild(const QAccessibleInterface *child) const;
64  Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const;
65 
66  int childAt(int x, int y) const;
67  QRect rect(int child) const;
68  int navigate(RelationFlag rel, int entry, QAccessibleInterface **target) const;
69 
70  QString text(Text t, int child) const;
71  Role role(int child) const;
72  State state(int child) const;
73 
74 #ifndef QT_NO_ACTION
75  int userActionCount(int child) const;
76  QString actionText(int action, Text t, int child) const;
77  bool doAction(int action, int child, const QVariantList &params);
78 #endif
79 
80 protected:
82  QWidget *widget() const;
83  QObject *parentObject() const;
84 
85  void addControllingSignal(const QString &signal);
86  void setValue(const QString &value);
87  void setDescription(const QString &desc);
88  void setHelp(const QString &help);
89  void setAccelerator(const QString &accel);
90 
91 private:
92  friend class QAccessibleWidgetEx;
95 };
96 
98 {
99 public:
100  explicit QAccessibleWidgetEx(QWidget *o, Role r = Client, const QString& name = QString());
101 
102  int childCount() const;
103  int indexOfChild(const QAccessibleInterface *child) const;
104  Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const;
105 
106  int childAt(int x, int y) const;
107  QRect rect(int child) const;
108  int navigate(RelationFlag rel, int entry, QAccessibleInterface **target) const;
109 
110  QString text(Text t, int child) const;
111  Role role(int child) const;
112  State state(int child) const;
113 
114  QString actionText(int action, Text t, int child) const;
115  bool doAction(int action, int child, const QVariantList &params);
116 
117  QVariant invokeMethodEx(Method method, int child, const QVariantList &params);
118 
119 protected:
121  QWidget *widget() const;
122  QObject *parentObject() const;
123 
124  void addControllingSignal(const QString &signal);
125  void setValue(const QString &value);
126  void setDescription(const QString &desc);
127  void setHelp(const QString &help);
128  void setAccelerator(const QString &accel);
129 
130 private:
133 };
134 
135 #endif // QT_NO_ACCESSIBILITY
136 
138 
140 
141 #endif // QACCESSIBLEWIDGET_H
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
QAccessibleWidgetPrivate * d
virtual int indexOfChild(const QAccessibleInterface *) const =0
Returns the 1-based index of the object child in this object&#39;s children list, or -1 if child is not a...
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QPointer< QWidget > widget
#define QT_MODULE(x)
Definition: qglobal.h:2783
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
virtual State state(int child) const =0
Returns the current state of the object, or of the object&#39;s child if child is not 0...
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
Role
This enum defines the role of an accessible object.
Definition: qaccessible.h:188
QAccessibleWidgetPrivate * d
The QWidget class is the base class of all user interface objects.
Definition: qwidget.h:150
virtual int childCount() const =0
Returns the number of children that belong to this object.
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
bool doAction(int action, int child, const QVariantList &params)
Reimplemented Function
virtual int childAt(int x, int y) const =0
Returns the 1-based index of the child that contains the screen coordinates (x, y).
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
virtual int navigate(RelationFlag relation, int index, QAccessibleInterface **iface) const =0
Navigates from this object to an object that has a relationship relation to this object, and returns the respective object in target.
RelationFlag
This enum type defines bit flags that can be combined to indicate the relationship between two access...
Definition: qaccessible.h:268
Method
This enum describes the possible types of methods that can be invoked on an accessible object...
Definition: qaccessible.h:311
const char * name
int userActionCount(int child) const
Reimplemented Function
The State element defines configurations of objects and properties.
bool doAction(int action, int child, const QVariantList &params)
Asks the object, or the object&#39;s child if child is not 0, to execute action using the parameters...
The QAccessibleWidget class implements the QAccessibleInterface for QWidgets.
QString actionText(int action, Text t, int child) const
Reimplemented Function
virtual Role role(int child) const =0
Returns the role of the object, or of the object&#39;s child if child is not 0.
QRect rect(int child) const
Returns the geometry of the object, or of the object&#39;s child if child is not 0.
virtual Relation relationTo(int child, const QAccessibleInterface *other, int otherChild) const =0
Returns the relationship between this object&#39;s \a child and the \a other object&#39;s \a otherChild...
The QAccessibleInterface class defines an interface that exposes information about accessible objects...
Definition: qaccessible.h:370
virtual QString text(Text t, int child) const =0
Returns the value of the text property t of the object, or of the object&#39;s child if child is not 0...
The QRect class defines a rectangle in the plane using integer precision.
Definition: qrect.h:58
The QAccessibleObject class implements parts of the QAccessibleInterface for QObjects.
virtual QVariant invokeMethodEx(Method method, int child, const QVariantList &params)=0
#define QT_END_HEADER
Definition: qglobal.h:137
QRect rect(int child) const
Reimplemented Function
QString actionText(int action, Text t, int child) const
Returns the text property t of the action action supported by the object, or of the object&#39;s child if...
The Text item allows you to add formatted text to a scene.