Qx::ProgressGroup Class Reference

The ProgressGroup class represents a distinct portion of overall progress to be mediated by GroupedProgressManager. More...

Public Slots
void	reset ()
void	setMaximum (quint64 maximum)
void	setValue (quint64 value)
void	setWeight (quint64 weight)

Signals
void	maximumChanged (quint64 maximum)
void	proportionCompleteChanged (double proportion)
void	valueChanged (quint64 value)
void	weightChanged (quint64 weight)

Public Member Functions
	ProgressGroup (QString name, QObject *parent=nullptr)
void	decreaseMaximum (quint64 amount)
void	decreaseValue (quint64 amount)
void	decrementMaximum ()
void	decrementValue ()
void	increaseMaximum (quint64 amount)
void	increaseValue (quint64 amount)
void	incrementMaximum ()
void	incrementValue ()
quint64	maximum () const
QString	name () const
double	proportionComplete () const
quint64	value () const
quint64	weight () const

Properties
quint64	maximum
	The maximum value of the progress group.
QString	name
	The name of the progress group.
quint64	proportionComplete
	The progress group's proportion of completed progress.
quint64	value
	The current value of the progress group.
quint64	weight
	The weight of the progress group.

Detailed Description

A ProgressGroup acts as a container that stores the progress of a single, or similarly natured step(s) of an arbitrary task, along with a weight that dictates the group's significance when compared to other progress groups.

See also

GroupedProgressManager, QProgressBar

Constructor & Destructor Documentation

ProgressGroup()

Qx::ProgressGroup::ProgressGroup ( QString name, QObject * parent = nullptr )

explicit

Constructs a ProgressGroup with the specified name and parent.

Note

Generally a progress group should only be made the child of a GroupedProgressManager via GroupedProgressManager::addGroup().

Member Function Documentation

decreaseMaximum()

void Qx::ProgressGroup::decreaseMaximum

(

quint64

amount

)

Subtracts amount from the progress group's maximum value.

decreaseValue()

void Qx::ProgressGroup::decreaseValue

(

quint64

amount

)

Subtracts amount from the progress group's current value.

decrementMaximum()

void Qx::ProgressGroup::decrementMaximum

(

)

Decrements the maximum value of the progress group.

decrementValue()

void Qx::ProgressGroup::decrementValue

(

)

Decrements the current value of the progress group.

increaseMaximum()

void Qx::ProgressGroup::increaseMaximum

(

quint64

amount

)

Adds amount to the progress group's maximum value.

increaseValue()

void Qx::ProgressGroup::increaseValue

(

quint64

amount

)

Adds amount to the progress group's current value.

incrementMaximum()

void Qx::ProgressGroup::incrementMaximum

(

)

Increments the maximum value of the progress group.

incrementValue()

void Qx::ProgressGroup::incrementValue

(

)

Increments the current value of the progress group.

maximum()

quint64 Qx::ProgressGroup::maximum

(

)

const

Returns the maximum value of the progress group.

maximumChanged

void Qx::ProgressGroup::maximumChanged ( quint64 maximum )

signal

This signal is emitted whenever the progress group's maximum value changes.

name()

QString Qx::ProgressGroup::name

(

)

const

Returns the name of the progress group.

proportionComplete()

double Qx::ProgressGroup::proportionComplete

(

)

const

Returns the progress group's proportion of completed progress.

proportionCompleteChanged

void Qx::ProgressGroup::proportionCompleteChanged ( double proportion )

signal

This signal is emitted whenever the progress group's proportionComplete changes.

reset

void Qx::ProgressGroup::reset ( )

slot

Sets the current value of the progress group to 0.

setMaximum

void Qx::ProgressGroup::setMaximum ( quint64 maximum )

slot

Sets the maximum value of the progress group to value.

setValue

void Qx::ProgressGroup::setValue ( quint64 value )

slot

Sets the current value of the progress group to value.

setWeight

void Qx::ProgressGroup::setWeight ( quint64 weight )

slot

Sets the weight of the progress group to weight.

value()

quint64 Qx::ProgressGroup::value

(

)

const

Returns the current value of the progress group.

valueChanged

void Qx::ProgressGroup::valueChanged ( quint64 value )

signal

This signal is emitted whenever the progress group's current value changes.

weight()

quint64 Qx::ProgressGroup::weight

(

)

const

Returns the progress group's weight.

weightChanged

void Qx::ProgressGroup::weightChanged ( quint64 weight )

signal

This signal is emitted whenever the progress group's weight changes.

Property Documentation

maximum

quint64 Qx::ProgressGroup::maximum

readwrite

When setting the maximum, if the current value falls outside the new range, the progress bar is reset with reset().

The default value is 100.

name

QString Qx::ProgressGroup::name

read

A progress group's name can only be set when it is constructed.

proportionComplete

quint64 Qx::ProgressGroup::proportionComplete

read

This is expressed as a floating-point value between 0 and 1.

Note

For technical reasons, a progress group with a maximum of 0 is considered to have a proportion complete of 1 (100%).

value

quint64 Qx::ProgressGroup::value

readwrite

Attempting to change the current value to one outside the minimum-maximum range has no effect on the current value.

The minimum for a progress group's value is always 0.

The default value is 0.

weight

quint64 Qx::ProgressGroup::weight

readwrite

The weight of a progress group can never be reduced below 1.

The default value is 1.

---

The documentation for this class was generated from the following files:

• qx-progressgroup.h
• qx-progressgroup.cpp