summaryrefslogtreecommitdiffstats
path: root/doc/html/qfocusevent.html
blob: fe96402ee03538f2aa5463f8fb895960f38ac876 (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qevent.cpp:1147 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QFocusEvent Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QFocusEvent Class Reference</h1>

<p>The QFocusEvent class contains event parameters for widget focus
events.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qevent-h.html">qevent.h</a>&gt;</tt>
<p>Inherits <a href="qevent.html">QEvent</a>.
<p><a href="qfocusevent-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QFocusEvent"><b>QFocusEvent</b></a> ( Type&nbsp;type )</li>
<li class=fn>bool <a href="#gotFocus"><b>gotFocus</b></a> () const</li>
<li class=fn>bool <a href="#lostFocus"><b>lostFocus</b></a> () const</li>
<li class=fn>enum <a href="#Reason-enum"><b>Reason</b></a> { Mouse, Tab, Backtab, ActiveWindow, Popup, Shortcut, Other }</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>Reason <a href="#reason"><b>reason</b></a> ()</li>
<li class=fn>void <a href="#setReason"><b>setReason</b></a> ( Reason&nbsp;reason )</li>
<li class=fn>void <a href="#resetReason"><b>resetReason</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QFocusEvent class contains event parameters for widget focus
events.
<p> 
<p> Focus events are sent to widgets when the keyboard input focus
changes. Focus events occur due to mouse actions, keypresses (e.g.
Tab or Backtab), the window system, popup menus, keyboard
shortcuts or other application specific reasons. The reason for a
particular focus event is returned by <a href="#reason">reason</a>() in the appropriate
event handler.
<p> The event handlers <a href="qwidget.html#focusInEvent">QWidget::focusInEvent</a>() and
<a href="qwidget.html#focusOutEvent">QWidget::focusOutEvent</a>() receive focus events.
<p> Use <a href="#setReason">setReason</a>() to set the reason for all focus events, and
<a href="#resetReason">resetReason</a>() to set the reason for all focus events to the reason
in force before the last setReason() call.
<p> <p>See also <a href="qwidget.html#setFocus">QWidget::setFocus</a>(), <a href="qwidget.html#focusPolicy-prop">QWidget::focusPolicy</a>, and <a href="events.html">Event Classes</a>.

<hr><h2>Member Type Documentation</h2>
<h3 class=fn><a name="Reason-enum"></a>QFocusEvent::Reason</h3>

<p> This enum specifies why the focus changed.
<ul>
<li><tt>QFocusEvent::Mouse</tt> - because of a mouse action.
<li><tt>QFocusEvent::Tab</tt> - because of a Tab press.
<li><tt>QFocusEvent::Backtab</tt> - because of a Backtab press
(possibly including Shift/Control, e.g. Shift+Tab).
<li><tt>QFocusEvent::ActiveWindow</tt> - because the window system made this window (in)active.
<li><tt>QFocusEvent::Popup</tt> - because the application opened/closed a popup that grabbed/released focus.
<li><tt>QFocusEvent::Shortcut</tt> - because of a keyboard shortcut.
<li><tt>QFocusEvent::Other</tt> - any other reason, usually application-specific.
</ul><p> See the <a href="focus.html">keyboard focus overview</a> for more
about focus.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QFocusEvent"></a>QFocusEvent::QFocusEvent ( <a href="qevent.html#Type-enum">Type</a>&nbsp;type )
</h3>

<p> Constructs a focus event object.
<p> The <em>type</em> parameter must be either <a href="qevent.html#Type-enum">QEvent::FocusIn</a> or <a href="qevent.html#Type-enum">QEvent::FocusOut</a>.

<h3 class=fn>bool <a name="gotFocus"></a>QFocusEvent::gotFocus () const
</h3>

<p> Returns TRUE if the widget received the text input focus;
otherwise returns FALSE.

<h3 class=fn>bool <a name="lostFocus"></a>QFocusEvent::lostFocus () const
</h3>

<p> Returns TRUE if the widget lost the text input focus; otherwise
returns FALSE.

<h3 class=fn><a href="qfocusevent.html#Reason-enum">Reason</a> <a name="reason"></a>QFocusEvent::reason ()<tt> [static]</tt>
</h3>
Returns the reason for this focus event.
<p> <p>See also <a href="#setReason">setReason</a>().

<h3 class=fn>void <a name="resetReason"></a>QFocusEvent::resetReason ()<tt> [static]</tt>
</h3>
Resets the reason for all future focus events to the value before
the last <a href="#setReason">setReason</a>() call.
<p> <p>See also <a href="#reason">reason</a>() and <a href="#setReason">setReason</a>().

<h3 class=fn>void <a name="setReason"></a>QFocusEvent::setReason ( <a href="qfocusevent.html#Reason-enum">Reason</a>&nbsp;reason )<tt> [static]</tt>
</h3>
Sets the reason for all future focus events to <em>reason</em>.
<p> <p>See also <a href="#reason">reason</a>() and <a href="#resetReason">resetReason</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>