KProgressDialog Class Reference
KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a KDE look 'n feel. A dialog with a progress bar. More...
#include <kprogress.h>
Inheritance diagram for KProgressDialog:

Public Methods | |
KProgressDialog (QWidget *parent=0, const char *name=0, const QString &caption=QString::null, const QString &text=QString::null, bool modal=false) | |
Constructs a KProgressDialog. | |
~KProgressDialog () | |
Desctructor. | |
KProgress * | progressBar () |
Returns the KProgress used in this dialog. | |
void | setLabel (const QString &) |
Sets the text in the dialog. | |
QString | labelText () |
Returns the current dialog text. | |
void | setAllowCancel (bool allowCancel) |
Sets whether or not the user can cancel the process. | |
bool | allowCancel () |
Returns true if the dialog can be cancelled, false otherwise. | |
void | showCancelButton (bool show) |
Sets whether the cancel button is visible. | |
void | setAutoClose (bool close) |
Sets whether the dialog should close automagically when all the steps in the KProgress have been completed. | |
bool | autoClose () |
Returns true if the dialog will close upon completion, or false otherwise. | |
void | setAutoReset (bool autoReset) |
Sets whether the dialog should reset the KProgress dialog back to 0 steps compelete when all steps have been completed. | |
bool | autoReset () |
Returns true if the KProgress widget will be reset upon completion, or false otherwise. | |
bool | wasCancelled () |
Returns true if the dialog was closed or cancelled before completion. | |
void | setButtonText (const QString &) |
Sets the text to appear on the cancel button. | |
QString | buttonText () |
Returns the text on the cancel button. | |
void | setMinimumDuration (int ms) |
Set the minimum number of milliseconds to wait before actually showing the dialog. | |
int | minimumDuration () |
Returns the wait duration in milliseconds. | |
Protected Slots | |
void | slotCancel () |
Activated when the Cancel button has been clicked. | |
Protected Methods | |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a KDE look 'n feel. A dialog with a progress bar.Since knowing how long it can take to complete an action and it is undesireable to show a dialog for a split second before hiding it, there are a few ways to control the timing behavior of KProgressDialog. There is a time out that can be set before showing the dialog as well as an option to autohide or keep displaying the dialog once complete.
All the functionality of KProgress is available through direct access to the progress bar widget via progressBar();
- Author:
- Aaron J. Seigo
Definition at line 183 of file kprogress.h.
Constructor & Destructor Documentation
|
Constructs a KProgressDialog.
Definition at line 147 of file kprogress.cpp. References KDialogBase::actionButton(), KDialogBase::mainWidget(), KDialogBase::plainPage(), KWin::setIcons(), KDialogBase::showButton(), QTimer::start(), and QPushButton::text(). |
|
Desctructor.
Definition at line 180 of file kprogress.cpp. |
Member Function Documentation
|
Returns the KProgress used in this dialog. To set the number of steps or other progress bar related settings, access the KProgress object directly via this method. Definition at line 237 of file kprogress.cpp. |
|
Sets the text in the dialog.
Definition at line 242 of file kprogress.cpp. References QLabel::setText(). |
|
Returns the current dialog text.
Definition at line 247 of file kprogress.cpp. References QLabel::text(). |
|
Sets whether or not the user can cancel the process. If the dialog is cancellable, the Cancel button will be shown and the user can close the window using the window decorations. If the process is not (or should not be) interuptable, set the dialog to be modal and not cancellable.
Definition at line 226 of file kprogress.cpp. References allowCancel(), and showCancelButton(). |
|
Returns true if the dialog can be cancelled, false otherwise.
Definition at line 232 of file kprogress.cpp. Referenced by setAllowCancel(). |
|
Sets whether the cancel button is visible. setAllowCancel(false) implies showCancelButton(false)
Definition at line 252 of file kprogress.cpp. References QDialog::show(), and KDialogBase::showButtonCancel(). Referenced by setAllowCancel(). |
|
Sets whether the dialog should close automagically when all the steps in the KProgress have been completed.
Definition at line 262 of file kprogress.cpp. References autoClose(). |
|
Returns true if the dialog will close upon completion, or false otherwise.
Definition at line 257 of file kprogress.cpp. Referenced by setAutoClose(). |
|
Sets whether the dialog should reset the KProgress dialog back to 0 steps compelete when all steps have been completed. This is useful for KProgressDialogs that will be reused. Definition at line 272 of file kprogress.cpp. References autoReset(). |
|
Returns true if the KProgress widget will be reset upon completion, or false otherwise.
Definition at line 267 of file kprogress.cpp. Referenced by setAutoReset(). |
|
Returns true if the dialog was closed or cancelled before completion. If the dialog is not cancellable it will always return false. Definition at line 206 of file kprogress.cpp. |
|
Sets the text to appear on the cancel button.
Definition at line 277 of file kprogress.cpp. References KDialogBase::setButtonCancelText(). |
|
Returns the text on the cancel button.
Definition at line 283 of file kprogress.cpp. |
|
Set the minimum number of milliseconds to wait before actually showing the dialog.
Definition at line 211 of file kprogress.cpp. References QTimer::start(), and QTimer::stop(). |
|
Returns the wait duration in milliseconds.
Definition at line 221 of file kprogress.cpp. |
|
Activated when the Cancel button has been clicked. The QDialog::reject() is activated in regular mode and QDialog::done( Cancel ) when in message box mode. Reimplemented from KDialogBase. Definition at line 196 of file kprogress.cpp. References KDialogBase::slotCancel(). |
The documentation for this class was generated from the following files: