source: trunk/doc/html/qfocusdata.html@ 208

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

reference documentation added
File size: 5.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/qfocusdata.cpp:40 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QFocusData 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>QFocusData Class Reference</h1>
33
34<p>The QFocusData class maintains the list of widgets in the focus
35chain.
36<a href="#details">More...</a>
37<p><tt>#include &lt;<a href="qfocusdata-h.html">qfocusdata.h</a>&gt;</tt>
38<p><a href="qfocusdata-members.html">List of all member functions.</a>
39<h2>Public Members</h2>
40<ul>
41<li class=fn>QWidget * <a href="#focusWidget"><b>focusWidget</b></a> () const</li>
42<li class=fn>QWidget * <a href="#home"><b>home</b></a> ()</li>
43<li class=fn>QWidget * <a href="#next"><b>next</b></a> ()</li>
44<li class=fn>QWidget * <a href="#prev"><b>prev</b></a> ()</li>
45<li class=fn>QWidget * <a href="#first"><b>first</b></a> () const</li>
46<li class=fn>QWidget * <a href="#last"><b>last</b></a> () const</li>
47<li class=fn>int <a href="#count"><b>count</b></a> () const</li>
48</ul>
49<hr><a name="details"></a><h2>Detailed Description</h2>
50
51
52The QFocusData class maintains the list of widgets in the focus
53chain.
54<p>
55<p> This read-only list always contains at least one widget (i.e. the
56top-level widget). It provides a simple cursor which can be reset
57to the current focus widget using <a href="#home">home</a>(), or moved to its
58neighboring widgets using <a href="#next">next</a>() and <a href="#prev">prev</a>(). You can also retrieve
59the <a href="#count">count</a>() of the number of widgets in the list. The list is a
60loop, so if you keep iterating, for example using next(), you will
61never come to the end.
62<p> Some widgets in the list may not accept focus. Widgets are added
63to the list as necessary, but not removed from it. This lets
64widgets change focus policy dynamically without disrupting the
65focus chain the user experiences. When a widget disables and
66re-enables tab focus, its position in the focus chain does not
67change.
68<p> When reimplementing <a href="qwidget.html#focusNextPrevChild">QWidget::focusNextPrevChild</a>() to provide
69special focus flow, you will usually call <a href="qwidget.html#focusData">QWidget::focusData</a>() to
70retrieve the focus data stored at the top-level widget. A
71top-level widget's focus data contains the focus list for its
72hierarchy of widgets.
73<p> The cursor may change at any time.
74<p> This class is <em>not</em> thread-safe.
75<p> <p>See also <a href="qwidget.html#focusNextPrevChild">QWidget::focusNextPrevChild</a>(), <a href="qwidget.html#setTabOrder">QWidget::setTabOrder</a>(), <a href="qwidget.html#focusPolicy-prop">QWidget::focusPolicy</a>, and <a href="misc.html">Miscellaneous Classes</a>.
76
77<hr><h2>Member Function Documentation</h2>
78<h3 class=fn>int <a name="count"></a>QFocusData::count () const
79</h3>
80
81<p> Returns the number of widgets in the focus chain.
82
83<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="first"></a>QFocusData::first () const
84</h3>
85Returns the first widget in the focus chain.
86The cursor is not modified.
87
88<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="focusWidget"></a>QFocusData::focusWidget () const
89</h3>
90
91<p> Returns the widgets in the hierarchy that are in the focus chain.
92
93<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="home"></a>QFocusData::home ()
94</h3>
95Moves the cursor to the <a href="#focusWidget">focusWidget</a>() and returns that widget. You
96must call this before <a href="#next">next</a>() or <a href="#prev">prev</a>() to iterate meaningfully.
97
98<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="last"></a>QFocusData::last () const
99</h3>
100Returns the last widget in the focus chain.
101The cursor is not modified.
102
103<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="next"></a>QFocusData::next ()
104</h3>
105Moves the cursor to the next widget in the focus chain. There is
106<em>always</em> a next widget because the list is a loop.
107
108<h3 class=fn><a href="qwidget.html">QWidget</a>&nbsp;* <a name="prev"></a>QFocusData::prev ()
109</h3>
110Moves the cursor to the previous widget in the focus chain. There
111is <em>always</em> a previous widget because the list is a loop.
112
113<!-- eof -->
114<hr><p>
115This file is part of the <a href="index.html">Qt toolkit</a>.
116Copyright &copy; 1995-2007
117<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
118<table width=100% cellspacing=0 border=0><tr>
119<td>Copyright &copy; 2007
120<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
121<td align=right><div align=right>Qt 3.3.8</div>
122</table></div></address></body>
123</html>
Note: See TracBrowser for help on using the repository browser.