source: trunk/doc/html/qaccessible.html@ 190

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

reference documentation added
File size: 15.6 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/src/kernel/qaccessible.cpp:46 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QAccessible Class</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 Class Reference</h1>
33
34<p>The QAccessible class provides enums and static functions
35relating to accessibility.
36<a href="#details">More...</a>
37<p><tt>#include &lt;<a href="qaccessible-h.html">qaccessible.h</a>&gt;</tt>
38<p>Inherited by <a href="qaccessibleinterface.html">QAccessibleInterface</a>.
39<p><a href="qaccessible-members.html">List of all member functions.</a>
40<h2>Public Members</h2>
41<ul>
42<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>
43<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>
44<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>
45<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>
46<li class=fn>enum <a href="#Text-enum"><b>Text</b></a> { Name = 0, Description, Value, Help, Accelerator, DefaultAction }</li>
47</ul>
48<h2>Static Public Members</h2>
49<ul>
50<li class=fn>QRESULT <a href="#queryAccessibleInterface"><b>queryAccessibleInterface</b></a> ( QObject&nbsp;*&nbsp;object, QAccessibleInterface&nbsp;**&nbsp;iface )</li>
51<li class=fn>void <a href="#updateAccessibility"><b>updateAccessibility</b></a> ( QObject&nbsp;*&nbsp;object, int&nbsp;control, Event&nbsp;reason )</li>
52<li class=fn>bool <a href="#isActive"><b>isActive</b></a> ()</li>
53</ul>
54<hr><a name="details"></a><h2>Detailed Description</h2>
55
56
57The QAccessible class provides enums and static functions
58relating to accessibility.
59<p>
60<p> Accessibility clients use implementations of the
61<a href="qaccessibleinterface.html">QAccessibleInterface</a> to read the information an accessible object
62exposes, or to call functions to manipulate the accessible object.
63<p>
64<p> See the <a href="plugins-howto.html">plugin documentation</a> for
65more details about how to redistribute Qt plugins.
66<p>See also <a href="misc.html">Miscellaneous Classes</a>.
67
68<hr><h2>Member Type Documentation</h2>
69<h3 class=fn><a name="Event-enum"></a>QAccessible::Event</h3>
70
71<p> This enum type defines event types when the state of the
72accessible object has changed. The event types are:
73<ul>
74<li><tt>QAccessible::SoundPlayed</tt>
75<li><tt>QAccessible::Alert</tt>
76<li><tt>QAccessible::ForegroundChanged</tt>
77<li><tt>QAccessible::MenuStart</tt>
78<li><tt>QAccessible::MenuEnd</tt>
79<li><tt>QAccessible::PopupMenuStart</tt>
80<li><tt>QAccessible::PopupMenuEnd</tt>
81<li><tt>QAccessible::ContextHelpStart</tt>
82<li><tt>QAccessible::ContextHelpEnd</tt>
83<li><tt>QAccessible::DragDropStart</tt>
84<li><tt>QAccessible::DragDropEnd</tt>
85<li><tt>QAccessible::DialogStart</tt>
86<li><tt>QAccessible::DialogEnd</tt>
87<li><tt>QAccessible::ScrollingStart</tt>
88<li><tt>QAccessible::ScrollingEnd</tt>
89<li><tt>QAccessible::ObjectCreated</tt>
90<li><tt>QAccessible::ObjectDestroyed</tt>
91<li><tt>QAccessible::ObjectShow</tt>
92<li><tt>QAccessible::ObjectHide</tt>
93<li><tt>QAccessible::ObjectReorder</tt>
94<li><tt>QAccessible::Focus</tt>
95<li><tt>QAccessible::Selection</tt>
96<li><tt>QAccessible::SelectionAdd</tt>
97<li><tt>QAccessible::SelectionRemove</tt>
98<li><tt>QAccessible::SelectionWithin</tt>
99<li><tt>QAccessible::StateChanged</tt>
100<li><tt>QAccessible::LocationChanged</tt>
101<li><tt>QAccessible::NameChanged</tt>
102<li><tt>QAccessible::DescriptionChanged</tt>
103<li><tt>QAccessible::ValueChanged</tt>
104<li><tt>QAccessible::ParentChanged</tt>
105<li><tt>QAccessible::HelpChanged</tt>
106<li><tt>QAccessible::DefaultActionChanged</tt>
107<li><tt>QAccessible::AcceleratorChanged</tt>
108<li><tt>QAccessible::MenuCommand</tt>
109</ul>
110<h3 class=fn><a name="NavDirection-enum"></a>QAccessible::NavDirection</h3>
111
112<p> This enum specifies which item to move to when navigating.
113<ul>
114<li><tt>QAccessible::NavUp</tt> - sibling above
115<li><tt>QAccessible::NavDown</tt> - sibling below
116<li><tt>QAccessible::NavLeft</tt> - left sibling
117<li><tt>QAccessible::NavRight</tt> - right sibling
118<li><tt>QAccessible::NavNext</tt> - next sibling
119<li><tt>QAccessible::NavPrevious</tt> - previous sibling
120<li><tt>QAccessible::NavFirstChild</tt> - first child
121<li><tt>QAccessible::NavLastChild</tt> - last child
122<li><tt>QAccessible::NavFocusChild</tt> - child with focus
123</ul>
124<h3 class=fn><a name="Role-enum"></a>QAccessible::Role</h3>
125
126<p> This enum defines a number of roles an accessible object can have.
127The roles are:
128<ul>
129<li><tt>QAccessible::NoRole</tt>
130<li><tt>QAccessible::TitleBar</tt>
131<li><tt>QAccessible::MenuBar</tt>
132<li><tt>QAccessible::ScrollBar</tt>
133<li><tt>QAccessible::Grip</tt>
134<li><tt>QAccessible::Sound</tt>
135<li><tt>QAccessible::Cursor</tt>
136<li><tt>QAccessible::Caret</tt>
137<li><tt>QAccessible::AlertMessage</tt>
138<li><tt>QAccessible::Window</tt>
139<li><tt>QAccessible::Client</tt>
140<li><tt>QAccessible::PopupMenu</tt>
141<li><tt>QAccessible::MenuItem</tt>
142<li><tt>QAccessible::ToolTip</tt>
143<li><tt>QAccessible::Application</tt>
144<li><tt>QAccessible::Document</tt>
145<li><tt>QAccessible::Pane</tt>
146<li><tt>QAccessible::Chart</tt>
147<li><tt>QAccessible::Dialog</tt>
148<li><tt>QAccessible::Border</tt>
149<li><tt>QAccessible::Grouping</tt>
150<li><tt>QAccessible::Separator</tt>
151<li><tt>QAccessible::ToolBar</tt>
152<li><tt>QAccessible::StatusBar</tt>
153<li><tt>QAccessible::Table</tt>
154<li><tt>QAccessible::ColumnHeader</tt>
155<li><tt>QAccessible::RowHeader</tt>
156<li><tt>QAccessible::Column</tt>
157<li><tt>QAccessible::Row</tt>
158<li><tt>QAccessible::Cell</tt>
159<li><tt>QAccessible::Link</tt>
160<li><tt>QAccessible::HelpBalloon</tt>
161<li><tt>QAccessible::Character</tt>
162<li><tt>QAccessible::List</tt>
163<li><tt>QAccessible::ListItem</tt>
164<li><tt>QAccessible::Outline</tt>
165<li><tt>QAccessible::OutlineItem</tt>
166<li><tt>QAccessible::PageTab</tt>
167<li><tt>QAccessible::PropertyPage</tt>
168<li><tt>QAccessible::Indicator</tt>
169<li><tt>QAccessible::Graphic</tt>
170<li><tt>QAccessible::StaticText</tt>
171<li><tt>QAccessible::EditableText</tt>
172<li><tt>QAccessible::PushButton</tt>
173<li><tt>QAccessible::CheckBox</tt>
174<li><tt>QAccessible::RadioButton</tt>
175<li><tt>QAccessible::ComboBox</tt>
176<li><tt>QAccessible::DropLest</tt>
177<li><tt>QAccessible::ProgressBar</tt>
178<li><tt>QAccessible::Dial</tt>
179<li><tt>QAccessible::HotkeyField</tt>
180<li><tt>QAccessible::Slider</tt>
181<li><tt>QAccessible::SpinBox</tt>
182<li><tt>QAccessible::Diagram</tt>
183<li><tt>QAccessible::Animation</tt>
184<li><tt>QAccessible::Equation</tt>
185<li><tt>QAccessible::ButtonDropDown</tt>
186<li><tt>QAccessible::ButtonMenu</tt>
187<li><tt>QAccessible::ButtonDropGrid</tt>
188<li><tt>QAccessible::Whitespace</tt>
189<li><tt>QAccessible::PageTabList</tt>
190<li><tt>QAccessible::Clock</tt>
191</ul>
192<h3 class=fn><a name="State-enum"></a>QAccessible::State</h3>
193
194<p> This enum type defines bitflags that can be combined to indicate
195the state of the accessible object. The values are:
196<ul>
197<li><tt>QAccessible::Normal</tt>
198<li><tt>QAccessible::Unavailable</tt>
199<li><tt>QAccessible::Selected</tt>
200<li><tt>QAccessible::Focused</tt>
201<li><tt>QAccessible::Pressed</tt>
202<li><tt>QAccessible::Checked</tt>
203<li><tt>QAccessible::Mixed</tt>
204<li><tt>QAccessible::ReadOnly</tt>
205<li><tt>QAccessible::HotTracked</tt>
206<li><tt>QAccessible::Default</tt>
207<li><tt>QAccessible::Expanded</tt>
208<li><tt>QAccessible::Collapsed</tt>
209<li><tt>QAccessible::Busy</tt>
210<li><tt>QAccessible::Floating</tt>
211<li><tt>QAccessible::Marqueed</tt>
212<li><tt>QAccessible::Animated</tt>
213<li><tt>QAccessible::Invisible</tt>
214<li><tt>QAccessible::Offscreen</tt>
215<li><tt>QAccessible::Sizeable</tt>
216<li><tt>QAccessible::Moveable</tt>
217<li><tt>QAccessible::SelfVoicing</tt>
218<li><tt>QAccessible::Focusable</tt>
219<li><tt>QAccessible::Selectable</tt>
220<li><tt>QAccessible::Linked</tt>
221<li><tt>QAccessible::Traversed</tt>
222<li><tt>QAccessible::MultiSelectable</tt>
223<li><tt>QAccessible::ExtSelectable</tt>
224<li><tt>QAccessible::AlertLow</tt>
225<li><tt>QAccessible::AlertMedium</tt>
226<li><tt>QAccessible::AlertHigh</tt>
227<li><tt>QAccessible::Protected</tt>
228<li><tt>QAccessible::Valid</tt>
229</ul>
230<h3 class=fn><a name="Text-enum"></a>QAccessible::Text</h3>
231
232<p> This enum specifies string information that an accessible object
233returns.
234<ul>
235<li><tt>QAccessible::Name</tt> - The name of the object
236<li><tt>QAccessible::Description</tt> - A short text describing the object
237<li><tt>QAccessible::Value</tt> - The value of the object
238<li><tt>QAccessible::Help</tt> - A longer text giving information about how
239to use the object
240<li><tt>QAccessible::DefaultAction</tt> - The default method to interact with the object
241<li><tt>QAccessible::Accelerator</tt> - The keyboard shortcut that executes the
242default action
243</ul>
244<hr><h2>Member Function Documentation</h2>
245<h3 class=fn>bool <a name="isActive"></a>QAccessible::isActive ()<tt> [static]</tt>
246</h3>
247Returns TRUE if an accessibility implementation has been requested,
248during the runtime of the application, otherwise returns FALSE.
249<p> Use this function to prevent potentially expensive notifications via
250<a href="#updateAccessibility">updateAccessibility</a>().
251<p>
252
253<h3 class=fn>QRESULT <a name="queryAccessibleInterface"></a>QAccessible::queryAccessibleInterface ( <a href="qobject.html">QObject</a>&nbsp;*&nbsp;object, <a href="qaccessibleinterface.html">QAccessibleInterface</a>&nbsp;**&nbsp;iface )<tt> [static]</tt>
254</h3>
255Sets <em>iface</em> to point to the implementation of the
256<a href="qaccessibleinterface.html">QAccessibleInterface</a> for <em>object</em>, and returns <tt>QS_OK</tt> if
257successfull, or sets <em>iface</em> to 0 and returns <tt>QE_NOCOMPONENT</tt> if
258no accessibility implementation for <em>object</em> exists.
259<p> The function uses the <a href="qobject.html#className">classname</a> of <em>object</em> to find a suitable implementation. If no
260implementation for the object's class is available the function
261tries to find an implementation for the object's parent class.
262<p> This function is called to answer an accessibility client's
263request for object information. You should never need to call this
264function yourself.
265
266<h3 class=fn>void <a name="updateAccessibility"></a>QAccessible::updateAccessibility ( <a href="qobject.html">QObject</a>&nbsp;*&nbsp;object, int&nbsp;control, <a href="qaccessible.html#Event-enum">Event</a>&nbsp;reason )<tt> [static]</tt>
267</h3>
268
269<p> Notifies accessibility clients about a change in <em>object</em>'s
270accessibility information.
271<p> <em>reason</em> specifies the cause of the change, for example,
272ValueChange 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.
273<p> Call this function whenever the state of your accessible object or
274one of it's sub-elements has been changed either programmatically
275(e.g. by calling <a href="qlabel.html#setText">QLabel::setText</a>()) or by user interaction.
276<p> If there are no accessibility tools listening to this event, the
277performance penalty for calling this function is minor, but if determining
278the parameters of the call is expensive you can use <a href="#isActive">isActive</a>() to
279avoid unnecessary performance penalties if no client is listening.
280
281<!-- eof -->
282<hr><p>
283This file is part of the <a href="index.html">Qt toolkit</a>.
284Copyright &copy; 1995-2007
285<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
286<table width=100% cellspacing=0 border=0><tr>
287<td>Copyright &copy; 2007
288<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
289<td align=right><div align=right>Qt 3.3.8</div>
290</table></div></address></body>
291</html>
Note: See TracBrowser for help on using the repository browser.