summaryrefslogtreecommitdiffstats
path: root/doc/html/qcloseevent.html
blob: 6d3789c3ac41c009de7432d0d8f24d06e7ef954e (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
134
<!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:1392 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QCloseEvent 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>QCloseEvent Class Reference</h1>

<p>The QCloseEvent class contains parameters that describe a close event.
<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="qcloseevent-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#QCloseEvent"><b>QCloseEvent</b></a> ()</li>
<li class=fn>bool <a href="#isAccepted"><b>isAccepted</b></a> () const</li>
<li class=fn>void <a href="#accept"><b>accept</b></a> ()</li>
<li class=fn>void <a href="#ignore"><b>ignore</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QCloseEvent class contains parameters that describe a close event.
<p> 
<p> Close events are sent to widgets that the user wants to close,
usually by choosing "Close" from the window menu, or by clicking
the `X' titlebar button. They are also sent when you call
<a href="qwidget.html#close">QWidget::close</a>() to close a widget programmatically.
<p> Close events contain a flag that indicates whether the receiver
wants the widget to be closed or not. When a widget accepts the
close event, it is hidden (and destroyed if it was created with
the <a href="qt.html#WidgetFlags-enum">WDestructiveClose</a> flag). If it refuses to accept the close
event nothing happens. (Under X11 it is possible that the window
manager will forcibly close the window; but at the time of writing
we are not aware of any window manager that does this.)
<p> The application's main widget -- <a href="qapplication.html#mainWidget">QApplication::mainWidget</a>() --
is a special case. When it accepts the close event, Qt leaves the
main event loop and the application is immediately terminated
(i.e. it returns from the call to <a href="qapplication.html#exec">QApplication::exec</a>() in the
main() function).
<p> The event handler <a href="qwidget.html#closeEvent">QWidget::closeEvent</a>() receives close events. The
default implementation of this event handler accepts the close
event. If you do not want your widget to be hidden, or want some
special handing, you should reimplement the event handler.
<p> The <a href="simple-application.html#closeEvent">closeEvent() in the
    Application Walkthrough</a> shows a close event handler that
asks whether to save a document before closing.
<p> If you want the widget to be deleted when it is closed, create it
with the <a href="qt.html#WidgetFlags-enum">WDestructiveClose</a> widget flag. This is very useful for
independent top-level windows in a multi-window application.
<p> <a href="qobject.html">QObject</a>s emits the <a href="qobject.html#destroyed">destroyed()</a> signal when they are deleted.
<p> If the last top-level window is closed, the
<a href="qapplication.html#lastWindowClosed">QApplication::lastWindowClosed</a>() signal is emitted.
<p> The <a href="#isAccepted">isAccepted</a>() function returns TRUE if the event's receiver has
agreed to close the widget; call <a href="#accept">accept</a>() to agree to close the
widget and call <a href="#ignore">ignore</a>() if the receiver of this event does not
want the widget to be closed.
<p> <p>See also <a href="qwidget.html#close">QWidget::close</a>(), <a href="qwidget.html#hide">QWidget::hide</a>(), <a href="qobject.html#destroyed">QObject::destroyed</a>(), <a href="qapplication.html#setMainWidget">QApplication::setMainWidget</a>(), <a href="qapplication.html#lastWindowClosed">QApplication::lastWindowClosed</a>(), <a href="qapplication.html#exec">QApplication::exec</a>(), <a href="qapplication.html#quit">QApplication::quit</a>(), and <a href="events.html">Event Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="QCloseEvent"></a>QCloseEvent::QCloseEvent ()
</h3>

<p> Constructs a close event object with the accept parameter flag set
to FALSE.
<p> <p>See also <a href="#accept">accept</a>().

<h3 class=fn>void <a name="accept"></a>QCloseEvent::accept ()
</h3>

<p> Sets the accept flag of the close event object.
<p> Setting the accept flag indicates that the receiver of this event
agrees to close the widget.
<p> The accept flag is <em>not</em> set by default.
<p> If you choose to accept in <a href="qwidget.html#closeEvent">QWidget::closeEvent</a>(), the widget will
be hidden. If the widget's <a href="qt.html#WidgetFlags-enum">WDestructiveClose</a> flag is set, it
will also be destroyed.
<p> <p>See also <a href="#ignore">ignore</a>() and <a href="qwidget.html#hide">QWidget::hide</a>().

<p>Examples: <a href="qaction-application-example.html#x1128">action/application.cpp</a>, <a href="simple-application-example.html#x1545">application/application.cpp</a>, <a href="mdi-example.html#x2021">mdi/application.cpp</a>, <a href="popup-example.html#x1607">popup/popup.cpp</a>, and <a href="qwerty-example.html#x360">qwerty/qwerty.cpp</a>.
<h3 class=fn>void <a name="ignore"></a>QCloseEvent::ignore ()
</h3>

<p> Clears the accept flag of the close event object.
<p> Clearing the accept flag indicates that the receiver of this event
does not want the widget to be closed.
<p> The close event is constructed with the accept flag cleared.
<p> <p>See also <a href="#accept">accept</a>().

<p>Examples: <a href="qaction-application-example.html#x1129">action/application.cpp</a>, <a href="simple-application-example.html#x1546">application/application.cpp</a>, <a href="mdi-example.html#x2022">mdi/application.cpp</a>, and <a href="qwerty-example.html#x361">qwerty/qwerty.cpp</a>.
<h3 class=fn>bool <a name="isAccepted"></a>QCloseEvent::isAccepted () const
</h3>

<p> Returns TRUE if the receiver of the event has agreed to close the
widget; otherwise returns FALSE.
<p> <p>See also <a href="#accept">accept</a>() and <a href="#ignore">ignore</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>