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

Collaboration diagram for Qx::ProgressGroup:

[legend]

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const

T	findChild (Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

bool	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const 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.

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

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

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

Qx::ProgressGroup::name

read

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

◆ proportionComplete

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

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

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

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProgressGroup()

Member Function Documentation

◆ decreaseMaximum()

◆ decreaseValue()

◆ decrementMaximum()

◆ decrementValue()

◆ increaseMaximum()

◆ increaseValue()

◆ incrementMaximum()

◆ incrementValue()

◆ maximum()

◆ maximumChanged

◆ name()

◆ proportionComplete()

◆ proportionCompleteChanged

◆ reset

◆ setMaximum

◆ setValue

◆ setWeight

◆ value()

◆ valueChanged

◆ weight()

◆ weightChanged

Property Documentation

◆ maximum

◆ name

◆ proportionComplete

◆ value

◆ weight