Contents

• Properties
• Public Functions
• Reimplemented Public Functions
• Public Slots
• Protected Functions
• Reimplemented Protected Functions
• Detailed Description

Detailed Description

TheQ3ProgressBar widget provides a horizontal progress bar.

A progress bar is used to give the user an indication of the progress of an operation and to reassure them that the application is still running.

The progress bar uses the concept ofsteps; you give it the total number of steps and the number of steps completed so far and it will display the percentage of steps that have been completed. You can specify the total number of steps in the constructor or later withsetTotalSteps(). The current number of steps is set withsetProgress(). The progress bar can be rewound to the beginning withreset().

If the total is given as 0 the progress bar shows a busy indicator instead of a percentage of steps. This is useful, for example, when usingQFtp orQHttp to download items when they are unable to determine the size of the item being downloaded.

Property Documentation

centerIndicator :bool

This property holds whether the indicator string should be centered.

Access functions:

percentageVisible :bool

This property holds whether the current progress value is displayed.

The default is true.

Access functions:

See alsocenterIndicator.

progress :int

This property holds the current amount of progress.

This property is -1 if progress counting has not started.

Access functions:

progressString : constQString

This property holds the amount of progress as a string.

This property is an empty string if progress counting has not started.

Access functions:

totalSteps :int

This property holds the total number of steps.

If totalSteps is 0, the progress bar will display a busy indicator.

Access functions:

Member Function Documentation

Q3ProgressBar::Q3ProgressBar(QWidget * parent = 0,Qt::WindowFlags f = 0)

Constructs a progress bar.

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

Theparent, and widget flags,f, are passed on to theQFrame::QFrame() constructor.

See alsosetTotalSteps().

Q3ProgressBar::Q3ProgressBar(int totalSteps,QWidget * parent = 0,Qt::WindowFlags f = 0)

Constructs a progress bar.

ThetotalSteps 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, callsetProgress(0); callsetProgress(50) after examining the last file.

Theparent, and widget flags,f, are passed to theQFrame::QFrame() constructor.

See alsosetTotalSteps() andsetProgress().

[virtual protected]void Q3ProgressBar::changeEvent(QEvent * ev)

Reimplemented fromQWidget::changeEvent().

int Q3ProgressBar::margin() const

Returns the width of the margin around the contents of the widget.

This function usesQWidget::getContentsMargins() to get the margin.

This function was introduced in Qt 4.2.

See alsosetMargin() andQWidget::getContentsMargins().

[virtual]QSize Q3ProgressBar::minimumSizeHint() const

Reimplemented fromQWidget::minimumSizeHint().

[virtual protected]void Q3ProgressBar::paintEvent(QPaintEvent *)

Reimplemented fromQWidget::paintEvent().

[slot]void Q3ProgressBar::reset()

Reset the progress bar. The progress bar "rewinds" and shows no progress.

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

This method is called to generate the text displayed in the center (or in some styles, to the left) of the progress bar.

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

The default implementation is the percentage of completion or blank in the reset state. The percentage is calculated based on theprogress andtotalSteps. You can set theindicator text if you wish.

To allow efficient repainting of the progress bar, this method should return false if the string is unchanged from the last call to this function.

void Q3ProgressBar::setMargin(int margin)

Sets the width of the margin around the contents of the widget tomargin.

This function usesQWidget::setContentsMargins() to set the margin.

This function was introduced in Qt 4.2.

See alsomargin() andQWidget::setContentsMargins().

[virtual]void Q3ProgressBar::setVisible(bool visible)

Reimplemented fromQWidget::setVisible().

[virtual]QSize Q3ProgressBar::sizeHint() const

Reimplemented fromQWidget::sizeHint().