Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QWaitWidget Class Reference
[QtBaseModule]

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

    #include <QWaitWidget>

Inherits QDialog.

• List of all members, including inherited members

Properties

• cancelEnabled : bool
• wasCancelled : const bool

• 2 properties inherited from QDialog
• 57 properties inherited from QWidget
• 1 property inherited from QObject

Public Functions

• QWaitWidget ( QWidget * parent = 0 )
• ~QWaitWidget ()
• bool wasCancelled () const

• 5 public functions inherited from QDialog
• 206 public functions inherited from QWidget
• 29 public functions inherited from QObject
• 14 public functions inherited from QPaintDevice

Public Slots

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

• 4 public slots inherited from QDialog
• 19 public slots inherited from QWidget
• 1 public slot inherited from QObject

Signals

• void cancelled ()

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

Additional Inherited Members

• 1 public type inherited from QObject
• 4 static public members inherited from QWidget
• 4 static public members inherited from QObject
• 38 protected functions inherited from QWidget
• 7 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

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.

Property Documentation

cancelEnabled : bool

This property holds indicates whether the Cancel button appears on the context menu.

Access functions:

• void setCancelEnabled ( bool enabled )

wasCancelled : const bool

This property holds indicates whether the widget was cancelled by the user when it was last shown.

Access functions:

• bool wasCancelled () const

Member Function Documentation

QWaitWidget::QWaitWidget ( QWidget * parent = 0 )

Constructs an QWaitWidget object with the given parent.

QWaitWidget::~QWaitWidget ()

Destroys a QWaitWidget

void QWaitWidget::cancelled ()   [signal]

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

void QWaitWidget::hide ()   [slot]

Hides the widget and its child widgets.

void QWaitWidget::setColor ( const QColor & col )   [slot]

Blends the image with color col.

void QWaitWidget::setExpiryTime ( int msec )   [slot]

Hides the widget after msec.

void QWaitWidget::setText ( const QString & label )   [slot]

Sets the informative text label for this wait widget.

void QWaitWidget::show ()   [slot]

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