.TH "KProgressDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KProgressDialog \- KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a \fBKDE\fP look 'n feel. A dialog with a progress bar.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kprogress.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKProgressDialog\fP (\fBQWidget\fP *parent=0, const char *name=0, const \fBQString\fP &caption=QString::null, const \fBQString\fP &text=QString::null, bool modal=false)"
.br
.ti -1c
.RI "\fB~KProgressDialog\fP ()"
.br
.ti -1c
.RI "\fBKProgress\fP * \fBprogressBar\fP ()"
.br
.ti -1c
.RI "const \fBKProgress\fP * \fBprogressBar\fP () const "
.br
.ti -1c
.RI "void \fBsetLabel\fP (const \fBQString\fP &text)"
.br
.ti -1c
.RI "\fBQString\fP \fBlabelText\fP () KDE_DEPRECATED"
.br
.ti -1c
.RI "\fBQString\fP \fBlabelText\fP () const "
.br
.ti -1c
.RI "void \fBsetAllowCancel\fP (bool allowCancel)"
.br
.ti -1c
.RI "bool \fBallowCancel\fP () KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBallowCancel\fP () const "
.br
.ti -1c
.RI "void \fBshowCancelButton\fP (bool \fBshow\fP)"
.br
.ti -1c
.RI "void \fBsetAutoClose\fP (bool close)"
.br
.ti -1c
.RI "bool \fBautoClose\fP ()"
.br
.ti -1c
.RI "bool \fBautoClose\fP () const "
.br
.ti -1c
.RI "void \fBsetAutoReset\fP (bool autoReset)"
.br
.ti -1c
.RI "bool \fBautoReset\fP ()"
.br
.ti -1c
.RI "bool \fBautoReset\fP () const "
.br
.ti -1c
.RI "bool \fBwasCancelled\fP ()"
.br
.ti -1c
.RI "bool \fBwasCancelled\fP () const "
.br
.ti -1c
.RI "void \fBsetButtonText\fP (const \fBQString\fP &)"
.br
.ti -1c
.RI "\fBQString\fP \fBbuttonText\fP () KDE_DEPRECATED"
.br
.ti -1c
.RI "\fBQString\fP \fBbuttonText\fP () const "
.br
.ti -1c
.RI "void \fBsetMinimumDuration\fP (int ms)"
.br
.ti -1c
.RI "int \fBminimumDuration\fP () KDE_DEPRECATED"
.br
.ti -1c
.RI "int \fBminimumDuration\fP () const "
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotAutoShow\fP ()"
.br
.ti -1c
.RI "void \fBslotAutoActions\fP (int percentage)"
.br
.ti -1c
.RI "void \fBslotCancel\fP ()"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
KProgressDialog provides a dialog with a text label, a progress bar and an optional cancel button with a \fBKDE\fP look 'n feel. A dialog with a progress bar. 

Since knowing how long it can take to complete an action and it is undesirable 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.
.PP
All the functionality of \fBKProgress\fP is available through direct access to the progress bar widget via \fBprogressBar()\fP;
.PP
\fBAuthor:\fP
.RS 4
Aaron J. Seigo 
.RE
.PP

.PP
Definition at line 187 of file kprogress.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KProgressDialog::KProgressDialog (\fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, const \fBQString\fP & caption = \fCQString::null\fP, const \fBQString\fP & text = \fCQString::null\fP, bool modal = \fCfalse\fP)"
.PP
Constructs a KProgressDialog. 
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP Parent of the widget 
.br
\fIname\fP Widget name 
.br
\fIcaption\fP Text to display in window title bar 
.br
\fItext\fP Text to display in the dialog 
.br
\fImodal\fP Set to true to make the dialog modal 
.RE
.PP

.PP
Definition at line 169 of file kprogress.cpp.
.PP
References KDialogBase::actionButton(), KDialogBase::plainPage(), KDialogBase::showButton(), QTimer::start(), and QPushButton::text().
.SS "KProgressDialog::~\fBKProgressDialog\fP ()"
.PP
Destructor. 
.PP
Definition at line 205 of file kprogress.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKProgress\fP * KProgressDialog::progressBar ()"
.PP
Returns the \fBKProgress\fP used in this dialog. 
.PP
To set the number of steps or other progress bar related settings, access the \fBKProgress\fP object directly via this method. 
.PP
Definition at line 279 of file kprogress.cpp.
.SS "const \fBKProgress\fP * KProgressDialog::progressBar () const"
.PP
Returns the \fBKProgress\fP used in this dialog. 
.PP
To set the number of steps or other progress bar related settings, access the \fBKProgress\fP object directly via this method. 
.PP
Definition at line 284 of file kprogress.cpp.
.SS "void KProgressDialog::setLabel (const \fBQString\fP & text)"
.PP
Sets the text in the dialog. 
.PP
\fBParameters:\fP
.RS 4
\fItext\fP the text to display 
.RE
.PP

.PP
Definition at line 289 of file kprogress.cpp.
.PP
References QLabel::setText().
.SS "\fBQString\fP KProgressDialog::labelText ()"
.PP
Returns the current dialog text. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 295 of file kprogress.cpp.
.PP
References QLabel::text().
.SS "\fBQString\fP KProgressDialog::labelText () const"
.PP
Returns the current dialog text. 
.PP
Definition at line 300 of file kprogress.cpp.
.PP
References QLabel::text().
.SS "void KProgressDialog::setAllowCancel (bool allowCancel)"
.PP
Sets whether or not the user can cancel the process. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIallowCancel\fP Set to true to make the dialog non-closable 
.RE
.PP

.PP
Definition at line 262 of file kprogress.cpp.
.PP
References showCancelButton().
.SS "bool KProgressDialog::allowCancel ()"
.PP
Returns true if the dialog can be canceled, false otherwise. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 269 of file kprogress.cpp.
.SS "bool KProgressDialog::allowCancel () const"
.PP
Returns true if the dialog can be canceled, false otherwise. 
.PP
Definition at line 274 of file kprogress.cpp.
.SS "void KProgressDialog::showCancelButton (bool show)"
.PP
Sets whether the cancel button is visible. 
.PP
setAllowCancel(false) implies showCancelButton(false)
.PP
\fBParameters:\fP
.RS 4
\fIshow\fP Whether or not the cancel button should be shown 
.RE
.PP

.PP
Definition at line 305 of file kprogress.cpp.
.PP
References KDialogBase::showButtonCancel().
.PP
Referenced by setAllowCancel().
.SS "void KProgressDialog::setAutoClose (bool close)"
.PP
Sets whether the dialog should close automagically when all the steps in the \fBKProgress\fP have been completed. 
.PP
Definition at line 321 of file kprogress.cpp.
.SS "bool KProgressDialog::autoClose ()"
.PP
Returns true if the dialog will close upon completion, or false otherwise. 
.PP
Definition at line 311 of file kprogress.cpp.
.SS "bool KProgressDialog::autoClose () const"
.PP
Returns true if the dialog will close upon completion, or false otherwise. 
.PP
Definition at line 316 of file kprogress.cpp.
.SS "void KProgressDialog::setAutoReset (bool autoReset)"
.PP
Sets whether the dialog should reset the \fBKProgress\fP dialog back to 0 steps compelete when all steps have been completed. 
.PP
This is useful for KProgressDialogs that will be reused. 
.PP
Definition at line 337 of file kprogress.cpp.
.SS "bool KProgressDialog::autoReset ()"
.PP
Returns true if the \fBKProgress\fP widget will be reset upon completion, or false otherwise. 
.PP
Definition at line 327 of file kprogress.cpp.
.SS "bool KProgressDialog::autoReset () const"
.PP
Returns true if the \fBKProgress\fP widget will be reset upon completion, or false otherwise. 
.PP
Definition at line 332 of file kprogress.cpp.
.SS "bool KProgressDialog::wasCancelled ()"
.PP
Returns true if the dialog was closed or canceled before completion. 
.PP
If the dialog is not cancellable it will always return false. 
.PP
Definition at line 232 of file kprogress.cpp.
.SS "bool KProgressDialog::wasCancelled () const"
.PP
Returns true if the dialog was closed or canceled before completion. 
.PP
If the dialog is not cancellable it will always return false. 
.PP
Definition at line 237 of file kprogress.cpp.
.SS "void KProgressDialog::setButtonText (const \fBQString\fP &)"
.PP
Sets the text to appear on the cancel button. 
.PP
Definition at line 342 of file kprogress.cpp.
.PP
References KDialogBase::setButtonCancel().
.SS "\fBQString\fP KProgressDialog::buttonText ()"
.PP
Returns the text on the cancel button. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 349 of file kprogress.cpp.
.SS "\fBQString\fP KProgressDialog::buttonText () const"
.PP
Returns the text on the cancel button. 
.PP
Definition at line 354 of file kprogress.cpp.
.SS "void KProgressDialog::setMinimumDuration (int ms)"
.PP
Set the minimum number of milliseconds to wait before actually showing the dialog. 
.PP
Definition at line 242 of file kprogress.cpp.
.PP
References QTimer::start(), and QTimer::stop().
.SS "int KProgressDialog::minimumDuration ()"
.PP
Returns the wait duration in milliseconds. 
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 252 of file kprogress.cpp.
.SS "int KProgressDialog::minimumDuration () const"
.PP
Returns the wait duration in milliseconds. 
.PP
Definition at line 257 of file kprogress.cpp.
.SS "void KProgressDialog::slotCancel ()\fC [protected, virtual, slot]\fP"
.PP
Activated when the Cancel button has been clicked. 
.PP
The \fBQDialog::reject()\fP is activated in regular mode and QDialog::done( Cancel ) when in message box mode. 
.PP
Reimplemented from \fBKDialogBase\fP.
.PP
Definition at line 222 of file kprogress.cpp.
.PP
References KDialogBase::slotCancel().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
