Home · All Classes · Grouped Classes · Annotated · Functions

QWaitWidget Class Reference

The QWaitWidget class provides an informative idle screen for a slow operation. More...

    #include <QWaitWidget>

Inherits QDialog.

• List of all members, including inherited members

Public Functions

• QWaitWidget ( QWidget * parent )
• void hide ()
• void setCancelEnabled ( bool enabled )
• void setColor ( const QColor & col )
• void setExpiryTime ( int msec )
• void setText ( const QString & label )
• void show ()
• bool wasCancelled () const

• 9 public functions inherited from QDialog
• 258 public functions inherited from QWidget
• 37 public functions inherited from QObject
• 20 public functions inherited from QPaintDevice

Signals

• void cancelled ()

• 3 signals inherited from QDialog
• 1 signal inherited from QWidget
• 1 signal inherited from QObject

Additional Inherited Members

• 2 properties inherited from QDialog
• 55 properties inherited from QWidget
• 1 property inherited from QObject
• 5 public slots inherited from QDialog
• 20 public slots inherited from QWidget
• 1 public slot inherited from QObject
• 1 public type inherited from QObject
• 5 static public members inherited from QWidget
• 4 static public members inherited from QObject
• 13 static public members inherited from QPaintDevice
• 39 protected functions inherited from QWidget
• 8 protected functions inherited from QObject
• 1 protected function inherited from QPaintDevice
• 1 protected slot inherited from QWidget
• 2 protected variables inherited from QObject
• 1 protected type inherited from QPaintDevice
• 1 static protected member inherited from QObject

Detailed Description

The QWaitWidget class provides an informative idle screen for a slow operation.

A wait widget is used to give the user an indication that an operation is going to take some time, and to demonstrate that the application has not frozen. It can also give the user an opportunity to abort the operation when setCancelEnabled() is set to be true.

For example, construct a QWaitWidget to popup over parent.

    QWaitWidget *waitWidget = new QWaitWidget(this);
    waitWidget->show();
    // do time consuming operations
    delete waitWidget;

Use setText() and setCancelEnabled() to give more feedback and control to the user. For example,

    QWaitWidget *waitWidget = new QWaitWidget(this);
    waitWidget->setCancelEnabled( true );
    waitWidget->setText( "Searching..." );
    waitWidget->show();

    QDir dir = QDir::current();
    QFileInfoList list = dir.entryInfoList();
    int totalSize = 0;

    for ( int i = 0; i < dir.count(); i++ ) {
        totalSize += list.at( i ).size();
       waitWidget->setText( QString( "Size: %1 bytes" ).arg( QString::number(totalSize) ) );
    }
    waitWidget->hide();

The wait widget, in this example, emits a signal cancelled() when the user presses the Cancel button.

Member Function Documentation

QWaitWidget::QWaitWidget ( QWidget * parent )

Constructs an QWaitWidget object with the given parent.

void QWaitWidget::cancelled ()   [signal]

This signal is emitted whenever the wait widget dialog is cancelled by user.

void QWaitWidget::hide ()

Hides the widget and its child widgets.

void QWaitWidget::setCancelEnabled ( bool enabled )

Sets whether the Cancel button appears on the context menu to enabled. When the Cancel button is presed the signal cancelled() is emitted.

See also cancelled().

void QWaitWidget::setColor ( const QColor & col )

Blends the image with color col.

void QWaitWidget::setExpiryTime ( int msec )

Hides the widget after msec.

void QWaitWidget::setText ( const QString & label )

Sets the informative text label for this wait widget.

void QWaitWidget::show ()

Shows the widget and its child widgets. The widget is shown maximized.

bool QWaitWidget::wasCancelled () const

Returns whether the widget was cancelled by the user when it was last shown.