kdeui Library API Documentation

KProgress Class Reference

A stylized progress bar. A progress indicator widget. More...

#include <kprogress.h>

Inheritance diagram for KProgress:

QProgressBar List of all members.

Public Slots

void setFormat (const QString &format)
void setTotalSteps (int totalSteps)
virtual void setProgress (int progress)
void setValue (int progress)
virtual void advance (int offset)

Signals

void percentageChanged (int)

Public Member Functions

 KProgress (QWidget *parent=0, const char *name=0, WFlags f=0)
 KProgress (int totalSteps, QWidget *parent=0, const char *name=0, WFlags f=0)
 ~KProgress ()
void setTextEnabled (bool)
int value () const KDE_DEPRECATED
bool textEnabled () const
QString format () const
void setRange (int min, int max) KDE_DEPRECATED
int maxValue () KDE_DEPRECATED

Protected Member Functions

virtual bool setIndicator (QString &indicator, int progress, int totalSteps)
virtual void virtual_hook (int id, void *data)

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

kprogress.png

KDE Progress Widget

Author:
Aaron Seigo
Version:
Id
kprogress.h,v 1.43 2003/09/07 12:58:25 coolo Exp

Definition at line 48 of file kprogress.h.


Constructor & Destructor Documentation

KProgress::KProgress QWidget parent = 0,
const char *  name = 0,
WFlags  f = 0
 

Construct a progress bar.

Definition at line 41 of file kprogress.cpp.

References KProgress(), and setProgress().

Referenced by KProgress().

KProgress::KProgress int  totalSteps,
QWidget parent = 0,
const char *  name = 0,
WFlags  f = 0
 

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 48 of file kprogress.cpp.

References KProgress(), and setProgress().

KProgress::~KProgress  ) 
 

Destruct the progress bar.

Definition at line 55 of file kprogress.cpp.


Member Function Documentation

void KProgress::setTextEnabled bool   ) 
 

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

Definition at line 102 of file kprogress.cpp.

References setTextEnabled().

Referenced by setTextEnabled().

int KProgress::value  )  const
 

Deprecated:
Retrieves the current status, use progress() instead
See also:
setValue()

Definition at line 125 of file kprogress.cpp.

References QProgressBar::progress().

bool KProgress::textEnabled  )  const
 

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

See also:
setFormat()

Definition at line 107 of file kprogress.cpp.

References QProgressBar::percentageVisible().

QString KProgress::format  )  const
 

Retrieve the current format for printing status text.

See also:
setFormat()

Definition at line 119 of file kprogress.cpp.

void KProgress::setRange int  min,
int  max
 

Deprecated:
but kept for source compatibility with KDE2's KProgress. Use setTotalSteps() instead

Definition at line 91 of file kprogress.cpp.

References setRange(), and setTotalSteps().

Referenced by setRange().

int KProgress::maxValue  ) 
 

Deprecated:
used totalSteps() instead

Definition at line 97 of file kprogress.cpp.

References QProgressBar::totalSteps().

void KProgress::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%".)

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.

Parameters:
format p is replaced by percentage done, v is replaced by actual value, m is replaced by the maximum value.

Definition at line 112 of file kprogress.cpp.

References setFormat().

Referenced by setFormat().

void KProgress::setTotalSteps int  totalSteps  )  [slot]
 

Set the current total number of steps in the action tat the progress bar is representing.

Reimplemented from QProgressBar.

Definition at line 64 of file kprogress.cpp.

References percentageChanged(), QProgressBar::progress(), and setTotalSteps().

Referenced by setRange(), and setTotalSteps().

void KProgress::setProgress int  progress  )  [virtual, slot]
 

Set the current value of the progress bar to value.

Reimplemented from QProgressBar.

Definition at line 74 of file kprogress.cpp.

References percentageChanged(), setProgress(), and QProgressBar::totalSteps().

Referenced by advance(), KProgress(), setProgress(), and setValue().

void KProgress::setValue int  progress  )  [slot]
 

Deprecated:
. Use setProgress(int) instead

Definition at line 85 of file kprogress.cpp.

References setProgress(), and setValue().

Referenced by setValue().

void KProgress::advance int  offset  )  [virtual, slot]
 

Advance the progress bar by prog.

This method is provided for convenience and is equivalent with setProgress(progress()+prog).

Definition at line 59 of file kprogress.cpp.

References advance(), QProgressBar::progress(), and setProgress().

Referenced by advance().

void KProgress::percentageChanged int   )  [signal]
 

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:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Aug 20 09:48:51 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003