libkdegames
KGameProgress Class Reference
A progress indicator widget. More...
#include <kgameprogress.h>
Inherits TQFrame, and QRangeControl.
Public Types | |
enum | BarStyle { Solid, Blocked } |
Public Slots | |
void | setFormat (const TQString &format) |
void | setValue (int value) |
void | advance (int prog) |
Signals | |
void | percentageChanged (int) |
Public Member Functions | |
KGameProgress (TQWidget *parent=0, const char *name=0) | |
KGameProgress (Orientation orient, TQWidget *parent=0, const char *name=0) | |
KGameProgress (int minValue, int maxValue, int value, Orientation, TQWidget *parent=0, const char *name=0) | |
~KGameProgress () | |
void | setBarStyle (BarStyle style) |
void | setBarColor (const TQColor &) |
void | setBarPixmap (const TQPixmap &) |
void | setOrientation (Orientation) |
void | setTextEnabled (bool) |
BarStyle | barStyle () const |
const TQColor & | barColor () const |
const TQPixmap * | barPixmap () const |
int | value () const |
Orientation | orientation () const |
bool | textEnabled () const |
virtual TQSize | sizeHint () const |
virtual TQSize | minimumSizeHint () const |
virtual TQSizePolicy | sizePolicy () const |
TQString | format () const |
Protected Member Functions | |
void | valueChange () |
void | rangeChange () |
void | styleChange (TQStyle &) |
void | paletteChange (const TQPalette &) |
void | drawContents (TQPainter *) |
Properties | |
int | value |
BarStyle | barStyle |
TQColor | barColor |
TQPixmap | barPixmap |
Orientation | orientation |
bool | textEnabled |
Detailed Description
A progress indicator widget.KGameProgress is derived from TQFrame and TQRangeControl, so you can use all the methods from those classes. The only difference is that setValue() is now made a slot, so you can connect stuff to it.
None of the constructors take line step and page step as arguments, so by default they're set to 1 and 10 respectively.
The Blocked style ignores the textEnabled() setting and displays no text, since it looks truly ugly (and for other reasons). Signal percentageChanged() is emitted whenever the value changes so you can set up a different widget to display the current percentage complete and connect the signal to it.
- Version:
- Id
- kgameprogress.h 1157643 2010-07-31 19:42:31Z tpearson
Definition at line 50 of file kgameprogress.h.
Member Enumeration Documentation
Possible values for bar style.
Solid
means one continuous progress bar, Blocked
means a progress bar made up of several blocks.
Definition at line 68 of file kgameprogress.h.
Constructor & Destructor Documentation
KGameProgress::KGameProgress | ( | TQWidget * | parent = 0 , |
|
const char * | name = 0 | |||
) |
Construct a horizontal progress bar.
KGameProgress -- a progress indicator widget for KDE.
Definition at line 32 of file kgameprogress.cpp.
KGameProgress::KGameProgress | ( | Orientation | orient, | |
TQWidget * | parent = 0 , |
|||
const char * | name = 0 | |||
) |
KGameProgress::KGameProgress | ( | int | minValue, | |
int | maxValue, | |||
int | value, | |||
Orientation | orientation, | |||
TQWidget * | parent = 0 , |
|||
const char * | name = 0 | |||
) |
Construct a progress bar with minimum, maximum and initial values.
Definition at line 48 of file kgameprogress.cpp.
KGameProgress::~KGameProgress | ( | ) |
Member Function Documentation
void KGameProgress::setBarStyle | ( | BarStyle | style | ) |
Set the progress bar style.
Allowed values are Solid
and Blocked
.
Definition at line 113 of file kgameprogress.cpp.
void KGameProgress::setBarColor | ( | const TQColor & | color | ) |
void KGameProgress::setBarPixmap | ( | const TQPixmap & | pixmap | ) |
void KGameProgress::setOrientation | ( | Orientation | orientation | ) |
Set the orientation of the progress bar.
Allowed values are Horizontal
and Vertical
.
Definition at line 121 of file kgameprogress.cpp.
void KGameProgress::setTextEnabled | ( | bool | enable | ) |
If this is set to true
, the progress text will be displayed.
Definition at line 134 of file kgameprogress.cpp.
BarStyle KGameProgress::barStyle | ( | ) | const |
const TQColor& KGameProgress::barColor | ( | ) | const |
const TQPixmap* KGameProgress::barPixmap | ( | ) | const |
int KGameProgress::value | ( | ) | const [inline] |
Orientation KGameProgress::orientation | ( | ) | const |
bool KGameProgress::textEnabled | ( | ) | const |
TQString KGameProgress::format | ( | ) | const |
Retrieve the current format for printing status text.
- See also:
- setFormat()
Definition at line 340 of file kgameprogress.cpp.
void KGameProgress::setFormat | ( | const TQString & | format | ) | [slot] |
Set the format of the text to use to display status.
The default format is "%p%" (which looks like "42%".)
- Parameters:
-
format p is replaced by percentage done, v is replaced by actual value, m is replaced by the maximum value.
Definition at line 335 of file kgameprogress.cpp.
void KGameProgress::setValue | ( | int | value | ) | [slot] |
Set the current value of the progress bar to value
.
This must be a number in the range 0..100.
Definition at line 129 of file kgameprogress.cpp.
void KGameProgress::advance | ( | int | prog | ) | [slot] |
Advance the progress bar by prog
.
This method is provided for convenience and is equivalent with setValue(value()+prog).
Definition at line 62 of file kgameprogress.cpp.
void KGameProgress::percentageChanged | ( | int | ) | [signal] |
Emitted when the state of the progress bar changes.
The documentation for this class was generated from the following files: