---

KProgressDialog Class Reference

A dialog with a progress bar. More...

#include <kprogress.h>

Inheritance diagram for KProgressDialog:

List of all members.

Public Methods
	KProgressDialog (QWidget *parent=0, const char *name=0, const QString &caption=QString::null, const QString &text=QString::null, bool modal=false)
	~KProgressDialog ()
KProgress *	progressBar ()
void	setLabel (const QString &)
QString	labelText ()
void	setAllowCancel (bool allowCancel)
bool	allowCancel ()
void	showCancelButton (bool show)
void	setAutoClose (bool close)
bool	autoClose ()
void	setAutoReset (bool autoReset)
bool	autoReset ()
bool	wasCancelled ()
void	setButtonText (const QString &)
QString	buttonText ()
void	setMinimumDuration (int ms)
int	minimumDuration ()
Protected Slots
void	slotCancel ()
Protected Methods
virtual void	virtual_hook (int id, void *data)

---

Detailed Description

A dialog with a progress bar.

KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a KDE look 'n feel.

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

KProgressDialog::KProgressDialog (  QWidget *    parent = 0, const char *    name = 0, const QString &    caption = QString::null, const QString &    text = QString::null, bool    modal = false )

Constructs a KProgressDialog Parameters: parent  Parent of the widget name  Widget name caption  Text to display in window title bar text  Text to display in the dialog modal  Set to true to make the dialog modal

KProgressDialog::~KProgressDialog (    )

Desctructor

---

Member Function Documentation

bool KProgressDialog::allowCancel (    )

Returns true if the dialog can be cancelled, false otherwise

bool KProgressDialog::autoClose (    )

Returns true if the dialog will close upon completion, or false otherwise

bool KProgressDialog::autoReset (    )

Returns true if the KProgress widget will be reset upon completion, or false otherwise

QString KProgressDialog::buttonText (    )

Returns the text on the cancel button

QString KProgressDialog::labelText (    )

Returns the current dialog text

int KProgressDialog::minimumDuration (    )

Returns the wait duration in milliseconds

KProgress* KProgressDialog::progressBar (    )

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.

void KProgressDialog::setAllowCancel (  bool    allowCancel )

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. Parameters: allowCancel  Set to true to make the dialog non-closable

void KProgressDialog::setAutoClose (  bool    close )

Sets whether the dialog should close automagically when all the steps in the KProgress have been completed.

void KProgressDialog::setAutoReset (  bool    autoReset )

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.

void KProgressDialog::setButtonText (  const QString &    )

Sets the text to appear on the cancel button.

void KProgressDialog::setLabel (  const QString &    )

Sets the text in the dialog Parameters: text  the text to display

void KProgressDialog::setMinimumDuration (  int    ms )

Set the minimum number of milliseconds to wait before actually showing the dialog

void KProgressDialog::showCancelButton (  bool    show )

Sets whether the cancel button is visible. setAllowCancel(false) implies showCancelButton(false) Parameters: show  Whether or not the cancel button should be shown

void KProgressDialog::slotCancel (    )  [protected, virtual, slot]

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.

bool KProgressDialog::wasCancelled (    )

Returns true if the dialog was closed or cancelled before completion. If the dialog is not cancellable it will always return false.

---

The documentation for this class was generated from the following file:

• kprogress.h

---