QCloseEvent(3qt)QCloseEvent(3qt)NAMEQCloseEvent - Parameters that describe a close event
SYNOPSIS
#include <qevent.h>
Inherits QEvent.
Public Members
QCloseEvent ()
bool isAccepted () const
void accept ()
void ignore ()
DESCRIPTION
The QCloseEvent class contains parameters that describe a close event.
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 QWidget::close() to
close a widget programmatically.
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
WDestructiveClose 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.)
The application's main widget --QApplication::mainWidget()-- 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 QApplication::exec() in the main() function).
The event handler QWidget::closeEvent() 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.
The closeEvent() in the Application Walkthrough shows a close event
handler that asks whether to save a document before closing.
If you want the widget to be deleted when it is closed, create it with
the WDestructiveClose widget flag. This is very useful for independent
top-level windows in a multi-window application.
QObjects emits the destroyed() signal when they are deleted.
If the last top-level window is closed, the
QApplication::lastWindowClosed() signal is emitted.
The isAccepted() function returns TRUE if the event's receiver has
agreed to close the widget; call accept() to agree to close the widget
and call ignore() if the receiver of this event does not want the
widget to be closed.
See also QWidget::close(), QWidget::hide(), QObject::destroyed(),
QApplication::setMainWidget(), QApplication::lastWindowClosed(),
QApplication::exec(), QApplication::quit(), and Event Classes.
MEMBER FUNCTION DOCUMENTATIONQCloseEvent::QCloseEvent ()
Constructs a close event object with the accept parameter flag set to
FALSE.
See also accept().
void QCloseEvent::accept ()
Sets the accept flag of the close event object.
Setting the accept flag indicates that the receiver of this event
agrees to close the widget.
The accept flag is not set by default.
If you choose to accept in QWidget::closeEvent(), the widget will be
hidden. If the widget's WDestructiveClose flag is set, it will also be
destroyed.
See also ignore() and QWidget::hide().
Examples:
void QCloseEvent::ignore ()
Clears the accept flag of the close event object.
Clearing the accept flag indicates that the receiver of this event does
not want the widget to be closed.
The close event is constructed with the accept flag cleared.
See also accept().
Examples:
bool QCloseEvent::isAccepted () const
Returns TRUE if the receiver of the event has agreed to close the
widget; otherwise returns FALSE.
See also accept() and ignore().
SEE ALSO
http://doc.trolltech.com/qcloseevent.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
license file included in the distribution for a complete license
statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports help us to
help you. Thank you.
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with a
web browser. This man page is provided as a convenience for those users
who prefer man pages, although this format is not officially supported
by Trolltech.
If you find errors in this manual page, please report them to qt-
bugs@trolltech.com. Please include the name of the manual page
(qcloseevent.3qt) and the Qt version (3.3.8).
Trolltech AS 2 February 2007 QCloseEvent(3qt)