Qtopia Home - Classes - Hierachy - Annotated - Functions - Licenses - Reference

QProgressBar Class Reference

The QProgressBar widget provides a horizontal progress bar. More...

#include <qprogressbar.h>

Inherits QFrame.

List of all member functions.

Public Members

• QProgressBar ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )
• QProgressBar ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )
• int totalSteps () const
• int progress () const
• void setCenterIndicator ( bool on )
• bool centerIndicator () const
• void setIndicatorFollowsStyle ( bool on )
• bool indicatorFollowsStyle () const

Public Slots

• void reset ()
• virtual void setTotalSteps ( int totalSteps )
• virtual void setProgress ( int progress )

Properties

• bool centerIndicator
• bool indicatorFollowsStyle
• int progress
• int totalSteps

Protected Members

• virtual void drawContentsMask ( QPainter * p )
• virtual bool setIndicator ( QString & indicator, int progress, int totalSteps )

Detailed Description

A progress bar is used to give the user an indication of progress of an operation. To reassure them that the application has not crashed.

QProgressBar only implements the basic progress display, while QProgressDialog provides a fuller encapsulation.

See also QProgressDialog and GUI Design Handbook: Progress Indicator.

Member Function Documentation

QProgressBar::QProgressBar ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )

The total number of steps is set to 100 by default.

parent, name and f are sent to the QFrame::QFrame() constructor.

See also setTotalSteps().

QProgressBar::QProgressBar ( int totalSteps, QWidget * parent = 0, const char * name = 0, WFlags f = 0 )

totalSteps is the total number of steps in the operation of which this progress bar shows the progress. For example, if the operation is to examine 50 files, this value would be 50, then before examining the first file, call setProgress(0), and after examining the last file call setProgress(50).

parent, name and f are sent to the QFrame::QFrame() constructor.

See also setTotalSteps() and setProgress().

bool QProgressBar::centerIndicator () const

Returns where the indicator string should be displayed if indicatorFollowsStyle() is TRUE.

See also setCenterIndicator(), indicatorFollowsStyle(), setIndicatorFollowsStyle(), and setIndicator().

void QProgressBar::drawContentsMask ( QPainter * p ) [virtual protected]

See also QWidget::setAutoMask().

Reimplemented from QFrame.

bool QProgressBar::indicatorFollowsStyle () const

Returns whether the display of the indicator string should follow the GUI style or not.

See also setIndicatorFollowsStyle(), setCenterIndicator(), centerIndicator(), and setIndicator().

int QProgressBar::progress () const

See also setProgress().

void QProgressBar::reset () [slot]

void QProgressBar::setCenterIndicator ( bool on )

Calling this function always sets indicatorFollowsStyle() to FALSE.

See also centerIndicator(), indicatorFollowsStyle(), setIndicatorFollowsStyle(), and setIndicator().

bool QProgressBar::setIndicator ( QString & indicator, int progress, int totalSteps ) [virtual protected]

The progress may be negative, indicating that the bar is in the "reset" state before any progress is set.

The default implementation it is the percentage of completion or blank in the reset state.

This method should return FALSE if the string is unchanged since the last call to the method, to allow efficient repainting of the progress bar.

void QProgressBar::setIndicatorFollowsStyle ( bool on )

See also indicatorFollowsStyle(), centerIndicator(), setCenterIndicator(), and setIndicator().

void QProgressBar::setProgress ( int progress ) [virtual slot]

See also progress() and totalSteps().

void QProgressBar::setTotalSteps ( int totalSteps ) [virtual slot]

See also totalSteps().

int QProgressBar::totalSteps () const

See also setTotalSteps().

This file is part of the Qtopia platform, copyright © 1995-2005 Trolltech, all rights reserved.