From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qdialog.html | 355 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 355 insertions(+) create mode 100644 doc/html/qdialog.html (limited to 'doc/html/qdialog.html') diff --git a/doc/html/qdialog.html b/doc/html/qdialog.html new file mode 100644 index 000000000..c23d826e0 --- /dev/null +++ b/doc/html/qdialog.html @@ -0,0 +1,355 @@ + + + + + +TQDialog Class + + + + + + + +

TQDialog Class Reference

+ +

The TQDialog class is the base class of dialog windows. +More... +

#include <qdialog.h> +

Inherits TQWidget. +

Inherited by TQColorDialog, TQErrorMessage, TQFileDialog, TQFontDialog, TQInputDialog, TQMessageBox, TQMotifDialog, TQProgressDialog, TQTabDialog, and TQWizard. +

List of all member functions. +

Public Members

explicit TQDialog ( TQWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 )
~TQDialog ()
enum DialogCode { Rejected, Accepted }
int result () const
virtual void show ()
void setOrientation ( Orientation orientation )
Orientation orientation () const
void setExtension ( TQWidget * extension )
TQWidget * extension () const
void setSizeGripEnabled ( bool )
bool isSizeGripEnabled () const
void setModal ( bool modal )
bool isModal () const

Public Slots

int exec ()

Properties

bool modal - whether show() should pop up the dialog as modal or modeless
bool sizeGripEnabled - whether the size grip is enabled

Protected Members

void setResult ( int i )

Protected Slots

virtual void done ( int r )
virtual void accept ()
virtual void reject ()
void showExtension ( bool showIt )

Detailed Description

+ + +The TQDialog class is the base class of dialog windows. +

+ + +

A dialog window is a top-level window mostly used for short-term +tasks and brief communications with the user. TQDialogs may be +modal or modeless. TQDialogs support extensibility and can provide a return + value. They can have default + buttons. TQDialogs can also have a TQSizeGrip in their +lower-right corner, using setSizeGripEnabled(). +

Note that TQDialog uses the parent widget slightly differently from +other classes in TQt. A dialog is always a top-level widget, but if +it has a parent, its default location is centered on top of the +parent's top-level widget (if it is not top-level itself). It will +also share the parent's taskbar entry. +

Modal Dialogs +

A modal dialog is a dialog that blocks input to other +visible windows in the same application. Users must finish +interacting with the dialog and close it before they can access +any other window in the application. Dialogs that are used to +request a file name from the user or that are used to set +application preferences are usually modal. +

The most common way to display a modal dialog is to call its +exec() function. When the user closes the dialog, exec() will +provide a useful return value. Typically we +connect a default button, e.g. "OK", to the accept() slot and a +"Cancel" button to the reject() slot, to get the dialog to close +and return the appropriate value. Alternatively you can connect to +the done() slot, passing it Accepted or Rejected. +

An alternative is to call setModal(TRUE), then show(). Unlike +exec(), show() returns control to the caller immediately. Calling +setModal(TRUE) is especially useful for progress dialogs, where +the user must have the ability to interact with the dialog, e.g. +to cancel a long running operation. If you use show() and +setModal(TRUE) together you must call +TQApplication::processEvents() periodically during processing to +enable the user to interact with the dialog. (See TQProgressDialog.) +

Modeless Dialogs +

A modeless dialog is a dialog that operates +independently of other windows in the same application. Find and +replace dialogs in word-processors are often modeless to allow the +user to interact with both the application's main window and with +the dialog. +

Modeless dialogs are displayed using show(), which returns control +to the caller immediately. +

Default button +

A dialog's default button is the button that's pressed when the +user presses Enter (Return). This button is used to signify that +the user accepts the dialog's settings and wants to close the +dialog. Use TQPushButton::setDefault(), TQPushButton::isDefault() +and TQPushButton::autoDefault() to set and control the dialog's +default button. +

Escape Key +

If the user presses the Esc key in a dialog, TQDialog::reject() +will be called. This will cause the window to close: the closeEvent cannot be ignored. +

Extensibility +

Extensibility is the ability to show the dialog in two ways: a +partial dialog that shows the most commonly used options, and a +full dialog that shows all the options. Typically an extensible +dialog will initially appear as a partial dialog, but with a +"More" toggle button. If the user presses the "More" button down, +the full dialog will appear. The extension widget will be resized +to its sizeHint(). If orientation is Horizontal the extension +widget's height() will be expanded to the height() of the dialog. +If the orientation is Vertical the extension widget's width() +will be expanded to the width() of the dialog. Extensibility is +controlled with setExtension(), setOrientation() and +showExtension(). +

Return value (modal dialogs) +

Modal dialogs are often used in situations where a return value is +retquired, e.g. to indicate whether the user pressed "OK" or +"Cancel". A dialog can be closed by calling the accept() or the +reject() slots, and exec() will return Accepted or Rejected +as appropriate. The exec() call returns the result of the dialog. +The result is also available from result() if the dialog has not +been destroyed. If the WDestructiveClose flag is set, the +dialog is deleted after exec() returns. +

Examples +

A modal dialog. +

+ +

        TQFileDialog *dlg = new TQFileDialog( workingDirectory,
+                TQString::null, 0, 0, TRUE );
+        dlg->setCaption( TQFileDialog::tr( "Open" ) );
+        dlg->setMode( TQFileDialog::ExistingFile );
+        TQString result;
+        if ( dlg->exec() == TQDialog::Accepted ) {
+            result = dlg->selectedFile();
+            workingDirectory = dlg->url();
+        }
+        delete dlg;
+        return result;
+

A modeless dialog. After the show() call, control returns to the main +event loop. + + +

    int main( int argc, char **argv )
+    {
+        TQApplication a( argc, argv );
+

        int scale = 10;
+

        LifeDialog *life = new LifeDialog( scale );
+        a.setMainWidget( life );
+        life->setCaption("TQt Example - Life");
+        life->show();
+

        return a.exec();
+    }
+

Member Type Documentation

TQDialog::DialogCode

The value returned by a modal dialog. +

TQDialog::Accepted +
TQDialog::Rejected +

Member Function Documentation

explicit TQDialog::TQDialog ( TQWidget * parent = 0, const char * name = 0, bool modal = FALSE, WFlags f = 0 ) +

+Constructs a dialog called name, with parent parent. +

A dialog is always a top-level widget, but if it has a parent, its +default location is centered on top of the parent. It will also +share the parent's taskbar entry. +

The widget flags f are passed on to the TQWidget constructor. +If, for example, you don't want a What's This button in the titlebar +of the dialog, pass WStyle_Customize | WStyle_NormalBorder | +WStyle_Title | WStyle_SysMenu in f. +

Warning: In TQt 3.2, the modal flag is obsolete. There is now a +setModal() function that can be used for obtaining a modal behavior +when calling show(). This is rarely needed, because modal dialogs +are usually invoked using exec(), which ignores the modal flag. +

See also TQWidget::setWFlags() and TQt::WidgetFlags. + +

TQDialog::~TQDialog () +

+Destroys the TQDialog, deleting all its children. + +

void TQDialog::accept () `[virtual protected slot]` +

+Hides the modal dialog and sets the result code to Accepted. +

void TQDialog::done ( int r ) `[virtual protected slot]` +

Closes the dialog and sets its result code to r. If this dialog +is shown with exec(), done() causes the local event loop to finish, +and exec() to return r. +

As with TQWidget::close(), done() deletes the dialog if the WDestructiveClose flag is set. If the dialog is the application's +main widget, the application terminates. If the dialog is the +last window closed, the TQApplication::lastWindowClosed() signal is +emitted. +

See also accept(), reject(), TQApplication::mainWidget(), and TQApplication::tquit(). + +

int TQDialog::exec () `[slot]` +

+Shows the dialog as a modal dialog, +blocking until the user closes it. The function returns a DialogCode result. +

Users cannot interact with any other window in the same +application until they close the dialog. +

TQWidget * TQDialog::extension () const +

+Returns the dialog's extension or 0 if no extension has been +defined. +

bool TQDialog::isModal () const +

Returns TRUE if show() should pop up the dialog as modal or modeless; otherwise returns FALSE. +See the "modal" property for details. +

bool TQDialog::isSizeGripEnabled () const +

Returns TRUE if the size grip is enabled; otherwise returns FALSE. +See the "sizeGripEnabled" property for details. +

Orientation TQDialog::orientation () const +

+Returns the dialog's extension orientation. +

void TQDialog::reject () `[virtual protected slot]` +

+Hides the modal dialog and sets the result code to Rejected. +

int TQDialog::result () const +

+ +

Returns the modal dialog's result code, Accepted or Rejected. +

Do not call this function if the dialog was constructed with the WDestructiveClose flag. + +

void TQDialog::setExtension ( TQWidget * extension ) +

+Sets the widget, extension, to be the dialog's extension, +deleting any previous extension. The dialog takes ownership of the +extension. Note that if 0 is passed any existing extension will be +deleted. +

This function must only be called while the dialog is hidden. +

See also showExtension(), setOrientation(), and extension(). + +

void TQDialog::setModal ( bool modal ) +

Sets whether show() should pop up the dialog as modal or modeless to modal. +See the "modal" property for details. +

void TQDialog::setOrientation ( Orientation orientation ) +

+If orientation is Horizontal, the extension will be displayed +to the right of the dialog's main area. If orientation is Vertical, the extension will be displayed below the dialog's main +area. +

See also orientation() and setExtension(). + +

void TQDialog::setResult ( int i ) `[protected]` +

+ +

Sets the modal dialog's result code to i. + +

void TQDialog::setSizeGripEnabled ( bool ) +

Sets whether the size grip is enabled. +See the "sizeGripEnabled" property for details. +

void TQDialog::show () `[virtual]` +

+Shows the dialog as a modeless dialog. +Control returns immediately to the calling code. +

The dialog will be modal or modeless according to the value +of the modal property. +

void TQDialog::showExtension ( bool showIt ) `[protected slot]` +

+If showIt is TRUE, the dialog's extension is shown; otherwise the +extension is hidden. +

This slot is usually connected to the TQButton::toggled() signal +of a TQPushButton. +

A dialog with a visible extension is not resizeable. +

See also show(), setExtension(), and setOrientation(). + +

Property Documentation

bool modal

This property holds whether show() should pop up the dialog as modal or modeless. +

By default, this property is false and show() pops up the dialog as +modeless. +

exec() ignores the value of this property and always pops up the +dialog as modal. +

bool sizeGripEnabled

This property holds whether the size grip is enabled. +

A TQSizeGrip is placed in the bottom right corner of the dialog when this +property is enabled. By default, the size grip is disabled. + +

Set this property's value with setSizeGripEnabled() and get this property's value with isSizeGripEnabled(). + +

+ +

Trademarks +

TQt 3.3.8

+ -- cgit v1.2.1