1QAccessible(3qt) QAccessible(3qt)
2
6 QAccessible - Enums and static functions relating to accessibility
7
9 #include <qaccessible.h>
10 Inherited by QAccessibleInterface.
12 Public Members
14 enum Event { SoundPlayed = 0x0001, Alert = 0x0002, ForegroundChanged =
15 0x0003, MenuStart = 0x0004, MenuEnd = 0x0005, PopupMenuStart =
16 0x0006, PopupMenuEnd = 0x0007, ContextHelpStart = 0x000C,
17 ContextHelpEnd = 0x000D, DragDropStart = 0x000E, DragDropEnd =
18 0x000F, DialogStart = 0x0010, DialogEnd = 0x0011, ScrollingStart =
19 0x0012, ScrollingEnd = 0x0013, MenuCommand = 0x0018, ObjectCreated
20 = 0x8000, ObjectDestroyed = 0x8001, ObjectShow = 0x8002, ObjectHide
21 = 0x8003, ObjectReorder = 0x8004, Focus = 0x8005, Selection =
22 0x8006, SelectionAdd = 0x8007, SelectionRemove = 0x8008,
23 SelectionWithin = 0x8009, StateChanged = 0x800A, LocationChanged =
24 0x800B, NameChanged = 0x800C, DescriptionChanged = 0x800D,
25 ValueChanged = 0x800E, ParentChanged = 0x800F, HelpChanged =
26 0x80A0, DefaultActionChanged = 0x80B0, AcceleratorChanged = 0x80C0
27 }
28 enum State { Normal = 0x00000000, Unavailable = 0x00000001, Selected =
29 0x00000002, Focused = 0x00000004, Pressed = 0x00000008, Checked =
30 0x00000010, Mixed = 0x00000020, ReadOnly = 0x00000040, HotTracked =
31 0x00000080, Default = 0x00000100, Expanded = 0x00000200, Collapsed
32 = 0x00000400, Busy = 0x00000800, Floating = 0x00001000, Marqueed =
33 0x00002000, Animated = 0x00004000, Invisible = 0x00008000,
34 Offscreen = 0x00010000, Sizeable = 0x00020000, Moveable =
35 0x00040000, SelfVoicing = 0x00080000, Focusable = 0x00100000,
36 Selectable = 0x00200000, Linked = 0x00400000, Traversed =
37 0x00800000, MultiSelectable = 0x01000000, ExtSelectable =
38 0x02000000, AlertLow = 0x04000000, AlertMedium = 0x08000000,
39 AlertHigh = 0x10000000, Protected = 0x20000000, Valid = 0x3fffffff
40 }
41 enum Role { NoRole = 0x00000000, TitleBar = 0x00000001, MenuBar =
42 0x00000002, ScrollBar = 0x00000003, Grip = 0x00000004, Sound =
43 0x00000005, Cursor = 0x00000006, Caret = 0x00000007, AlertMessage =
44 0x00000008, Window = 0x00000009, Client = 0x0000000A, PopupMenu =
45 0x0000000B, MenuItem = 0x0000000C, ToolTip = 0x0000000D,
46 Application = 0x0000000E, Document = 0x0000000F, Pane = 0x00000010,
47 Chart = 0x00000011, Dialog = 0x00000012, Border = 0x00000013,
48 Grouping = 0x00000014, Separator = 0x00000015, ToolBar =
49 0x00000016, StatusBar = 0x00000017, Table = 0x00000018,
50 ColumnHeader = 0x00000019, RowHeader = 0x0000001A, Column =
51 0x0000001B, Row = 0x0000001C, Cell = 0x0000001D, Link = 0x0000001E,
52 HelpBalloon = 0x0000001F, Character = 0x00000020, List =
53 0x00000021, ListItem = 0x00000022, Outline = 0x00000023,
54 OutlineItem = 0x00000024, PageTab = 0x00000025, PropertyPage =
55 0x00000026, Indicator = 0x00000027, Graphic = 0x00000028,
56 StaticText = 0x00000029, EditableText = 0x0000002A, PushButton =
57 0x0000002B, CheckBox = 0x0000002C, RadioButton = 0x0000002D,
58 ComboBox = 0x0000002E, DropLest = 0x0000002F, ProgressBar =
59 0x00000030, Dial = 0x00000031, HotkeyField = 0x00000032, Slider =
60 0x00000033, SpinBox = 0x00000034, Diagram = 0x00000035, Animation =
61 0x00000036, Equation = 0x00000037, ButtonDropDown = 0x00000038,
62 ButtonMenu = 0x00000039, ButtonDropGrid = 0x0000003A, Whitespace =
63 0x0000003B, PageTabList = 0x0000003C, Clock = 0x0000003D }
64 enum NavDirection { NavUp = 0x00000001, NavDown = 0x00000002, NavLeft =
65 0x00000003, NavRight = 0x00000004, NavNext = 0x00000005,
66 NavPrevious = 0x00000006, NavFirstChild = 0x00000007, NavLastChild
67 = 0x00000008, NavFocusChild = 0x00000009 }
68 enum Text { Name = 0, Description, Value, Help, Accelerator,
69 DefaultAction }
70 Static Public Members
72 QRESULT queryAccessibleInterface ( QObject * object,
73 QAccessibleInterface ** iface )
74 void updateAccessibility ( QObject * object, int control, Event reason
75 )
76 bool isActive ()
77
79 The QAccessible class provides enums and static functions relating to
80 accessibility.
81 Accessibility clients use implementations of the QAccessibleInterface
83 to read the information an accessible object exposes, or to call
84 functions to manipulate the accessible object.
85 See the plugin documentation for more details about how to redistribute
87 Qt plugins.
88 See also Miscellaneous Classes.
90 Member Type Documentation
93 This enum type defines event types when the state of the accessible
94 object has changed. The event types are:
95 QAccessible::SoundPlayed
97 QAccessible::Alert
99 QAccessible::ForegroundChanged
101 QAccessible::MenuStart
103 QAccessible::MenuEnd
105 QAccessible::PopupMenuStart
107 QAccessible::PopupMenuEnd
109 QAccessible::ContextHelpStart
111 QAccessible::ContextHelpEnd
113 QAccessible::DragDropStart
115 QAccessible::DragDropEnd
117 QAccessible::DialogStart
119 QAccessible::DialogEnd
121 QAccessible::ScrollingStart
123 QAccessible::ScrollingEnd
125 QAccessible::ObjectCreated
127 QAccessible::ObjectDestroyed
129 QAccessible::ObjectShow
131 QAccessible::ObjectHide
133 QAccessible::ObjectReorder
135 QAccessible::Focus
137 QAccessible::Selection
139 QAccessible::SelectionAdd
141 QAccessible::SelectionRemove
143 QAccessible::SelectionWithin
145 QAccessible::StateChanged
147 QAccessible::LocationChanged
149 QAccessible::NameChanged
151 QAccessible::DescriptionChanged
153 QAccessible::ValueChanged
155 QAccessible::ParentChanged
157 QAccessible::HelpChanged
159 QAccessible::DefaultActionChanged
161 QAccessible::AcceleratorChanged
163 QAccessible::MenuCommand
165
167 This enum specifies which item to move to when navigating.
168 QAccessible::NavUp - sibling above
170 QAccessible::NavDown - sibling below
172 QAccessible::NavLeft - left sibling
174 QAccessible::NavRight - right sibling
176 QAccessible::NavNext - next sibling
178 QAccessible::NavPrevious - previous sibling
180 QAccessible::NavFirstChild - first child
182 QAccessible::NavLastChild - last child
184 QAccessible::NavFocusChild - child with focus
186
188 This enum defines a number of roles an accessible object can have. The
189 roles are:
190 QAccessible::NoRole
192 QAccessible::TitleBar
194 QAccessible::MenuBar
196 QAccessible::ScrollBar
198 QAccessible::Grip
200 QAccessible::Sound
202 QAccessible::Cursor
204 QAccessible::Caret
206 QAccessible::AlertMessage
208 QAccessible::Window
210 QAccessible::Client
212 QAccessible::PopupMenu
214 QAccessible::MenuItem
216 QAccessible::ToolTip
218 QAccessible::Application
220 QAccessible::Document
222 QAccessible::Pane
224 QAccessible::Chart
226 QAccessible::Dialog
228 QAccessible::Border
230 QAccessible::Grouping
232 QAccessible::Separator
234 QAccessible::ToolBar
236 QAccessible::StatusBar
238 QAccessible::Table
240 QAccessible::ColumnHeader
242 QAccessible::RowHeader
244 QAccessible::Column
246 QAccessible::Row
248 QAccessible::Cell
250 QAccessible::Link
252 QAccessible::HelpBalloon
254 QAccessible::Character
256 QAccessible::List
258 QAccessible::ListItem
260 QAccessible::Outline
262 QAccessible::OutlineItem
264 QAccessible::PageTab
266 QAccessible::PropertyPage
268 QAccessible::Indicator
270 QAccessible::Graphic
272 QAccessible::StaticText
274 QAccessible::EditableText
276 QAccessible::PushButton
278 QAccessible::CheckBox
280 QAccessible::RadioButton
282 QAccessible::ComboBox
284 QAccessible::DropLest
286 QAccessible::ProgressBar
288 QAccessible::Dial
290 QAccessible::HotkeyField
292 QAccessible::Slider
294 QAccessible::SpinBox
296 QAccessible::Diagram
298 QAccessible::Animation
300 QAccessible::Equation
302 QAccessible::ButtonDropDown
304 QAccessible::ButtonMenu
306 QAccessible::ButtonDropGrid
308 QAccessible::Whitespace
310 QAccessible::PageTabList
312 QAccessible::Clock
314
316 This enum type defines bitflags that can be combined to indicate the
317 state of the accessible object. The values are:
318 QAccessible::Normal
320 QAccessible::Unavailable
322 QAccessible::Selected
324 QAccessible::Focused
326 QAccessible::Pressed
328 QAccessible::Checked
330 QAccessible::Mixed
332 QAccessible::ReadOnly
334 QAccessible::HotTracked
336 QAccessible::Default
338 QAccessible::Expanded
340 QAccessible::Collapsed
342 QAccessible::Busy
344 QAccessible::Floating
346 QAccessible::Marqueed
348 QAccessible::Animated
350 QAccessible::Invisible
352 QAccessible::Offscreen
354 QAccessible::Sizeable
356 QAccessible::Moveable
358 QAccessible::SelfVoicing
360 QAccessible::Focusable
362 QAccessible::Selectable
364 QAccessible::Linked
366 QAccessible::Traversed
368 QAccessible::MultiSelectable
370 QAccessible::ExtSelectable
372 QAccessible::AlertLow
374 QAccessible::AlertMedium
376 QAccessible::AlertHigh
378 QAccessible::Protected
380 QAccessible::Valid
382
384 This enum specifies string information that an accessible object
385 returns.
386 QAccessible::Name - The name of the object
388 QAccessible::Description - A short text describing the object
390 QAccessible::Value - The value of the object
392 QAccessible::Help - A longer text giving information about how to use
394 the object
395 QAccessible::DefaultAction - The default method to interact with the
397 object
398 QAccessible::Accelerator - The keyboard shortcut that executes the
400 default action
401
404 Returns TRUE if an accessibility implementation has been requested,
405 during the runtime of the application, otherwise returns FALSE.
406 Use this function to prevent potentially expensive notifications via
408 updateAccessibility().
409
411 QAccessibleInterface ** iface ) [static]
412 Sets iface to point to the implementation of the QAccessibleInterface
413 for object, and returns QS_OK if successfull, or sets iface to 0 and
414 returns QE_NOCOMPONENT if no accessibility implementation for object
415 exists.
416 The function uses the classname of object to find a suitable
418 implementation. If no implementation for the object's class is
419 available the function tries to find an implementation for the object's
420 parent class.
421 This function is called to answer an accessibility client's request for
423 object information. You should never need to call this function
424 yourself.
425
427 reason ) [static]
428 Notifies accessibility clients about a change in object's accessibility
429 information.
430 reason specifies the cause of the change, for example, ValueChange when
432 the position of a slider has been changed. control is the ID of the
433 child element that has changed. When control is 0, the object itself
434 has changed.
435 Call this function whenever the state of your accessible object or one
437 of it's sub-elements has been changed either programmatically (e.g. by
438 calling QLabel::setText()) or by user interaction.
439 If there are no accessibility tools listening to this event, the
441 performance penalty for calling this function is minor, but if
442 determining the parameters of the call is expensive you can use
443 isActive() to avoid unnecessary performance penalties if no client is
444 listening.
445
448 http://doc.trolltech.com/qaccessible.html
449 http://www.trolltech.com/faq/tech.html
450
452 Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
453 license file included in the distribution for a complete license
454 statement.
455
457 Generated automatically from the source code.
458
460 If you find a bug in Qt, please report it as described in
461 http://doc.trolltech.com/bughowto.html. Good bug reports help us to
462 help you. Thank you.
463 The definitive Qt documentation is provided in HTML format; it is
465 located at $QTDIR/doc/html and can be read using Qt Assistant or with a
466 web browser. This man page is provided as a convenience for those users
467 who prefer man pages, although this format is not officially supported
468 by Trolltech.
469 If you find errors in this manual page, please report them to qt-
471 bugs@trolltech.com. Please include the name of the manual page
472 (qaccessible.3qt) and the Qt version (3.3.8).
473Trolltech AS 2 February 2007 QAccessible(3qt)