| 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:421 -->
|
|---|
| 3 | <html>
|
|---|
| 4 | <head>
|
|---|
| 5 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|---|
| 6 | <title>QAccessibleInterface Class</title>
|
|---|
| 7 | <style type="text/css"><!--
|
|---|
| 8 | fn { margin-left: 1cm; text-indent: -1cm; }
|
|---|
| 9 | a:link { color: #004faf; text-decoration: none }
|
|---|
| 10 | a:visited { color: #672967; text-decoration: none }
|
|---|
| 11 | body { 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 Classes</font></a>
|
|---|
| 23 | | <a href="mainclasses.html">
|
|---|
| 24 | <font color="#004faf">Main 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 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>QAccessibleInterface Class Reference</h1>
|
|---|
| 33 |
|
|---|
| 34 | <p>The QAccessibleInterface class defines an interface that exposes information about accessible objects.
|
|---|
| 35 | <a href="#details">More...</a>
|
|---|
| 36 | <p><tt>#include <<a href="qaccessible-h.html">qaccessible.h</a>></tt>
|
|---|
| 37 | <p>Inherits <a href="qaccessible.html">QAccessible</a>.
|
|---|
| 38 | <p>Inherited by <a href="qaccessibleobject.html">QAccessibleObject</a>.
|
|---|
| 39 | <p><a href="qaccessibleinterface-members.html">List of all member functions.</a>
|
|---|
| 40 | <h2>Public Members</h2>
|
|---|
| 41 | <ul>
|
|---|
| 42 | <li class=fn>virtual bool <a href="#isValid"><b>isValid</b></a> () const = 0</li>
|
|---|
| 43 | <li class=fn>virtual int <a href="#childCount"><b>childCount</b></a> () const = 0</li>
|
|---|
| 44 | <li class=fn>virtual QRESULT <a href="#queryChild"><b>queryChild</b></a> ( int control, QAccessibleInterface ** iface ) const = 0</li>
|
|---|
| 45 | <li class=fn>virtual QRESULT <a href="#queryParent"><b>queryParent</b></a> ( QAccessibleInterface ** iface ) const = 0</li>
|
|---|
| 46 | <li class=fn>virtual int <a href="#controlAt"><b>controlAt</b></a> ( int x, int y ) const = 0</li>
|
|---|
| 47 | <li class=fn>virtual QRect <a href="#rect"><b>rect</b></a> ( int control ) const = 0</li>
|
|---|
| 48 | <li class=fn>virtual int <a href="#navigate"><b>navigate</b></a> ( NavDirection direction, int startControl ) const = 0</li>
|
|---|
| 49 | <li class=fn>virtual QString <a href="#text"><b>text</b></a> ( Text t, int control ) const = 0</li>
|
|---|
| 50 | <li class=fn>virtual void <a href="#setText"><b>setText</b></a> ( Text t, int control, const QString & text ) = 0</li>
|
|---|
| 51 | <li class=fn>virtual Role <a href="#role"><b>role</b></a> ( int control ) const = 0</li>
|
|---|
| 52 | <li class=fn>virtual State <a href="#state"><b>state</b></a> ( int control ) const = 0</li>
|
|---|
| 53 | <li class=fn>virtual QMemArray<int> <a href="#selection"><b>selection</b></a> () const = 0</li>
|
|---|
| 54 | <li class=fn>virtual bool <a href="#doDefaultAction"><b>doDefaultAction</b></a> ( int control ) = 0</li>
|
|---|
| 55 | <li class=fn>virtual bool <a href="#setFocus"><b>setFocus</b></a> ( int control ) = 0</li>
|
|---|
| 56 | <li class=fn>virtual bool <a href="#setSelected"><b>setSelected</b></a> ( int control, bool on, bool extend ) = 0</li>
|
|---|
| 57 | <li class=fn>virtual void <a href="#clearSelection"><b>clearSelection</b></a> () = 0</li>
|
|---|
| 58 | </ul>
|
|---|
| 59 | <hr><a name="details"></a><h2>Detailed Description</h2>
|
|---|
| 60 |
|
|---|
| 61 |
|
|---|
| 62 | The QAccessibleInterface class defines an interface that exposes information about accessible objects.
|
|---|
| 63 | <p>
|
|---|
| 64 | <p>See also <a href="misc.html">Miscellaneous Classes</a>.
|
|---|
| 65 |
|
|---|
| 66 | <hr><h2>Member Function Documentation</h2>
|
|---|
| 67 | <h3 class=fn>int <a name="childCount"></a>QAccessibleInterface::childCount () const<tt> [pure virtual]</tt>
|
|---|
| 68 | </h3>
|
|---|
| 69 |
|
|---|
| 70 | <p> Returns the number of children that belong to this object. A child
|
|---|
| 71 | can provide accessibility information on it's own (e.g. a child
|
|---|
| 72 | widget), or be a sub-element of this accessible object.
|
|---|
| 73 | <p> All objects provide this information.
|
|---|
| 74 | <p> <p>See also <a href="#queryChild">queryChild</a>().
|
|---|
| 75 |
|
|---|
| 76 | <h3 class=fn>void <a name="clearSelection"></a>QAccessibleInterface::clearSelection ()<tt> [pure virtual]</tt>
|
|---|
| 77 | </h3>
|
|---|
| 78 |
|
|---|
| 79 | <p> Removes any selection from the object.
|
|---|
| 80 | <p> <p>See also <a href="#setSelected">setSelected</a>().
|
|---|
| 81 |
|
|---|
| 82 | <h3 class=fn>int <a name="controlAt"></a>QAccessibleInterface::controlAt ( int x, int y ) const<tt> [pure virtual]</tt>
|
|---|
| 83 | </h3>
|
|---|
| 84 |
|
|---|
| 85 | <p> Returns the ID of the child that contains the screen coordinates
|
|---|
| 86 | (<em>x</em>, <em>y</em>). This function returns 0 if the point is positioned
|
|---|
| 87 | on the object itself. If the tested point is outside the
|
|---|
| 88 | boundaries of the object this function returns -1.
|
|---|
| 89 | <p> All visual objects provide this information.
|
|---|
| 90 |
|
|---|
| 91 | <h3 class=fn>bool <a name="doDefaultAction"></a>QAccessibleInterface::doDefaultAction ( int control )<tt> [pure virtual]</tt>
|
|---|
| 92 | </h3>
|
|---|
| 93 |
|
|---|
| 94 | <p> Calling this function performs the default action of the child
|
|---|
| 95 | object specified by <em>control</em>, or the default action of the
|
|---|
| 96 | object itself if <em>control</em> is 0.
|
|---|
| 97 |
|
|---|
| 98 | <h3 class=fn>bool <a name="isValid"></a>QAccessibleInterface::isValid () const<tt> [pure virtual]</tt>
|
|---|
| 99 | </h3>
|
|---|
| 100 |
|
|---|
| 101 | <p> Returns TRUE if all the data necessary to use this interface
|
|---|
| 102 | implementation is valid (e.g. all pointers are non-null),
|
|---|
| 103 | otherwise returns FALSE.
|
|---|
| 104 |
|
|---|
| 105 | <h3 class=fn>int <a name="navigate"></a>QAccessibleInterface::navigate ( <a href="qaccessible.html#NavDirection-enum">NavDirection</a> direction, int startControl ) const<tt> [pure virtual]</tt>
|
|---|
| 106 | </h3>
|
|---|
| 107 |
|
|---|
| 108 | <p> This function traverses to another object, or to a sub-element of
|
|---|
| 109 | the current object. <em>direction</em> specifies in which direction to
|
|---|
| 110 | navigate, and <em>startControl</em> specifies the start point of the
|
|---|
| 111 | navigation, which is either 0 if the navigation starts at the
|
|---|
| 112 | object itself, or an ID of one of the object's sub-elements.
|
|---|
| 113 | <p> The function returns the ID of the sub-element located in the <em>direction</em> specified. If there is nothing in the navigated <em>direction</em>, this function returns -1.
|
|---|
| 114 | <p> All objects support navigation.
|
|---|
| 115 |
|
|---|
| 116 | <h3 class=fn>QRESULT <a name="queryChild"></a>QAccessibleInterface::queryChild ( int control, <a href="qaccessibleinterface.html">QAccessibleInterface</a> ** iface ) const<tt> [pure virtual]</tt>
|
|---|
| 117 | </h3>
|
|---|
| 118 |
|
|---|
| 119 | <p> Sets <em>iface</em> to point to the implementation of the
|
|---|
| 120 | QAccessibleInterface for the child specified with <em>control</em>. If
|
|---|
| 121 | the child doesn't provide accessibility information on it's own,
|
|---|
| 122 | the value of <em>iface</em> is set to 0. For those elements, this
|
|---|
| 123 | object is responsible for exposing the child's properties.
|
|---|
| 124 | <p> All objects provide this information.
|
|---|
| 125 | <p> <p>See also <a href="#childCount">childCount</a>() and <a href="#queryParent">queryParent</a>().
|
|---|
| 126 |
|
|---|
| 127 | <h3 class=fn>QRESULT <a name="queryParent"></a>QAccessibleInterface::queryParent ( <a href="qaccessibleinterface.html">QAccessibleInterface</a> ** iface ) const<tt> [pure virtual]</tt>
|
|---|
| 128 | </h3>
|
|---|
| 129 |
|
|---|
| 130 | <p> Sets <em>iface</em> to point to the implementation of the
|
|---|
| 131 | QAccessibleInterface for the parent object, or to 0 if there is
|
|---|
| 132 | no such implementation or object.
|
|---|
| 133 | <p> All objects provide this information.
|
|---|
| 134 | <p> <p>See also <a href="#queryChild">queryChild</a>().
|
|---|
| 135 |
|
|---|
| 136 | <h3 class=fn><a href="qrect.html">QRect</a> <a name="rect"></a>QAccessibleInterface::rect ( int control ) const<tt> [pure virtual]</tt>
|
|---|
| 137 | </h3>
|
|---|
| 138 |
|
|---|
| 139 | <p> Returns the location of the child specified with <em>control</em> in
|
|---|
| 140 | screen coordinates. This function returns the location of the
|
|---|
| 141 | object itself if <em>control</em> is 0.
|
|---|
| 142 | <p> All visual objects provide this information.
|
|---|
| 143 |
|
|---|
| 144 | <h3 class=fn><a href="qaccessible.html#Role-enum">Role</a> <a name="role"></a>QAccessibleInterface::role ( int control ) const<tt> [pure virtual]</tt>
|
|---|
| 145 | </h3>
|
|---|
| 146 |
|
|---|
| 147 | <p> Returns the role of the object if <em>control</em> is 0, or the role of
|
|---|
| 148 | the object's sub-element with ID <em>control</em>. The role of an object
|
|---|
| 149 | is usually static. All accessible objects have a role.
|
|---|
| 150 | <p> <p>See also <a href="#text">text</a>(), <a href="#state">state</a>(), and <a href="#selection">selection</a>().
|
|---|
| 151 |
|
|---|
| 152 | <h3 class=fn><a href="qmemarray.html">QMemArray</a><int> <a name="selection"></a>QAccessibleInterface::selection () const<tt> [pure virtual]</tt>
|
|---|
| 153 | </h3>
|
|---|
| 154 |
|
|---|
| 155 | <p> Returns the list of all the element IDs that are selected.
|
|---|
| 156 | <p> <p>See also <a href="#text">text</a>(), <a href="#role">role</a>(), and <a href="#state">state</a>().
|
|---|
| 157 |
|
|---|
| 158 | <h3 class=fn>bool <a name="setFocus"></a>QAccessibleInterface::setFocus ( int control )<tt> [pure virtual]</tt>
|
|---|
| 159 | </h3>
|
|---|
| 160 |
|
|---|
| 161 | <p> Gives the focus to the child object specified by <em>control</em>, or to
|
|---|
| 162 | the object itself if <em>control</em> is 0.
|
|---|
| 163 | <p> Returns TRUE if the focus could be set; otherwise returns FALSE.
|
|---|
| 164 |
|
|---|
| 165 | <h3 class=fn>bool <a name="setSelected"></a>QAccessibleInterface::setSelected ( int control, bool on, bool extend )<tt> [pure virtual]</tt>
|
|---|
| 166 | </h3>
|
|---|
| 167 |
|
|---|
| 168 | <p> Sets the selection of the child object with ID <em>control</em> to <em>on</em>. If <em>extend</em> is TRUE, all child elements between the focused
|
|---|
| 169 | item and the specified child object have their selection set to <em>on</em>.
|
|---|
| 170 | <p> Returns TRUE if the selection could be set; otherwise returns
|
|---|
| 171 | FALSE.
|
|---|
| 172 | <p> <p>See also <a href="#setFocus">setFocus</a>() and <a href="#clearSelection">clearSelection</a>().
|
|---|
| 173 |
|
|---|
| 174 | <h3 class=fn>void <a name="setText"></a>QAccessibleInterface::setText ( <a href="qaccessible.html#Text-enum">Text</a> t, int control, const <a href="qstring.html">QString</a> & text )<tt> [pure virtual]</tt>
|
|---|
| 175 | </h3>
|
|---|
| 176 |
|
|---|
| 177 | <p> Sets the text property <em>t</em> of the child object <em>control</em> to <em>text</em>. If <em>control</em> is 0, the text property of the object itself
|
|---|
| 178 | is set.
|
|---|
| 179 |
|
|---|
| 180 | <h3 class=fn><a href="qaccessible.html#State-enum">State</a> <a name="state"></a>QAccessibleInterface::state ( int control ) const<tt> [pure virtual]</tt>
|
|---|
| 181 | </h3>
|
|---|
| 182 |
|
|---|
| 183 | <p> Returns the current state of the object if <em>control</em> is 0, or the
|
|---|
| 184 | state of the object's sub-element element with ID <em>control</em>. All
|
|---|
| 185 | objects have a state.
|
|---|
| 186 | <p> <p>See also <a href="#text">text</a>(), <a href="#role">role</a>(), and <a href="#selection">selection</a>().
|
|---|
| 187 |
|
|---|
| 188 | <h3 class=fn><a href="qstring.html">QString</a> <a name="text"></a>QAccessibleInterface::text ( <a href="qaccessible.html#Text-enum">Text</a> t, int control ) const<tt> [pure virtual]</tt>
|
|---|
| 189 | </h3>
|
|---|
| 190 |
|
|---|
| 191 | <p> Returns a string property <em>t</em> of the child object specified by <em>control</em>, or the string property of the object itself if <em>control</em>
|
|---|
| 192 | is 0.
|
|---|
| 193 | <p> The <em>Name</em> is a string used by clients to identify, find or
|
|---|
| 194 | announce an accessible object for the user. All objects must have
|
|---|
| 195 | a name that is unique within their container.
|
|---|
| 196 | <p> An accessible object's <em>Description</em> provides textual information
|
|---|
| 197 | about an object's visual appearance. The description is primarily
|
|---|
| 198 | used to provide greater context for low-vision or blind users, but
|
|---|
| 199 | is also used for context searching or other applications. Not all
|
|---|
| 200 | objects have a description. An "OK" button would not need a
|
|---|
| 201 | description, but a toolbutton that shows a picture of a smiley
|
|---|
| 202 | would.
|
|---|
| 203 | <p> The <em>Value</em> of an accessible object represents visual information
|
|---|
| 204 | contained by the object, e.g. the text in a line edit. Usually,
|
|---|
| 205 | the value can be modified by the user. Not all objects have a
|
|---|
| 206 | value, e.g. static text labels don't, and some objects have a
|
|---|
| 207 | state that already is the value, e.g. toggle buttons.
|
|---|
| 208 | <p> The <em>Help</em> text provides information about the function and
|
|---|
| 209 | usage of an accessible object. Not all objects provide this
|
|---|
| 210 | information.
|
|---|
| 211 | <p> An accessible object's <em>DefaultAction</em> describes the object's
|
|---|
| 212 | primary method of manipulation, and should be a verb or a short
|
|---|
| 213 | phrase, e.g. "Press" for a button.
|
|---|
| 214 | <p> The accelerator is a keyboard shortcut that activates the default
|
|---|
| 215 | action of the object. A keyboard shortcut is the underlined
|
|---|
| 216 | character in the text of a menu, menu item or control, and is
|
|---|
| 217 | either the character itself, or a combination of this character
|
|---|
| 218 | and a modifier key like ALT, CTRL or SHIFT. Command controls like
|
|---|
| 219 | tool buttons also have shortcut keys and usually display them in
|
|---|
| 220 | their tooltip.
|
|---|
| 221 | <p> <p>See also <a href="#role">role</a>(), <a href="#state">state</a>(), and <a href="#selection">selection</a>().
|
|---|
| 222 |
|
|---|
| 223 | <!-- eof -->
|
|---|
| 224 | <hr><p>
|
|---|
| 225 | This file is part of the <a href="index.html">Qt toolkit</a>.
|
|---|
| 226 | Copyright © 1995-2007
|
|---|
| 227 | <a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
|
|---|
| 228 | <table width=100% cellspacing=0 border=0><tr>
|
|---|
| 229 | <td>Copyright © 2007
|
|---|
| 230 | <a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
|
|---|
| 231 | <td align=right><div align=right>Qt 3.3.8</div>
|
|---|
| 232 | </table></div></address></body>
|
|---|
| 233 | </html>
|
|---|
