source: trunk/doc/html/qaccessible-h.html@ 203

Last change on this file since 203 was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 10.0 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qaccessible.h:1 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>qaccessible.h Include File</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>qaccessible.h</h1>
33
34<p>This is the verbatim text of the qaccessible.h include file. It is provided only for illustration; the copyright remains with Trolltech.
35<hr>
36<pre>
37/****************************************************************************
38** $Id: qaccessible-h.html 2051 2007-02-21 10:04:20Z chehrlic $
39**
40** Definition of QAccessible and QAccessibleObject classes
41**
42** Copyright (C) 2000-2007 Trolltech ASA. All rights reserved.
43**
44** This file is part of the kernel module of the Qt GUI Toolkit.
45**
46** This file may be distributed under the terms of the Q Public License
47** as defined by Trolltech ASA of Norway and appearing in the file
48** LICENSE.QPL included in the packaging of this file.
49**
50** This file may be distributed and/or modified under the terms of the
51** GNU General Public License version 2 as published by the Free Software
52** Foundation and appearing in the file LICENSE.GPL included in the
53** packaging of this file.
54**
55** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
56** licenses may use this file in accordance with the Qt Commercial License
57** Agreement provided with the Software.
58**
59** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
60** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
61**
62** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
63** information about Qt Commercial License Agreements.
64** See http://www.trolltech.com/qpl/ for QPL licensing information.
65** See http://www.trolltech.com/gpl/ for GPL licensing information.
66**
67** Contact info@trolltech.com if any conditions of this licensing are
68** not clear to you.
69**
70**********************************************************************/
71
72#ifndef QACCESSIBLE_H
73#define QACCESSIBLE_H
74
75#ifndef QT_H
76#include "qobject.h"
77#include &lt;private/qcom_p.h&gt;
78#include "qrect.h"
79#include "qguardedptr.h"
80#include "qmemarray.h"
81#endif // QT_H
82
83#if defined(QT_ACCESSIBILITY_SUPPORT)
84
85struct QAccessibleInterface;
86
87class Q_EXPORT QAccessible
88{
89private:
90#ifdef Q_WS_MAC
91 static QMAC_PASCAL OSStatus globalEventProcessor(EventHandlerCallRef, EventRef, void *);
92 static QObject *queryAccessibleObject(QAccessibleInterface *);
93#endif
94public:
95 enum Event {
96 SoundPlayed = 0x0001,
97 Alert = 0x0002,
98 ForegroundChanged = 0x0003,
99 MenuStart = 0x0004,
100 MenuEnd = 0x0005,
101 PopupMenuStart = 0x0006,
102 PopupMenuEnd = 0x0007,
103 ContextHelpStart = 0x000C,
104 ContextHelpEnd = 0x000D,
105 DragDropStart = 0x000E,
106 DragDropEnd = 0x000F,
107 DialogStart = 0x0010,
108 DialogEnd = 0x0011,
109 ScrollingStart = 0x0012,
110 ScrollingEnd = 0x0013,
111
112 MenuCommand = 0x0018,
113
114 ObjectCreated = 0x8000,
115 ObjectDestroyed = 0x8001,
116 ObjectShow = 0x8002,
117 ObjectHide = 0x8003,
118 ObjectReorder = 0x8004,
119 Focus = 0x8005,
120 Selection = 0x8006,
121 SelectionAdd = 0x8007,
122 SelectionRemove = 0x8008,
123 SelectionWithin = 0x8009,
124 StateChanged = 0x800A,
125 LocationChanged = 0x800B,
126 NameChanged = 0x800C,
127 DescriptionChanged = 0x800D,
128 ValueChanged = 0x800E,
129 ParentChanged = 0x800F,
130 HelpChanged = 0x80A0,
131 DefaultActionChanged= 0x80B0,
132 AcceleratorChanged = 0x80C0
133 };
134
135 enum State {
136 Normal = 0x00000000,
137 Unavailable = 0x00000001,
138 Selected = 0x00000002,
139 Focused = 0x00000004,
140 Pressed = 0x00000008,
141 Checked = 0x00000010,
142 Mixed = 0x00000020,
143 ReadOnly = 0x00000040,
144 HotTracked = 0x00000080,
145 Default = 0x00000100,
146 Expanded = 0x00000200,
147 Collapsed = 0x00000400,
148 Busy = 0x00000800,
149 Floating = 0x00001000,
150 Marqueed = 0x00002000,
151 Animated = 0x00004000,
152 Invisible = 0x00008000,
153 Offscreen = 0x00010000,
154 Sizeable = 0x00020000,
155 Moveable = 0x00040000,
156 SelfVoicing = 0x00080000,
157 Focusable = 0x00100000,
158 Selectable = 0x00200000,
159 Linked = 0x00400000,
160 Traversed = 0x00800000,
161 MultiSelectable = 0x01000000,
162 ExtSelectable = 0x02000000,
163 AlertLow = 0x04000000,
164 AlertMedium = 0x08000000,
165 AlertHigh = 0x10000000,
166 Protected = 0x20000000,
167 Valid = 0x3fffffff
168 };
169
170 enum Role {
171 NoRole = 0x00000000,
172 TitleBar = 0x00000001,
173 MenuBar = 0x00000002,
174 ScrollBar = 0x00000003,
175 Grip = 0x00000004,
176 Sound = 0x00000005,
177 Cursor = 0x00000006,
178 Caret = 0x00000007,
179 AlertMessage = 0x00000008,
180 Window = 0x00000009,
181 Client = 0x0000000A,
182 PopupMenu = 0x0000000B,
183 MenuItem = 0x0000000C,
184 ToolTip = 0x0000000D,
185 Application = 0x0000000E,
186 Document = 0x0000000F,
187 Pane = 0x00000010,
188 Chart = 0x00000011,
189 Dialog = 0x00000012,
190 Border = 0x00000013,
191 Grouping = 0x00000014,
192 Separator = 0x00000015,
193 ToolBar = 0x00000016,
194 StatusBar = 0x00000017,
195 Table = 0x00000018,
196 ColumnHeader = 0x00000019,
197 RowHeader = 0x0000001A,
198 Column = 0x0000001B,
199 Row = 0x0000001C,
200 Cell = 0x0000001D,
201 Link = 0x0000001E,
202 HelpBalloon = 0x0000001F,
203 Character = 0x00000020,
204 List = 0x00000021,
205 ListItem = 0x00000022,
206 Outline = 0x00000023,
207 OutlineItem = 0x00000024,
208 PageTab = 0x00000025,
209 PropertyPage = 0x00000026,
210 Indicator = 0x00000027,
211 Graphic = 0x00000028,
212 StaticText = 0x00000029,
213 EditableText = 0x0000002A, // Editable, selectable, etc.
214 PushButton = 0x0000002B,
215 CheckBox = 0x0000002C,
216 RadioButton = 0x0000002D,
217 ComboBox = 0x0000002E,
218 DropLest = 0x0000002F,
219 ProgressBar = 0x00000030,
220 Dial = 0x00000031,
221 HotkeyField = 0x00000032,
222 Slider = 0x00000033,
223 SpinBox = 0x00000034,
224 Diagram = 0x00000035,
225 Animation = 0x00000036,
226 Equation = 0x00000037,
227 ButtonDropDown = 0x00000038,
228 ButtonMenu = 0x00000039,
229 ButtonDropGrid = 0x0000003A,
230 Whitespace = 0x0000003B,
231 PageTabList = 0x0000003C,
232 Clock = 0x0000003D
233 };
234
235 enum NavDirection {
236 NavUp = 0x00000001,
237 NavDown = 0x00000002,
238 NavLeft = 0x00000003,
239 NavRight = 0x00000004,
240 NavNext = 0x00000005,
241 NavPrevious = 0x00000006,
242 NavFirstChild = 0x00000007,
243 NavLastChild = 0x00000008,
244 NavFocusChild = 0x00000009
245 };
246
247 enum Text {
248 Name = 0,
249 Description,
250 Value,
251 Help,
252 Accelerator,
253 DefaultAction
254 };
255
256 static QRESULT queryAccessibleInterface( QObject *, QAccessibleInterface ** );
257 static void updateAccessibility( QObject *, int who, Event reason );
258 static bool isActive();
259
260 static void initialize();
261 static void cleanup();
262};
263
264// {EC86CB9C-5DA0-4c43-A739-13EBDF1C6B14}
265#define IID_QAccessible QUuid( 0xec86cb9c, 0x5da0, 0x4c43, 0xa7, 0x39, 0x13, 0xeb, 0xdf, 0x1c, 0x6b, 0x14 )
266
267struct Q_EXPORT QAccessibleInterface : public QAccessible, public QUnknownInterface
268{
269 // check for valid pointers
270 virtual bool isValid() const = 0;
271
272 // hierarchy
273 virtual int childCount() const = 0;
274 virtual QRESULT queryChild( int control, QAccessibleInterface** ) const = 0;
275 virtual QRESULT queryParent( QAccessibleInterface** ) const = 0;
276
277 // navigation
278 virtual int controlAt( int x, int y ) const = 0;
279 virtual QRect rect( int control ) const = 0;
280 virtual int navigate( NavDirection direction, int startControl ) const = 0;
281
282 // properties and state
283 virtual QString text( Text t, int control ) const = 0;
284 virtual void setText( Text t, int control, const QString &amp;text ) = 0;
285 virtual Role role( int control ) const = 0;
286 virtual State state( int control ) const = 0;
287 virtual QMemArray&lt;int&gt; selection() const = 0;
288
289 // methods
290 virtual bool doDefaultAction( int control ) = 0;
291 virtual bool setFocus( int control ) = 0;
292 virtual bool setSelected( int control, bool on, bool extend ) = 0;
293 virtual void clearSelection() = 0;
294};
295
296// {49F4C6A7-412F-41DE-9E24-648843421FD3}
297#ifndef IID_QAccessibleFactory
298#define IID_QAccessibleFactory QUuid( 0x49f4c6a7, 0x412f, 0x41de, 0x9e, 0x24, 0x64, 0x88, 0x43, 0x42, 0x1f, 0xd3 )
299#endif
300
301struct Q_EXPORT QAccessibleFactoryInterface : public QAccessible, public QFeatureListInterface
302{
303 virtual QRESULT createAccessibleInterface( const QString &amp;, QObject *, QAccessibleInterface** ) = 0;
304};
305
306class Q_EXPORT QAccessibleObject : public QObject, public QAccessibleInterface
307{
308public:
309 QAccessibleObject( QObject *object );
310 virtual ~QAccessibleObject();
311
312 QRESULT queryInterface( const QUuid &amp;, QUnknownInterface** );
313 Q_REFCOUNT
314
315 bool isValid() const;
316
317protected:
318 QObject *object() const;
319
320private:
321 QGuardedPtr&lt;QObject&gt; object_;
322};
323
324#define Q_DEFINED_QACCESSIBLE_OBJECT
325#include "qwinexport.h"
326#endif //QT_ACCESSIBILITY_SUPPORT
327
328#endif //QACCESSIBLE_H
329</pre>
330<!-- eof -->
331<p><address><hr><div align=center>
332<table width=100% cellspacing=0 border=0><tr>
333<td>Copyright &copy; 2007
334<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
335<td align=right><div align=right>Qt 3.3.8</div>
336</table></div></address></body>
337</html>
Note: See TracBrowser for help on using the repository browser.