KGameProgress Class Reference

#include <kgameprogress.h>

List of all members.


Detailed Description

A progress indicator widget.

KGameProgress is derived from QFrame and QRangeControl, 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.

Author:
Martynas Kunigelis
Version:
Id
kgameprogress.h 465369 2005-09-29 14:33:08Z mueller

Definition at line 50 of file kgameprogress.h.


Public Types

enum  BarStyle { Solid, Blocked }

Public Slots

void setFormat (const QString &format)
void setValue (int value)
void advance (int prog)

Signals

void percentageChanged (int)

Public Member Functions

 KGameProgress (QWidget *parent=0, const char *name=0)
 KGameProgress (Orientation orient, QWidget *parent=0, const char *name=0)
 KGameProgress (int minValue, int maxValue, int value, Orientation, QWidget *parent=0, const char *name=0)
 ~KGameProgress ()
void setBarStyle (BarStyle style)
void setBarColor (const QColor &)
void setBarPixmap (const QPixmap &)
void setOrientation (Orientation)
void setTextEnabled (bool)
BarStyle barStyle () const
const QColor & barColor () const
const QPixmap * barPixmap () const
int value () const
Orientation orientation () const
bool textEnabled () const
virtual QSize sizeHint () const
virtual QSize minimumSizeHint () const
virtual QSizePolicy sizePolicy () const
QString format () const

Protected Member Functions

void valueChange ()
void rangeChange ()
void styleChange (QStyle &)
void paletteChange (const QPalette &)
void drawContents (QPainter *)

Properties

int value []
BarStyle barStyle []
QColor barColor []
QPixmap barPixmap []
Orientation orientation []
bool textEnabled []

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 ( QWidget *  parent = 0,
const char *  name = 0 
)

Construct a horizontal progress bar.

Definition at line 32 of file kgameprogress.cpp.

KGameProgress::KGameProgress ( Orientation  orient,
QWidget *  parent = 0,
const char *  name = 0 
)

Construct a progress bar with orientation orient.

Definition at line 40 of file kgameprogress.cpp.

KGameProgress::KGameProgress ( int  minValue,
int  maxValue,
int  value,
Orientation  ,
QWidget *  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 (  ) 

Destruct the progress bar.

Definition at line 57 of file kgameprogress.cpp.


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 QColor &   ) 

Set the color of the progress bar.

Definition at line 103 of file kgameprogress.cpp.

void KGameProgress::setBarPixmap ( const QPixmap &   ) 

Set a pixmap to be shown in the progress bar.

Definition at line 93 of file kgameprogress.cpp.

void KGameProgress::setOrientation ( 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   ) 

If this is set to true, the progress text will be displayed.

Definition at line 134 of file kgameprogress.cpp.

BarStyle KGameProgress::barStyle (  )  const

Retrieve the bar style.

See also:
setBarStyle()

const QColor& KGameProgress::barColor (  )  const

Retrieve the bar color.

See also:
setBarColor()

const QPixmap* KGameProgress::barPixmap (  )  const

Retrieve the bar pixmap.

See also:
setBarPixmap()

int KGameProgress::value (  )  const [inline]

Retrive the current status.

See also:
setValue()

Definition at line 146 of file kgameprogress.h.

Orientation KGameProgress::orientation (  )  const

Retrive the orientation of the progress bar.

See also:
setOrientation()

bool KGameProgress::textEnabled (  )  const

Returns true if progress text will be displayed, false otherwise.

See also:
setFormat()

QString 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 QString &  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:
KDE Home | KDE Accessibility Home | Description of Access Keys