1QAccessibleInterface(3qt) QAccessibleInterface(3qt)
2
6 QAccessibleInterface - Defines an interface that exposes information
7 about accessible objects
8
10 #include <qaccessible.h>
11 Inherits QAccessible.
13 Inherited by QAccessibleObject.
15 Public Members
17 virtual bool isValid () const = 0
18 virtual int childCount () const = 0
19 virtual QRESULT queryChild ( int control, QAccessibleInterface ** iface
20 ) const = 0
21 virtual QRESULT queryParent ( QAccessibleInterface ** iface ) const = 0
22 virtual int controlAt ( int x, int y ) const = 0
23 virtual QRect rect ( int control ) const = 0
24 virtual int navigate ( NavDirection direction, int startControl ) const
25 = 0
26 virtual QString text ( Text t, int control ) const = 0
27 virtual void setText ( Text t, int control, const QString & text ) = 0
28 virtual Role role ( int control ) const = 0
29 virtual State state ( int control ) const = 0
30 virtual QMemArray<int> selection () const = 0
31 virtual bool doDefaultAction ( int control ) = 0
32 virtual bool setFocus ( int control ) = 0
33 virtual bool setSelected ( int control, bool on, bool extend ) = 0
34 virtual void clearSelection () = 0
35
37 The QAccessibleInterface class defines an interface that exposes
38 information about accessible objects.
39 See also Miscellaneous Classes.
41
44 Returns the number of children that belong to this object. A child can
45 provide accessibility information on it's own (e.g. a child widget), or
46 be a sub-element of this accessible object.
47 All objects provide this information.
49 See also queryChild().
51
53 Removes any selection from the object.
54 See also setSelected().
56
58 Returns the ID of the child that contains the screen coordinates (x,
59 y). This function returns 0 if the point is positioned on the object
60 itself. If the tested point is outside the boundaries of the object
61 this function returns -1.
62 All visual objects provide this information.
64
66 Calling this function performs the default action of the child object
67 specified by control, or the default action of the object itself if
68 control is 0.
69
71 Returns TRUE if all the data necessary to use this interface
72 implementation is valid (e.g. all pointers are non-null), otherwise
73 returns FALSE.
74
76 ) const [pure virtual]
77 This function traverses to another object, or to a sub-element of the
78 current object. direction specifies in which direction to navigate, and
79 startControl specifies the start point of the navigation, which is
80 either 0 if the navigation starts at the object itself, or an ID of one
81 of the object's sub-elements.
82 The function returns the ID of the sub-element located in the direction
84 specified. If there is nothing in the navigated direction, this
85 function returns -1.
86 All objects support navigation.
88
90 ** iface ) const [pure virtual]
91 Sets iface to point to the implementation of the QAccessibleInterface
92 for the child specified with control. If the child doesn't provide
93 accessibility information on it's own, the value of iface is set to 0.
94 For those elements, this object is responsible for exposing the child's
95 properties.
96 All objects provide this information.
98 See also childCount() and queryParent().
100
102 const [pure virtual]
103 Sets iface to point to the implementation of the QAccessibleInterface
104 for the parent object, or to 0 if there is no such implementation or
105 object.
106 All objects provide this information.
108 See also queryChild().
110
112 Returns the location of the child specified with control in screen
113 coordinates. This function returns the location of the object itself if
114 control is 0.
115 All visual objects provide this information.
117
119 Returns the role of the object if control is 0, or the role of the
120 object's sub-element with ID control. The role of an object is usually
121 static. All accessible objects have a role.
122 See also text(), state(), and selection().
124
126 Returns the list of all the element IDs that are selected.
127 See also text(), role(), and state().
129
131 Gives the focus to the child object specified by control, or to the
132 object itself if control is 0.
133 Returns TRUE if the focus could be set; otherwise returns FALSE.
135
137 [pure virtual]
138 Sets the selection of the child object with ID control to on. If extend
139 is TRUE, all child elements between the focused item and the specified
140 child object have their selection set to on.
141 Returns TRUE if the selection could be set; otherwise returns FALSE.
143 See also setFocus() and clearSelection().
145
147 ) [pure virtual]
148 Sets the text property t of the child object control to text. If
149 control is 0, the text property of the object itself is set.
150
152 Returns the current state of the object if control is 0, or the state
153 of the object's sub-element element with ID control. All objects have a
154 state.
155 See also text(), role(), and selection().
157
159 virtual]
160 Returns a string property t of the child object specified by control,
161 or the string property of the object itself if control is 0.
162 The Name is a string used by clients to identify, find or announce an
164 accessible object for the user. All objects must have a name that is
165 unique within their container.
166 An accessible object's Description provides textual information about
168 an object's visual appearance. The description is primarily used to
169 provide greater context for low-vision or blind users, but is also used
170 for context searching or other applications. Not all objects have a
171 description. An "OK" button would not need a description, but a
172 toolbutton that shows a picture of a smiley would.
173 The Value of an accessible object represents visual information
175 contained by the object, e.g. the text in a line edit. Usually, the
176 value can be modified by the user. Not all objects have a value, e.g.
177 static text labels don't, and some objects have a state that already is
178 the value, e.g. toggle buttons.
179 The Help text provides information about the function and usage of an
181 accessible object. Not all objects provide this information.
182 An accessible object's DefaultAction describes the object's primary
184 method of manipulation, and should be a verb or a short phrase, e.g.
185 "Press" for a button.
186 The accelerator is a keyboard shortcut that activates the default
188 action of the object. A keyboard shortcut is the underlined character
189 in the text of a menu, menu item or control, and is either the
190 character itself, or a combination of this character and a modifier key
191 like ALT, CTRL or SHIFT. Command controls like tool buttons also have
192 shortcut keys and usually display them in their tooltip.
193 See also role(), state(), and selection().
195
198 http://doc.trolltech.com/qaccessibleinterface.html
199 http://www.trolltech.com/faq/tech.html
200
202 Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
203 license file included in the distribution for a complete license
204 statement.
205
207 Generated automatically from the source code.
208
210 If you find a bug in Qt, please report it as described in
211 http://doc.trolltech.com/bughowto.html. Good bug reports help us to
212 help you. Thank you.
213 The definitive Qt documentation is provided in HTML format; it is
215 located at $QTDIR/doc/html and can be read using Qt Assistant or with a
216 web browser. This man page is provided as a convenience for those users
217 who prefer man pages, although this format is not officially supported
218 by Trolltech.
219 If you find errors in this manual page, please report them to qt-
221 bugs@trolltech.com. Please include the name of the manual page
222 (qaccessibleinterface.3qt) and the Qt version (3.3.8).
223Trolltech AS 2 February 2007 QAccessibleInterface(3qt)