QWinTaskbarProgress Class

The QWinTaskbarProgress class represents a progress indicator in the Windows taskbar. More...

Header:	#include <QWinTaskbarProgress>
qmake:	QT += winextras
Since:	Qt 5.2
Inherits:	QObject

This class was introduced in Qt 5.2.

• List of all members, including inherited members

Properties

maximum : int minimum : int paused : bool

stopped : const bool value : int visible : bool

Public Functions

	QWinTaskbarProgress(QObject *parent = nullptr)
virtual	~QWinTaskbarProgress()
bool	isPaused() const
bool	isStopped() const
bool	isVisible() const
int	maximum() const
int	minimum() const
int	value() const

Public Slots

void	hide()
void	pause()
void	reset()
void	resume()
void	setMaximum(int maximum)
void	setMinimum(int minimum)
void	setPaused(bool paused)
void	setRange(int minimum, int maximum)
void	setValue(int value)
void	setVisible(bool visible)
void	show()
void	stop()

Signals

void	maximumChanged(int maximum)
void	minimumChanged(int minimum)
void	pausedChanged(bool paused)
void	stoppedChanged(bool stopped)
void	valueChanged(int value)
void	visibilityChanged(bool visible)

Detailed Description

A progress indicator 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 indicator uses the concept of steps. It is set up by specifying the minimum and maximum possible step values, and it will display the percentage of steps that have been completed when you later give it the current step value. The percentage is calculated by dividing the progress (value() - minimum()) divided by maximum() - minimum().

The minimum and maximum number of steps can be specified by calling setMinimum() and setMaximum(). The current number of steps is set with setValue(). The progress indicator can be rewound to the beginning with reset().

If minimum and maximum both are set to 0, the indicator shows up as a busy (indeterminate) indicator instead of a percentage of steps. This is useful when it is not possible to determine the number of steps.

	A progress indicator at 50%.
	A paused progress indicator at 50%.
	A stopped progress indicator at 50%.
	An indeterminate progress indicator.

Note: The final appearance of the progress indicator varies depending on the active Windows theme.

See also QWinTaskbarButton.

Member Function Documentation

QWinTaskbarProgress::QWinTaskbarProgress(QObject *parent = nullptr)

Constructs a QWinTaskbarProgress with the parent object parent.

[slot] void QWinTaskbarProgress::hide()

Hides the progress indicator.

[slot] void QWinTaskbarProgress::pause()

Pauses the progress indicator.

See also paused.

[slot] void QWinTaskbarProgress::reset()

Resets the progress indicator.

This function rewinds the value to the minimum value.

[slot] void QWinTaskbarProgress::resume()

Resumes a paused or stopped progress indicator.

See also paused and stopped.

[slot] void QWinTaskbarProgress::setRange(int minimum, int maximum)

Sets both the minimum and maximum values.

[slot] void QWinTaskbarProgress::show()

Shows the progress indicator.

[slot] void QWinTaskbarProgress::stop()

Stops the progress indicator.

See also stopped.

[virtual] QWinTaskbarProgress::~QWinTaskbarProgress()

Destroys the QWinTaskbarProgress.