File: qaccessiblewidget.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (214 lines) | stat: -rw-r--r-- 19,762 bytes parent folder | download 
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
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qaccessiblewidget.cpp -->
  <title>Qt 4.8: QAccessibleWidget Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QAccessibleWidget</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QAccessibleWidget Class Reference</h1>
<!-- $$$QAccessibleWidget-brief -->
<p>The QAccessibleWidget class implements the <a href="qaccessibleinterface.html">QAccessibleInterface</a> for QWidgets. <a href="#details">More...</a></p>
<!-- @@@QAccessibleWidget -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QAccessibleWidget&gt;</span></pre><p><b>Inherits: </b><a href="qaccessibleobject.html">QAccessibleObject</a>.</p>
<ul>
<li><a href="qaccessiblewidget-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#QAccessibleWidget">QAccessibleWidget</a></b> ( QWidget * <i>w</i>, Role <i>role</i> = Client, const QString &amp; <i>name</i> = QString() )</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#actionText">actionText</a></b> ( int <i>action</i>, Text <i>t</i>, int <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#childAt">childAt</a></b> ( int <i>x</i>, int <i>y</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#childCount">childCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#doAction">doAction</a></b> ( int <i>action</i>, int <i>child</i>, const QVariantList &amp; <i>params</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#indexOfChild">indexOfChild</a></b> ( const QAccessibleInterface * <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#navigate">navigate</a></b> ( RelationFlag <i>relation</i>, int <i>entry</i>, QAccessibleInterface ** <i>target</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QRect </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#rect">rect</a></b> ( int <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual Relation </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#relationTo">relationTo</a></b> ( int <i>child</i>, const QAccessibleInterface * <i>other</i>, int <i>otherChild</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual Role </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#role">role</a></b> ( int <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual State </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#state">state</a></b> ( int <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#text">text</a></b> ( Text <i>t</i>, int <i>child</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual int </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#userActionCount">userActionCount</a></b> ( int <i>child</i> ) const</td></tr>
</table>
<ul>
<li class="fn">7 public functions inherited from <a href="qaccessibleobject.html#public-functions">QAccessibleObject</a></li>
<li class="fn">17 public functions inherited from <a href="qaccessibleinterface.html#public-functions">QAccessibleInterface</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#dtor.QAccessibleWidget">~QAccessibleWidget</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#addControllingSignal">addControllingSignal</a></b> ( const QString &amp; <i>signal</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QObject * </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#parentObject">parentObject</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#setAccelerator">setAccelerator</a></b> ( const QString &amp; <i>accel</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#setDescription">setDescription</a></b> ( const QString &amp; <i>desc</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#setHelp">setHelp</a></b> ( const QString &amp; <i>help</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#setValue">setValue</a></b> ( const QString &amp; <i>value</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWidget * </td><td class="memItemRight bottomAlign"><b><a href="qaccessiblewidget.html#widget">widget</a></b> () const</td></tr>
</table>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">7 static public members inherited from <a href="qaccessible.html#static-public-members">QAccessible</a></li>
</ul>
<a name="details"></a>
<!-- $$$QAccessibleWidget-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QAccessibleWidget class implements the <a href="qaccessibleinterface.html">QAccessibleInterface</a> for QWidgets.</p>
<p>This class is convenient to use as a base class for custom implementations of QAccessibleInterfaces that provide information about widget objects.</p>
<p>The class provides functions to retrieve the <a href="qaccessiblewidget.html#parentObject">parentObject</a>() (the widget's parent widget), and the associated <a href="qaccessiblewidget.html#widget">widget</a>(). Controlling signals can be added with <a href="qaccessiblewidget.html#addControllingSignal">addControllingSignal</a>(), and setters are provided for various aspects of the interface implementation, for example <a href="qaccessiblewidget.html#setValue">setValue</a>(), <a href="qaccessiblewidget.html#setDescription">setDescription</a>(), <a href="qaccessiblewidget.html#setAccelerator">setAccelerator</a>(), and <a href="qaccessiblewidget.html#setHelp">setHelp</a>().</p>
</div>
<p><b>See also </b><a href="qaccessible.html">QAccessible</a> and <a href="qaccessibleobject.html">QAccessibleObject</a>.</p>
<!-- @@@QAccessibleWidget -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QAccessibleWidget[overload1]$$$QAccessibleWidgetQWidget*RoleconstQString& -->
<h3 class="fn"><a name="QAccessibleWidget"></a>QAccessibleWidget::<span class="name">QAccessibleWidget</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>w</i>, <span class="type"><a href="qaccessible.html#Role-enum">Role</a></span> <i>role</i> = Client, const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>name</i> = QString() )</h3>
<p>Creates a <a href="qaccessiblewidget.html">QAccessibleWidget</a> object for widget <i>w</i>. <i>role</i> and <i>name</i> are optional parameters that set the object's role and name properties.</p>
<!-- @@@QAccessibleWidget -->
<!-- $$$~QAccessibleWidget[overload1]$$$~QAccessibleWidget -->
<h3 class="fn"><a name="dtor.QAccessibleWidget"></a>QAccessibleWidget::<span class="name">~QAccessibleWidget</span> ()<tt> [protected]</tt></h3>
<p>Destroys this object.</p>
<!-- @@@~QAccessibleWidget -->
<!-- $$$actionText[overload1]$$$actionTextintTextint -->
<h3 class="fn"><a name="actionText"></a><span class="type"><a href="qstring.html">QString</a></span> QAccessibleWidget::<span class="name">actionText</span> ( <span class="type">int</span> <i>action</i>, <span class="type"><a href="qaccessible.html#Text-enum">Text</a></span> <i>t</i>, <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#actionText">QAccessibleInterface::actionText</a>().</p>
<!-- @@@actionText -->
<!-- $$$addControllingSignal[overload1]$$$addControllingSignalconstQString& -->
<h3 class="fn"><a name="addControllingSignal"></a><span class="type">void</span> QAccessibleWidget::<span class="name">addControllingSignal</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>signal</i> )<tt> [protected]</tt></h3>
<p>Registers <i>signal</i> as a controlling signal.</p>
<p>An object is a Controller to any other object connected to a controlling signal.</p>
<!-- @@@addControllingSignal -->
<!-- $$$childAt[overload1]$$$childAtintint -->
<h3 class="fn"><a name="childAt"></a><span class="type">int</span> QAccessibleWidget::<span class="name">childAt</span> ( <span class="type">int</span> <i>x</i>, <span class="type">int</span> <i>y</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#childAt">QAccessibleInterface::childAt</a>().</p>
<!-- @@@childAt -->
<!-- $$$childCount[overload1]$$$childCount -->
<h3 class="fn"><a name="childCount"></a><span class="type">int</span> QAccessibleWidget::<span class="name">childCount</span> () const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#childCount">QAccessibleInterface::childCount</a>().</p>
<!-- @@@childCount -->
<!-- $$$doAction[overload1]$$$doActionintintconstQVariantList& -->
<h3 class="fn"><a name="doAction"></a><span class="type">bool</span> QAccessibleWidget::<span class="name">doAction</span> ( <span class="type">int</span> <i>action</i>, <span class="type">int</span> <i>child</i>, const <span class="type"><a href="qvariant.html#QVariantList-typedef">QVariantList</a></span> &amp; <i>params</i> )<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#doAction">QAccessibleInterface::doAction</a>().</p>
<!-- @@@doAction -->
<!-- $$$indexOfChild[overload1]$$$indexOfChildconstQAccessibleInterface* -->
<h3 class="fn"><a name="indexOfChild"></a><span class="type">int</span> QAccessibleWidget::<span class="name">indexOfChild</span> ( const <span class="type"><a href="qaccessibleinterface.html">QAccessibleInterface</a></span> * <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#indexOfChild">QAccessibleInterface::indexOfChild</a>().</p>
<!-- @@@indexOfChild -->
<!-- $$$navigate[overload1]$$$navigateRelationFlagintQAccessibleInterface** -->
<h3 class="fn"><a name="navigate"></a><span class="type">int</span> QAccessibleWidget::<span class="name">navigate</span> ( <span class="type"><a href="qaccessible.html#RelationFlag-enum">RelationFlag</a></span> <i>relation</i>, <span class="type">int</span> <i>entry</i>, <span class="type"><a href="qaccessibleinterface.html">QAccessibleInterface</a></span> ** <i>target</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#navigate">QAccessibleInterface::navigate</a>().</p>
<!-- @@@navigate -->
<!-- $$$parentObject[overload1]$$$parentObject -->
<h3 class="fn"><a name="parentObject"></a><span class="type"><a href="qobject.html">QObject</a></span> * QAccessibleWidget::<span class="name">parentObject</span> () const<tt> [protected]</tt></h3>
<p>Returns the associated widget's parent object, which is either the parent widget, or <a href="qapplication.html#qApp">qApp</a> for top-level widgets.</p>
<!-- @@@parentObject -->
<!-- $$$rect[overload1]$$$rectint -->
<h3 class="fn"><a name="rect"></a><span class="type"><a href="qrect.html">QRect</a></span> QAccessibleWidget::<span class="name">rect</span> ( <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#rect">QAccessibleInterface::rect</a>().</p>
<!-- @@@rect -->
<!-- $$$relationTo[overload1]$$$relationTointconstQAccessibleInterface*int -->
<h3 class="fn"><a name="relationTo"></a><span class="type"><a href="qaccessible.html#RelationFlag-enum">Relation</a></span> QAccessibleWidget::<span class="name">relationTo</span> ( <span class="type">int</span> <i>child</i>, const <span class="type"><a href="qaccessibleinterface.html">QAccessibleInterface</a></span> * <i>other</i>, <span class="type">int</span> <i>otherChild</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#relationTo">QAccessibleInterface::relationTo</a>().</p>
<!-- @@@relationTo -->
<!-- $$$role[overload1]$$$roleint -->
<h3 class="fn"><a name="role"></a><span class="type"><a href="qaccessible.html#Role-enum">Role</a></span> QAccessibleWidget::<span class="name">role</span> ( <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#role">QAccessibleInterface::role</a>().</p>
<!-- @@@role -->
<!-- $$$setAccelerator[overload1]$$$setAcceleratorconstQString& -->
<h3 class="fn"><a name="setAccelerator"></a><span class="type">void</span> QAccessibleWidget::<span class="name">setAccelerator</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>accel</i> )<tt> [protected]</tt></h3>
<p>Sets the accelerator of this interface implementation to <i>accel</i>.</p>
<p>The default implementation of <a href="qaccessiblewidget.html#text">text</a>() returns the set value for the Accelerator text.</p>
<p>Note that the object wrapped by this interface is not modified.</p>
<!-- @@@setAccelerator -->
<!-- $$$setDescription[overload1]$$$setDescriptionconstQString& -->
<h3 class="fn"><a name="setDescription"></a><span class="type">void</span> QAccessibleWidget::<span class="name">setDescription</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>desc</i> )<tt> [protected]</tt></h3>
<p>Sets the description of this interface implementation to <i>desc</i>.</p>
<p>The default implementation of <a href="qaccessiblewidget.html#text">text</a>() returns the set value for the Description text.</p>
<p>Note that the object wrapped by this interface is not modified.</p>
<!-- @@@setDescription -->
<!-- $$$setHelp[overload1]$$$setHelpconstQString& -->
<h3 class="fn"><a name="setHelp"></a><span class="type">void</span> QAccessibleWidget::<span class="name">setHelp</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>help</i> )<tt> [protected]</tt></h3>
<p>Sets the help of this interface implementation to <i>help</i>.</p>
<p>The default implementation of <a href="qaccessiblewidget.html#text">text</a>() returns the set value for the Help text.</p>
<p>Note that the object wrapped by this interface is not modified.</p>
<!-- @@@setHelp -->
<!-- $$$setValue[overload1]$$$setValueconstQString& -->
<h3 class="fn"><a name="setValue"></a><span class="type">void</span> QAccessibleWidget::<span class="name">setValue</span> ( const <span class="type"><a href="qstring.html">QString</a></span> &amp; <i>value</i> )<tt> [protected]</tt></h3>
<p>Sets the value of this interface implementation to <i>value</i>.</p>
<p>The default implementation of <a href="qaccessiblewidget.html#text">text</a>() returns the set value for the Value text.</p>
<p>Note that the object wrapped by this interface is not modified.</p>
<!-- @@@setValue -->
<!-- $$$state[overload1]$$$stateint -->
<h3 class="fn"><a name="state"></a><span class="type"><a href="qaccessible.html#StateFlag-enum">State</a></span> QAccessibleWidget::<span class="name">state</span> ( <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#state">QAccessibleInterface::state</a>().</p>
<!-- @@@state -->
<!-- $$$text[overload1]$$$textTextint -->
<h3 class="fn"><a name="text"></a><span class="type"><a href="qstring.html">QString</a></span> QAccessibleWidget::<span class="name">text</span> ( <span class="type"><a href="qaccessible.html#Text-enum">Text</a></span> <i>t</i>, <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#text">QAccessibleInterface::text</a>().</p>
<!-- @@@text -->
<!-- $$$userActionCount[overload1]$$$userActionCountint -->
<h3 class="fn"><a name="userActionCount"></a><span class="type">int</span> QAccessibleWidget::<span class="name">userActionCount</span> ( <span class="type">int</span> <i>child</i> ) const<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qaccessibleinterface.html#userActionCount">QAccessibleInterface::userActionCount</a>().</p>
<!-- @@@userActionCount -->
<!-- $$$widget[overload1]$$$widget -->
<h3 class="fn"><a name="widget"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * QAccessibleWidget::<span class="name">widget</span> () const<tt> [protected]</tt></h3>
<p>Returns the associated widget.</p>
<!-- @@@widget -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>