.TH "KProgress" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KProgress \- A progress indicator widget.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kprogress.h>\fP
.PP
Inherits \fBQProgressBar\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBsetFormat\fP (const \fBQString\fP &format)"
.br
.ti -1c
.RI "void \fBsetTotalSteps\fP (int \fBtotalSteps\fP)"
.br
.ti -1c
.RI "virtual void \fBsetProgress\fP (int \fBprogress\fP)"
.br
.ti -1c
.RI "void \fBsetValue\fP (int \fBprogress\fP)"
.br
.ti -1c
.RI "virtual void \fBadvance\fP (int offset)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpercentageChanged\fP (int)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKProgress\fP (\fBQWidget\fP *parent=0, const char *name=0, WFlags f=0)"
.br
.ti -1c
.RI "\fBKProgress\fP (int \fBtotalSteps\fP, \fBQWidget\fP *parent=0, const char *name=0, WFlags f=0)"
.br
.ti -1c
.RI "\fB~KProgress\fP ()"
.br
.ti -1c
.RI "void \fBsetTextEnabled\fP (bool)"
.br
.ti -1c
.RI "int \fBvalue\fP () const KDE_DEPRECATED"
.br
.ti -1c
.RI "bool \fBtextEnabled\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBformat\fP () const "
.br
.ti -1c
.RI "void \fBsetRange\fP (int min, int max) KDE_DEPRECATED"
.br
.ti -1c
.RI "int \fBmaxValue\fP () KDE_DEPRECATED"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual bool \fBsetIndicator\fP (\fBQString\fP &indicator, int \fBprogress\fP, int \fBtotalSteps\fP)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A progress indicator widget. 

KProgress is derived from \fBQProgressBar\fP, so you can use all the methods from that class. The only real difference is that a signal is emitted on changes to the value and you do not need to subclass KProgress just to change the format of the indicator text.
.PP
\fBDetails\fP 
.br
.PP
KDE Progress Widget 
.PP
\fBAuthor:\fP
.RS 4
Aaron Seigo 
.RE
.PP

.PP
Definition at line 46 of file kprogress.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KProgress::KProgress (\fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, WFlags f = \fC0\fP)"
.PP
Construct a progress bar. 
.PP
Definition at line 41 of file kprogress.cpp.
.PP
References setProgress().
.SS "KProgress::KProgress (int totalSteps, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP, WFlags f = \fC0\fP)"
.PP
Construct a progress bar with a total number of steps. 
.PP
The totalSteps is the total number of steps that need to be completed for the operation which this progress bar represents. For example, if the operation is to examine 50 files, this value would be 50. Before examining the first file, call setProgress(0); call setProgress(50) after examining the last file. 
.PP
Definition at line 48 of file kprogress.cpp.
.PP
References setProgress().
.SS "KProgress::~\fBKProgress\fP ()"
.PP
Destruct the progress bar. 
.PP
Definition at line 55 of file kprogress.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KProgress::setTextEnabled (bool)"
.PP
If this is set to \fCtrue\fP, the progress text will be displayed. 
.PP
Definition at line 102 of file kprogress.cpp.
.PP
References QProgressBar::setPercentageVisible().
.SS "int KProgress::value () const"
.PP
\fBDeprecated\fP
.RS 4
Retrieves the current status, use \fBprogress()\fP instead 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetValue()\fP 
.RE
.PP

.PP
Definition at line 125 of file kprogress.cpp.
.PP
References QProgressBar::progress().
.SS "bool KProgress::textEnabled () const"
.PP
Returns \fCtrue\fP if progress text will be displayed, \fCfalse\fP otherwise. 
.PP
\fBSee also:\fP
.RS 4
\fBsetFormat()\fP 
.RE
.PP

.PP
Definition at line 107 of file kprogress.cpp.
.PP
References QProgressBar::percentageVisible().
.SS "\fBQString\fP KProgress::format () const"
.PP
Retrieve the current format for printing status text. 
.PP
\fBSee also:\fP
.RS 4
\fBsetFormat()\fP 
.RE
.PP

.PP
Definition at line 119 of file kprogress.cpp.
.PP
Referenced by setFormat().
.SS "void KProgress::setRange (int min, int max)"
.PP
\fBDeprecated\fP
.RS 4
but kept for source compatibility with KDE2's KProgress. Use \fBsetTotalSteps()\fP instead 
.RE
.PP

.PP
Definition at line 91 of file kprogress.cpp.
.PP
References setTotalSteps().
.SS "int KProgress::maxValue ()"
.PP
\fBDeprecated\fP
.RS 4
Use \fBtotalSteps()\fP instead 
.RE
.PP

.PP
Definition at line 97 of file kprogress.cpp.
.PP
References QProgressBar::totalSteps().
.SS "void KProgress::setFormat (const \fBQString\fP & format)\fC [slot]\fP"
.PP
Set the format of the text to use to display status. 
.PP
The default format is '%p%' (which looks like '42%'.)
.PP
Note: Setting the format to anything other then '%p%' will force centerIndicator to true, since it's often impossible to layout a progressbar with a more general format with the indicator string anywhere else.
.PP
\fBParameters:\fP
.RS 4
\fIformat\fP '%p' is replaced by percentage done, '%v' is replaced by actual value, '%m' is replaced by the maximum value. 
.RE
.PP

.PP
Definition at line 112 of file kprogress.cpp.
.PP
References format(), and QProgressBar::setCenterIndicator().
.SS "void KProgress::setTotalSteps (int totalSteps)\fC [slot]\fP"
.PP
Set the current total number of steps in the action tat the progress bar is representing. 
.PP
Reimplemented from \fBQProgressBar\fP.
.PP
Definition at line 64 of file kprogress.cpp.
.PP
References percentageChanged(), QProgressBar::progress(), and QProgressBar::setTotalSteps().
.PP
Referenced by setRange().
.SS "void KProgress::setProgress (int progress)\fC [virtual, slot]\fP"
.PP
Set the current value of the progress bar to \fCprogress\fP. 
.PP
Reimplemented from \fBQProgressBar\fP.
.PP
Definition at line 74 of file kprogress.cpp.
.PP
References percentageChanged(), QProgressBar::setProgress(), and QProgressBar::totalSteps().
.PP
Referenced by advance(), KProgress(), and setValue().
.SS "void KProgress::setValue (int progress)\fC [slot]\fP"
.PP
\fBDeprecated\fP
.RS 4
Use \fBsetProgress(int)\fP instead 
.RE
.PP

.PP
Definition at line 85 of file kprogress.cpp.
.PP
References setProgress().
.SS "void KProgress::advance (int offset)\fC [virtual, slot]\fP"
.PP
Advance the progress bar by \fCoffset\fP. 
.PP
This method is provided for convenience and is equivalent with setProgress(\fBprogress()\fP+offset). 
.PP
Definition at line 59 of file kprogress.cpp.
.PP
References QProgressBar::progress(), and setProgress().
.SS "void KProgress::percentageChanged (int)\fC [signal]\fP"
.PP
Emitted when the state of the progress bar changes. 
.PP
Referenced by setProgress(), and setTotalSteps().

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