.TH "KProgress" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KProgress \- A stylized progress bar. 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
.RI "\fISet the format of the text to use to display status. \fP"
.ti -1c
.RI "void \fBsetTotalSteps\fP (int \fBtotalSteps\fP)"
.br
.RI "\fISet the current total number of steps in the action tat the progress bar is representing. \fP"
.ti -1c
.RI "virtual void \fBsetProgress\fP (int \fBprogress\fP)"
.br
.RI "\fISet the current value of the progress bar to \fCvalue\fP. \fP"
.ti -1c
.RI "void \fBsetValue\fP (int \fBprogress\fP)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP. \fP"
.ti -1c
.RI "virtual void \fBadvance\fP (int offset)"
.br
.RI "\fIAdvance the progress bar by \fCprog\fP. \fP"
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpercentageChanged\fP (int)"
.br
.RI "\fIEmitted when the state of the progress bar changes. \fP"
.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
.RI "\fIConstruct a progress bar. \fP"
.ti -1c
.RI "\fBKProgress\fP (int \fBtotalSteps\fP, \fBQWidget\fP *parent=0, const  char *name=0, WFlags f=0)"
.br
.RI "\fIConstruct a progress bar with a total number of steps. \fP"
.ti -1c
.RI "\fB~KProgress\fP ()"
.br
.RI "\fIDestruct the progress bar. \fP"
.ti -1c
.RI "void \fBsetTextEnabled\fP (bool)"
.br
.RI "\fIIf this is set to \fCtrue\fP, the progress text will be displayed. \fP"
.ti -1c
.RI "int \fBvalue\fP () const "
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP Retrieves the current status, use \fBprogress()\fP instead \fP"
.ti -1c
.RI "bool \fBtextEnabled\fP () const "
.br
.RI "\fIReturns \fCtrue\fP if progress text will be displayed, \fCfalse\fP otherwise. \fP"
.ti -1c
.RI "\fBQString\fP \fBformat\fP () const "
.br
.RI "\fIRetrieve the current format for printing status text. \fP"
.ti -1c
.RI "void \fBsetRange\fP (int min, int max)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP but kept for source compatibility with KDE2's KProgress. \fP"
.ti -1c
.RI "int \fBmaxValue\fP ()"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP used \fBtotalSteps\fP() instead \fP"
.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 stylized progress bar. 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
\fB Details\fP
.PP
\fB\fP
.PP
\fB
.PP
\fBAuthor:\fP
.RS 4
Aaron Seigo 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBkprogress.h\fP,v 1.31 2002/05/21 16:55:30 tjansen Exp 
.RE
.PP
.RE
.PP
\fP
.PP
Definition at line 46 of file kprogress.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KProgress::KProgress (\fBQWidget\fP * parent = 0, const char * name = 0, WFlags f = 0)"
.PP
Construct a progress bar. Definition at line 40 of file kprogress.cpp.
.PP
References KStdAccel::name(), and setProgress().
.SS "KProgress::KProgress (int totalSteps, \fBQWidget\fP * parent = 0, const char * name = 0, WFlags f = 0)"
.PP
Construct a progress bar with a total number of steps. 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. Definition at line 47 of file kprogress.cpp.
.PP
References KStdAccel::name(), and setProgress().
.SS "KProgress::~\fBKProgress\fP ()"
.PP
Destruct the progress bar. Definition at line 54 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. Definition at line 98 of file kprogress.cpp.
.PP
References QProgressBar::setPercentageVisible().
.SS "int KProgress::value () const"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP Retrieves the current status, use \fBprogress()\fP instead \fBSee also:\fP
.RS 4
\fBsetValue()\fP 
.RE
.PP
Definition at line 118 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. \fBSee also:\fP
.RS 4
\fBsetFormat()\fP 
.RE
.PP
Definition at line 103 of file kprogress.cpp.
.PP
References QProgressBar::percentageVisible().
.SS "\fBQString\fP KProgress::format () const"
.PP
Retrieve the current format for printing status text. \fBSee also:\fP
.RS 4
\fBsetFormat()\fP 
.RE
.PP
Definition at line 113 of file kprogress.cpp.
.SS "void KProgress::setRange (int min, int max)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP but kept for source compatibility with KDE2's KProgress. Use \fBsetTotalSteps\fP() instead Definition at line 88 of file kprogress.cpp.
.PP
References setTotalSteps().
.SS "int KProgress::maxValue ()"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP used \fBtotalSteps\fP() instead Definition at line 93 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. The default format is '%p%' (which looks like '42%'.)
.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
Definition at line 108 of file kprogress.cpp.
.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. Reimplemented from \fBQProgressBar\fP.
.PP
Definition at line 63 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 \fCvalue\fP. Reimplemented from \fBQProgressBar\fP.
.PP
Definition at line 73 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
\fBThis class or method is obsolete, it is provided for compatibility only.\fP. Use \fBsetProgress\fP(int) instead Definition at line 83 of file kprogress.cpp.
.PP
References setProgress().
.SS "void KProgress::advance (int offset)\fC [virtual, slot]\fP"
.PP
Advance the progress bar by \fCprog\fP. This method is provided for convenience and is equivalent with \fBsetValue\fP(\fBvalue()\fP+prog). Definition at line 58 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. Referenced by setProgress(), and setTotalSteps().

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