From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qcloseevent.html | 134 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 doc/html/qcloseevent.html (limited to 'doc/html/qcloseevent.html') diff --git a/doc/html/qcloseevent.html b/doc/html/qcloseevent.html new file mode 100644 index 0000000..6d3789c --- /dev/null +++ b/doc/html/qcloseevent.html @@ -0,0 +1,134 @@ + + + + + +QCloseEvent Class + + + + + + + +

QCloseEvent Class Reference

+ +

The QCloseEvent class contains parameters that describe a close event. +More... +

#include <qevent.h> +

Inherits QEvent. +

List of all member functions. +

Public Members

QCloseEvent ()
bool isAccepted () const
void accept ()
void ignore ()

Detailed 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. +

Member Function Documentation

QCloseEvent::QCloseEvent () +

+ +

Constructs a close event object with the accept parameter flag set +to FALSE. +

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: action/application.cpp, application/application.cpp, mdi/application.cpp, popup/popup.cpp, and qwerty/qwerty.cpp. +

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. +

bool QCloseEvent::isAccepted () const +

+ +

Returns TRUE if the receiver of the event has agreed to close the +widget; otherwise returns FALSE. +