KProgress Class Reference
A stylized progress bar. A progress indicator widget. More...
#include <kprogress.h>
Inheritance diagram for KProgress:

Public Slots | |
void | setFormat (const QString &format) |
Set the format of the text to use to display status. | |
void | setTotalSteps (int totalSteps) |
Set the current total number of steps in the action tat the progress bar is representing. | |
virtual void | setProgress (int progress) |
Set the current value of the progress bar to value . | |
void | setValue (int progress) |
virtual void | advance (int offset) |
Advance the progress bar by prog . | |
Signals | |
void | percentageChanged (int) |
Emitted when the state of the progress bar changes. | |
Public Methods | |
KProgress (QWidget *parent=0, const char *name=0, WFlags f=0) | |
Construct a progress bar. | |
KProgress (int totalSteps, QWidget *parent=0, const char *name=0, WFlags f=0) | |
Construct a progress bar with a total number of steps. | |
~KProgress () | |
Destruct the progress bar. | |
void | setTextEnabled (bool) |
If this is set to true , the progress text will be displayed. | |
int | value () const |
bool | textEnabled () const |
Returns true if progress text will be displayed, false otherwise. | |
QString | format () const |
Retrieve the current format for printing status text. | |
void | setRange (int min, int max) |
int | maxValue () |
Protected Methods | |
virtual bool | setIndicator (QString &indicator, int progress, int totalSteps) |
Detailed Description
A stylized progress bar. A progress indicator widget.KProgress is derived from QProgressBar, 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.
Details
- Author:
- Aaron Seigo
- Version:
- Id:
- kprogress.h,v 1.31 2002/05/21 16:55:30 tjansen Exp
Definition at line 46 of file kprogress.h.
Constructor & Destructor Documentation
|
Construct a progress bar.
Definition at line 39 of file kprogress.cpp. References setProgress(). |
|
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 46 of file kprogress.cpp. References setProgress(). |
|
Destruct the progress bar.
Definition at line 53 of file kprogress.cpp. |
Member Function Documentation
|
If this is set to
Definition at line 97 of file kprogress.cpp. References QProgressBar::setPercentageVisible(). |
|
Definition at line 117 of file kprogress.cpp. References QProgressBar::progress(). |
|
Returns
Definition at line 102 of file kprogress.cpp. References QProgressBar::percentageVisible(). |
|
Retrieve the current format for printing status text.
Definition at line 112 of file kprogress.cpp. |
|
Definition at line 87 of file kprogress.cpp. References setTotalSteps(). |
|
Definition at line 92 of file kprogress.cpp. References QProgressBar::totalSteps(). |
|
Set the format of the text to use to display status. The default format is "p%" (which looks like "42%".)
Definition at line 107 of file kprogress.cpp. |
|
Set the current total number of steps in the action tat the progress bar is representing.
Reimplemented from QProgressBar. Definition at line 62 of file kprogress.cpp. References percentageChanged(), QProgressBar::progress(), QProgressBar::setTotalSteps(), and QProgressBar::totalSteps(). Referenced by setRange(). |
|
Set the current value of the progress bar to
Reimplemented from QProgressBar. Definition at line 72 of file kprogress.cpp. References percentageChanged(), QProgressBar::progress(), QProgressBar::setProgress(), and QProgressBar::totalSteps(). Referenced by advance(), KProgress(), and setValue(). |
|
Definition at line 82 of file kprogress.cpp. References QProgressBar::progress(), and setProgress(). |
|
Advance the progress bar by This method is provided for convenience and is equivalent with setValue(value()+prog). Definition at line 57 of file kprogress.cpp. References QProgressBar::progress(), and setProgress(). |
|
Emitted when the state of the progress bar changes.
Referenced by setProgress(), and setTotalSteps(). |
The documentation for this class was generated from the following files: