1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qaccessible.cpp:46 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QAccessible Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">Home</font></a>
| <a href="classes.html">
<font color="#004faf">All Classes</font></a>
| <a href="mainclasses.html">
<font color="#004faf">Main Classes</font></a>
| <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
| <a href="groups.html">
<font color="#004faf">Grouped Classes</font></a>
| <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QAccessible Class Reference</h1>
<p>The QAccessible class provides enums and static functions
relating to accessibility.
<a href="#details">More...</a>
<p><tt>#include <<a href="qaccessible-h.html">qaccessible.h</a>></tt>
<p>Inherited by <a href="qaccessibleinterface.html">QAccessibleInterface</a>.
<p><a href="qaccessible-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>enum <a href="#Event-enum"><b>Event</b></a> { SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged = 0x0003, MenuStart = 0x0004, MenuEnd = 0x0005, PopupMenuStart = 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C, ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd = 0x000F, DialogStart = 0x0010, DialogEnd = 0x0011, ScrollingStart = 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018, ObjectCreated = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002, ObjectHide = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection = 0x8006, SelectionAdd = 0x8007, SelectionRemove = 0x8008, SelectionWithin = 0x8009, StateChanged = 0x800A, LocationChanged = 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D, ValueChanged = 0x800E, ParentChanged = 0x800F, HelpChanged = 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0 }</li>
<li class=fn>enum <a href="#State-enum"><b>State</b></a> { Normal = 0x00000000, Unavailable = 0x00000001, Selected = 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked = 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked = 0x00000080, Default = 0x00000100, Expanded = 0x00000200, Collapsed = 0x00000400, Busy = 0x00000800, Floating = 0x00001000, Marqueed = 0x00002000, Animated = 0x00004000, Invisible = 0x00008000, Offscreen = 0x00010000, Sizeable = 0x00020000, Moveable = 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000, Selectable = 0x00200000, Linked = 0x00400000, Traversed = 0x00800000, MultiSelectable = 0x01000000, ExtSelectable = 0x02000000, AlertLow = 0x04000000, AlertMedium = 0x08000000, AlertHigh = 0x10000000, Protected = 0x20000000, Valid = 0x3fffffff }</li>
<li class=fn>enum <a href="#Role-enum"><b>Role</b></a> { NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar = 0x00000002, ScrollBar = 0x00000003, Grip = 0x00000004, Sound = 0x00000005, Cursor = 0x00000006, Caret = 0x00000007, AlertMessage = 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu = 0x0000000B, MenuItem = 0x0000000C, ToolTip = 0x0000000D, Application = 0x0000000E, Document = 0x0000000F, Pane = 0x00000010, Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013, Grouping = 0x00000014, Separator = 0x00000015, ToolBar = 0x00000016, StatusBar = 0x00000017, Table = 0x00000018, ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column = 0x0000001B, Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E, HelpBalloon = 0x0000001F, Character = 0x00000020, List = 0x00000021, ListItem = 0x00000022, Outline = 0x00000023, OutlineItem = 0x00000024, PageTab = 0x00000025, PropertyPage = 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028, StaticText = 0x00000029, EditableText = 0x0000002A, PushButton = 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D, ComboBox = 0x0000002E, DropLest = 0x0000002F, ProgressBar = 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider = 0x00000033, SpinBox = 0x00000034, Diagram = 0x00000035, Animation = 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038, ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace = 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D }</li>
<li class=fn>enum <a href="#NavDirection-enum"><b>NavDirection</b></a> { NavUp = 0x00000001, NavDown = 0x00000002, NavLeft = 0x00000003, NavRight = 0x00000004, NavNext = 0x00000005, NavPrevious = 0x00000006, NavFirstChild = 0x00000007, NavLastChild = 0x00000008, NavFocusChild = 0x00000009 }</li>
<li class=fn>enum <a href="#Text-enum"><b>Text</b></a> { Name = 0, Description, Value, Help, Accelerator, DefaultAction }</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>QRESULT <a href="#queryAccessibleInterface"><b>queryAccessibleInterface</b></a> ( QObject * object, QAccessibleInterface ** iface )</li>
<li class=fn>void <a href="#updateAccessibility"><b>updateAccessibility</b></a> ( QObject * object, int control, Event reason )</li>
<li class=fn>bool <a href="#isActive"><b>isActive</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>
The QAccessible class provides enums and static functions
relating to accessibility.
<p>
<p> Accessibility clients use implementations of the
<a href="qaccessibleinterface.html">QAccessibleInterface</a> to read the information an accessible object
exposes, or to call functions to manipulate the accessible object.
<p>
<p> See the <a href="plugins-howto.html">plugin documentation</a> for
more details about how to redistribute Qt plugins.
<p>See also <a href="misc.html">Miscellaneous Classes</a>.
<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="Event-enum"></a>QAccessible::Event</h3>
<p> This enum type defines event types when the state of the
accessible object has changed. The event types are:
<ul>
<li><tt>QAccessible::SoundPlayed</tt>
<li><tt>QAccessible::Alert</tt>
<li><tt>QAccessible::ForegroundChanged</tt>
<li><tt>QAccessible::MenuStart</tt>
<li><tt>QAccessible::MenuEnd</tt>
<li><tt>QAccessible::PopupMenuStart</tt>
<li><tt>QAccessible::PopupMenuEnd</tt>
<li><tt>QAccessible::ContextHelpStart</tt>
<li><tt>QAccessible::ContextHelpEnd</tt>
<li><tt>QAccessible::DragDropStart</tt>
<li><tt>QAccessible::DragDropEnd</tt>
<li><tt>QAccessible::DialogStart</tt>
<li><tt>QAccessible::DialogEnd</tt>
<li><tt>QAccessible::ScrollingStart</tt>
<li><tt>QAccessible::ScrollingEnd</tt>
<li><tt>QAccessible::ObjectCreated</tt>
<li><tt>QAccessible::ObjectDestroyed</tt>
<li><tt>QAccessible::ObjectShow</tt>
<li><tt>QAccessible::ObjectHide</tt>
<li><tt>QAccessible::ObjectReorder</tt>
<li><tt>QAccessible::Focus</tt>
<li><tt>QAccessible::Selection</tt>
<li><tt>QAccessible::SelectionAdd</tt>
<li><tt>QAccessible::SelectionRemove</tt>
<li><tt>QAccessible::SelectionWithin</tt>
<li><tt>QAccessible::StateChanged</tt>
<li><tt>QAccessible::LocationChanged</tt>
<li><tt>QAccessible::NameChanged</tt>
<li><tt>QAccessible::DescriptionChanged</tt>
<li><tt>QAccessible::ValueChanged</tt>
<li><tt>QAccessible::ParentChanged</tt>
<li><tt>QAccessible::HelpChanged</tt>
<li><tt>QAccessible::DefaultActionChanged</tt>
<li><tt>QAccessible::AcceleratorChanged</tt>
<li><tt>QAccessible::MenuCommand</tt>
</ul>
<h3 class=fn><a name="NavDirection-enum"></a>QAccessible::NavDirection</h3>
<p> This enum specifies which item to move to when navigating.
<ul>
<li><tt>QAccessible::NavUp</tt> - sibling above
<li><tt>QAccessible::NavDown</tt> - sibling below
<li><tt>QAccessible::NavLeft</tt> - left sibling
<li><tt>QAccessible::NavRight</tt> - right sibling
<li><tt>QAccessible::NavNext</tt> - next sibling
<li><tt>QAccessible::NavPrevious</tt> - previous sibling
<li><tt>QAccessible::NavFirstChild</tt> - first child
<li><tt>QAccessible::NavLastChild</tt> - last child
<li><tt>QAccessible::NavFocusChild</tt> - child with focus
</ul>
<h3 class=fn><a name="Role-enum"></a>QAccessible::Role</h3>
<p> This enum defines a number of roles an accessible object can have.
The roles are:
<ul>
<li><tt>QAccessible::NoRole</tt>
<li><tt>QAccessible::TitleBar</tt>
<li><tt>QAccessible::MenuBar</tt>
<li><tt>QAccessible::ScrollBar</tt>
<li><tt>QAccessible::Grip</tt>
<li><tt>QAccessible::Sound</tt>
<li><tt>QAccessible::Cursor</tt>
<li><tt>QAccessible::Caret</tt>
<li><tt>QAccessible::AlertMessage</tt>
<li><tt>QAccessible::Window</tt>
<li><tt>QAccessible::Client</tt>
<li><tt>QAccessible::PopupMenu</tt>
<li><tt>QAccessible::MenuItem</tt>
<li><tt>QAccessible::ToolTip</tt>
<li><tt>QAccessible::Application</tt>
<li><tt>QAccessible::Document</tt>
<li><tt>QAccessible::Pane</tt>
<li><tt>QAccessible::Chart</tt>
<li><tt>QAccessible::Dialog</tt>
<li><tt>QAccessible::Border</tt>
<li><tt>QAccessible::Grouping</tt>
<li><tt>QAccessible::Separator</tt>
<li><tt>QAccessible::ToolBar</tt>
<li><tt>QAccessible::StatusBar</tt>
<li><tt>QAccessible::Table</tt>
<li><tt>QAccessible::ColumnHeader</tt>
<li><tt>QAccessible::RowHeader</tt>
<li><tt>QAccessible::Column</tt>
<li><tt>QAccessible::Row</tt>
<li><tt>QAccessible::Cell</tt>
<li><tt>QAccessible::Link</tt>
<li><tt>QAccessible::HelpBalloon</tt>
<li><tt>QAccessible::Character</tt>
<li><tt>QAccessible::List</tt>
<li><tt>QAccessible::ListItem</tt>
<li><tt>QAccessible::Outline</tt>
<li><tt>QAccessible::OutlineItem</tt>
<li><tt>QAccessible::PageTab</tt>
<li><tt>QAccessible::PropertyPage</tt>
<li><tt>QAccessible::Indicator</tt>
<li><tt>QAccessible::Graphic</tt>
<li><tt>QAccessible::StaticText</tt>
<li><tt>QAccessible::EditableText</tt>
<li><tt>QAccessible::PushButton</tt>
<li><tt>QAccessible::CheckBox</tt>
<li><tt>QAccessible::RadioButton</tt>
<li><tt>QAccessible::ComboBox</tt>
<li><tt>QAccessible::DropLest</tt>
<li><tt>QAccessible::ProgressBar</tt>
<li><tt>QAccessible::Dial</tt>
<li><tt>QAccessible::HotkeyField</tt>
<li><tt>QAccessible::Slider</tt>
<li><tt>QAccessible::SpinBox</tt>
<li><tt>QAccessible::Diagram</tt>
<li><tt>QAccessible::Animation</tt>
<li><tt>QAccessible::Equation</tt>
<li><tt>QAccessible::ButtonDropDown</tt>
<li><tt>QAccessible::ButtonMenu</tt>
<li><tt>QAccessible::ButtonDropGrid</tt>
<li><tt>QAccessible::Whitespace</tt>
<li><tt>QAccessible::PageTabList</tt>
<li><tt>QAccessible::Clock</tt>
</ul>
<h3 class=fn><a name="State-enum"></a>QAccessible::State</h3>
<p> This enum type defines bitflags that can be combined to indicate
the state of the accessible object. The values are:
<ul>
<li><tt>QAccessible::Normal</tt>
<li><tt>QAccessible::Unavailable</tt>
<li><tt>QAccessible::Selected</tt>
<li><tt>QAccessible::Focused</tt>
<li><tt>QAccessible::Pressed</tt>
<li><tt>QAccessible::Checked</tt>
<li><tt>QAccessible::Mixed</tt>
<li><tt>QAccessible::ReadOnly</tt>
<li><tt>QAccessible::HotTracked</tt>
<li><tt>QAccessible::Default</tt>
<li><tt>QAccessible::Expanded</tt>
<li><tt>QAccessible::Collapsed</tt>
<li><tt>QAccessible::Busy</tt>
<li><tt>QAccessible::Floating</tt>
<li><tt>QAccessible::Marqueed</tt>
<li><tt>QAccessible::Animated</tt>
<li><tt>QAccessible::Invisible</tt>
<li><tt>QAccessible::Offscreen</tt>
<li><tt>QAccessible::Sizeable</tt>
<li><tt>QAccessible::Moveable</tt>
<li><tt>QAccessible::SelfVoicing</tt>
<li><tt>QAccessible::Focusable</tt>
<li><tt>QAccessible::Selectable</tt>
<li><tt>QAccessible::Linked</tt>
<li><tt>QAccessible::Traversed</tt>
<li><tt>QAccessible::MultiSelectable</tt>
<li><tt>QAccessible::ExtSelectable</tt>
<li><tt>QAccessible::AlertLow</tt>
<li><tt>QAccessible::AlertMedium</tt>
<li><tt>QAccessible::AlertHigh</tt>
<li><tt>QAccessible::Protected</tt>
<li><tt>QAccessible::Valid</tt>
</ul>
<h3 class=fn><a name="Text-enum"></a>QAccessible::Text</h3>
<p> This enum specifies string information that an accessible object
returns.
<ul>
<li><tt>QAccessible::Name</tt> - The name of the object
<li><tt>QAccessible::Description</tt> - A short text describing the object
<li><tt>QAccessible::Value</tt> - The value of the object
<li><tt>QAccessible::Help</tt> - A longer text giving information about how
to use the object
<li><tt>QAccessible::DefaultAction</tt> - The default method to interact with the object
<li><tt>QAccessible::Accelerator</tt> - The keyboard shortcut that executes the
default action
</ul>
<hr><h2>Member Function Documentation</h2>
<h3 class=fn>bool <a name="isActive"></a>QAccessible::isActive ()<tt> [static]</tt>
</h3>
Returns TRUE if an accessibility implementation has been requested,
during the runtime of the application, otherwise returns FALSE.
<p> Use this function to prevent potentially expensive notifications via
<a href="#updateAccessibility">updateAccessibility</a>().
<p>
<h3 class=fn>QRESULT <a name="queryAccessibleInterface"></a>QAccessible::queryAccessibleInterface ( <a href="qobject.html">QObject</a> * object, <a href="qaccessibleinterface.html">QAccessibleInterface</a> ** iface )<tt> [static]</tt>
</h3>
Sets <em>iface</em> to point to the implementation of the
<a href="qaccessibleinterface.html">QAccessibleInterface</a> for <em>object</em>, and returns <tt>QS_OK</tt> if
successfull, or sets <em>iface</em> to 0 and returns <tt>QE_NOCOMPONENT</tt> if
no accessibility implementation for <em>object</em> exists.
<p> The function uses the <a href="qobject.html#className">classname</a> of <em>object</em> to find a suitable implementation. If no
implementation for the object's class is available the function
tries to find an implementation for the object's parent class.
<p> This function is called to answer an accessibility client's
request for object information. You should never need to call this
function yourself.
<h3 class=fn>void <a name="updateAccessibility"></a>QAccessible::updateAccessibility ( <a href="qobject.html">QObject</a> * object, int control, <a href="qaccessible.html#Event-enum">Event</a> reason )<tt> [static]</tt>
</h3>
<p> Notifies accessibility clients about a change in <em>object</em>'s
accessibility information.
<p> <em>reason</em> specifies the cause of the change, for example,
ValueChange when the position of a slider has been changed. <em>control</em> is the ID of the child element that has changed. When <em>control</em> is 0, the object itself has changed.
<p> Call this function whenever the state of your accessible object or
one of it's sub-elements has been changed either programmatically
(e.g. by calling <a href="qlabel.html#setText">QLabel::setText</a>()) or by user interaction.
<p> If there are no accessibility tools listening to this event, the
performance penalty for calling this function is minor, but if determining
the parameters of the call is expensive you can use <a href="#isActive">isActive</a>() to
avoid unnecessary performance penalties if no client is listening.
<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright © 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright © 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>
|
