Base class for progress indicators. More...

#include <QskProgressIndicator.h>

Detailed Description

Base class for progress indicators.

QskProgressIndicator is the base class for circular (QskProgressRing) and linear (QskProgressBar) progress indicators, and should not be instantiated directly.

There are two modes for progress indicators:

Determinate, which means the user has to set a progress value to advance the indicator
Indeterminate, which means the indicator will loop forever without the need for updating its value

By default progress indicators are determinate.

Subcontrols:: QskProgressIndicator::Groove, QskProgressIndicator::Fill

Default Skinlet:: QskProgressIndicatorSkinlet

See also: QskProgressBar, QskProgressRing

Definition at line 13 of file QskProgressIndicator.h.

Inheritance diagram for QskProgressIndicator:

Public Slots
void	setValue (qreal)

void	setValueAsRatio (qreal)

void	setOrigin (qreal)

Public Slots inherited from QskBoundedControl
void	setMinimum (qreal)

void	setMaximum (qreal)

void	setBoundaries (const QskIntervalF &)

Public Slots inherited from QskControl
void	setLocale (const QLocale &)

Public Slots inherited from QskItem
void	setGeometry (const QRectF &)

void	show ()

void	hide ()

void	setHidden (bool)

void	setDisabled (bool)

void	resetImplicitSize ()

Signals
void	extentChanged (qreal)

void	indeterminateChanged (bool)

void	valueChanged (qreal)

void	originChanged (qreal)

Signals inherited from QskBoundedControl
void	minimumChanged (qreal)

void	maximumChanged (qreal)

void	boundariesChanged (const QskIntervalF &)

Signals inherited from QskControl
void	backgroundChanged ()

void	sectionChanged (QskAspect::Section)

void	marginsChanged (const QMarginsF &)

void	focusIndicatorRectChanged ()

void	localeChanged (const QLocale &)

Signals inherited from QskItem
void	wheelEnabledChanged (bool)

void	itemFlagsChanged ()

void	updateFlagsChanged (UpdateFlags)

Public Member Functions
	QskProgressIndicator (QQuickItem *parent=nullptr)

	QskProgressIndicator (qreal min, qreal max, QQuickItem *parent=nullptr)

	QskProgressIndicator (const QskIntervalF &, QQuickItem *parent=nullptr)

	~QskProgressIndicator () override

bool	isIndeterminate () const

void	setIndeterminate (bool on=true)

void	setFillGradient (const QskGradient &)

void	resetFillGradient ()

QskGradient	fillGradient () const

void	setExtent (qreal)

void	resetExtent ()

qreal	extent () const

void	resetOrigin ()

qreal	origin () const

bool	hasOrigin () const

qreal	value () const

qreal	valueAsRatio () const

qreal	valueAsRatio (qreal) const

Public Member Functions inherited from QskBoundedControl
qreal	minimum () const

qreal	maximum () const

qreal	boundaryLength () const

void	setBoundaries (qreal min, qreal max)

QskIntervalF	boundaries () const

qreal	boundedValue (qreal) const

qreal	valueAsRatio (qreal) const

qreal	valueFromRatio (qreal) const

Public Member Functions inherited from QskControl
	QskControl (QQuickItem *parent=nullptr)

	~QskControl () override

void	setMargins (qreal)

void	setMargins (qreal, qreal, qreal, qreal)

void	setMargins (const QMarginsF &)

void	resetMargins ()

QMarginsF	margins () const

void	setBackground (const QskGradient &)

void	resetBackground ()

QskGradient	background () const

void	setBackgroundColor (const QColor &)

QRectF	contentsRect () const

QRectF	layoutRect () const

virtual QRectF	layoutRectForSize (const QSizeF &) const

virtual QRectF	focusIndicatorRect () const

virtual QRectF	focusIndicatorClipRect () const

QRectF	subControlRect (QskAspect::Subcontrol) const

QRectF	subControlRect (const QSizeF &, QskAspect::Subcontrol) const

QRectF	subControlContentsRect (QskAspect::Subcontrol) const

QRectF	subControlContentsRect (const QSizeF &, QskAspect::Subcontrol) const

void	setAutoLayoutChildren (bool)

bool	autoLayoutChildren () const

void	setSection (QskAspect::Section)

void	resetSection ()

QskAspect::Section	section () const override final

void	setSizePolicy (QskSizePolicy)

void	setSizePolicy (QskSizePolicy::Policy, QskSizePolicy::Policy)

void	setSizePolicy (Qt::Orientation, QskSizePolicy::Policy)

QskSizePolicy	sizePolicy () const

QskSizePolicy::Policy	sizePolicy (Qt::Orientation) const

void	setLayoutAlignmentHint (Qt::Alignment)

Qt::Alignment	layoutAlignmentHint () const

void	setPlacementPolicy (QskPlacementPolicy)

void	setPlacementPolicy (QskPlacementPolicy::Policy, QskPlacementPolicy::Policy)

void	setPlacementPolicy (Qsk::Visibilities, QskPlacementPolicy::Policy)

void	resetPlacementPolicy ()

QskPlacementPolicy	placementPolicy () const

QskPlacementPolicy::Policy	placementPolicy (Qsk::Visibility) const

QskPlacementPolicy::Policy	effectivePlacementPolicy () const

bool	isVisibleToLayout () const

void	setMinimumSize (const QSizeF &)

void	setMinimumSize (qreal width, qreal height)

void	setMinimumWidth (qreal width)

void	setMinimumHeight (qreal height)

void	setMaximumSize (const QSizeF &)

void	setMaximumSize (qreal width, qreal height)

void	setMaximumWidth (qreal width)

void	setMaximumHeight (qreal height)

void	setPreferredSize (const QSizeF &)

void	setPreferredSize (qreal width, qreal height)

void	setPreferredWidth (qreal width)

void	setPreferredHeight (qreal height)

void	setFixedSize (const QSizeF &)

void	setFixedSize (qreal width, qreal height)

void	setFixedWidth (qreal width)

void	setFixedHeight (qreal height)

void	setExplicitSizeHint (Qt::SizeHint, const QSizeF &)

void	setExplicitSizeHint (Qt::SizeHint, qreal width, qreal height)

void	resetExplicitSizeHint (Qt::SizeHint)

QSizeF	minimumSize () const

QSizeF	maximumSize () const

QSizeF	preferredSize () const

QSizeF	explicitSizeHint (Qt::SizeHint) const

QSizeF	implicitSizeHint (Qt::SizeHint, const QSizeF &constraint) const

QSizeF	sizeHint () const

qreal	heightForWidth (qreal width) const

qreal	widthForHeight (qreal height) const

QSizeF	effectiveSizeHint (Qt::SizeHint, const QSizeF &constraint=QSizeF()) const

QSizeF	sizeConstraint (Qt::SizeHint, const QSizeF &constraint=QSizeF()) const

QSizeF	sizeConstraint () const

QLocale	locale () const

void	resetLocale ()

QVector< QskAspect::Subcontrol >	subControls () const

QRectF	subControlRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate position and size of a subControl.

QRectF	subControlContentsRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate the inner rectangle for subControl.

Public Member Functions inherited from QskItem
const char *	className () const

bool	isVisibleTo (const QQuickItem *) const

bool	isVisibleToParent () const

bool	hasChildItems () const

QRectF	rect () const

QSizeF	implicitSize () const

void	setGeometry (qreal x, qreal y, qreal width, qreal height)

void	setGeometry (const QPointF &, const QSizeF &)

QRectF	geometry () const

void	setPosition (qreal x, qreal y)

void	setSize (qreal width, qreal height)

void	setPolishOnResize (bool)

bool	polishOnResize () const

void	setPolishOnParentResize (bool)

bool	polishOnParentResize () const

void	setTabFence (bool)

bool	isTabFence () const

void	setWheelEnabled (bool)

bool	isWheelEnabled () const

void	setLayoutMirroring (bool on, bool childrenInherit=false)

void	resetLayoutMirroring ()

bool	layoutMirroring () const

void	resetUpdateFlags ()

UpdateFlags	updateFlags () const

void	setUpdateFlag (UpdateFlag, bool on=true)

void	resetUpdateFlag (UpdateFlag)

bool	testUpdateFlag (UpdateFlag) const

void	classBegin () override

void	componentComplete () override

void	releaseResources () override

bool	isPolishScheduled () const

bool	isUpdateNodeScheduled () const

bool	isInitiallyPainted () const

bool	maybeUnresized () const

Public Member Functions inherited from QskSkinnable
	QskSkinnable ()

virtual	~QskSkinnable ()

void	setSkinlet (const QskSkinlet *)
	Set an individual skinlet to render/display the content.

const QskSkinlet *	skinlet () const

QFont	effectiveFont (QskAspect) const

qreal	effectiveFontHeight (QskAspect) const

QskColorFilter	effectiveGraphicFilter (QskAspect::Subcontrol) const

void	setSubcontrolProxy (QskAspect::Subcontrol, QskAspect::Subcontrol proxy)

void	resetSubcontrolProxy (QskAspect::Subcontrol)

QskAspect::Subcontrol	subcontrolProxy (QskAspect::Subcontrol) const

bool	setAnimationHint (QskAspect, QskAnimationHint)

QskAnimationHint	animationHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	hasAnimationHint (QskAspect) const

bool	setSkinHint (QskAspect, const QVariant &)
	Insert a hint into the local hint table.

bool	resetSkinHint (QskAspect)
	Remove a hint from the local hint table.

bool	moveSkinHint (QskAspect, const QVariant &)

bool	moveSkinHint (QskAspect, const QVariant &, const QVariant &)

QskAnimationHint	effectiveAnimation (QskAspect::Type, QskAspect::Subcontrol, QskAspect::States, QskSkinHintStatus *status=nullptr) const

QVariant	effectiveSkinHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Find the value for a specific aspect.

virtual QskAspect::Variation	effectiveVariation () const

QskSkinHintStatus	hintStatus (QskAspect) const

QRectF	subControlRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate position and size of a subControl.

QRectF	subControlContentsRect (const QRectF &, QskAspect::Subcontrol) const
	Calculate the inner rectangle for subControl.

QSizeF	outerBoxSize (QskAspect, const QSizeF &innerBoxSize) const
	Calculate the size, when being expanded by paddings, indentations.

QSizeF	innerBoxSize (QskAspect, const QSizeF &outerBoxSize) const
	Calculate the size, with paddings, indentations being subtracted.

QRectF	innerBox (QskAspect, const QRectF &outerBox) const
	Calculate the rectangle, whith paddings, indentations being subtracted.

QRectF	outerBox (QskAspect, const QRectF &innerBox) const
	Calculate the rectangle, when being expanded by paddings, indentations.

QMarginsF	innerPadding (QskAspect, const QSizeF &) const
	Calculate the padding from attributes for the given aspect.

const QskSkinlet *	effectiveSkinlet () const

QskSkin *	effectiveSkin () const

void	startTransition (QskAspect, QskAnimationHint, const QVariant &from, const QVariant &to)

void	startTransition (QskAspect, int index, QskAnimationHint, const QVariant &from, const QVariant &to)

QskAspect::Subcontrol	effectiveSubcontrol (QskAspect::Subcontrol) const

QskControl *	controlCast ()

const QskControl *	controlCast () const

virtual const QMetaObject *	metaObject () const =0

void	debug (QskAspect) const

void	debug (QskAspect::State) const

void	debug (QDebug, QskAspect) const

void	debug (QDebug, QskAspect::State) const

void	setSkinStates (QskAspect::States)

void	setSkinStateFlag (QskAspect::State, bool on=true)

void	addSkinStates (QskAspect::States)

void	clearSkinStates (QskAspect::States)

bool	hasSkinState (QskAspect::State) const

QskAspect::States	skinStates () const

const char *	skinStatesAsPrintable () const

const char *	skinStatesAsPrintable (QskAspect::States) const

bool	setColor (QskAspect, Qt::GlobalColor)
	Sets a color hint.

bool	setColor (QskAspect, QRgb)
	Sets a color hint.

bool	setColor (QskAspect, const QColor &)
	Sets a color hint.

bool	moveColor (QskAspect, Qt::GlobalColor)

bool	moveColor (QskAspect, QRgb)

bool	moveColor (QskAspect, const QColor &)

bool	resetColor (QskAspect)
	Removes a color hint from the local table.

QColor	color (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a color hint.

bool	setMetric (QskAspect, qreal)
	Sets a metric hint.

bool	moveMetric (QskAspect, qreal)

bool	resetMetric (QskAspect)
	Removes a metric hint from the local table.

qreal	metric (QskAspect, QskSkinHintStatus *=nullptr) const

qreal	metric (QskAspect, qreal defaultValue) const

bool	setFlagHint (QskAspect, int flag)
	Sets a flag hint.

template<typename T >
T	flagHint (QskAspect, T=T()) const
	Retrieves a flag hint.

bool	setPositionHint (QskAspect, qreal)

bool	movePositionHint (QskAspect, qreal)

bool	movePositionHint (QskAspect, qreal from, qreal to)

bool	resetPositionHint (QskAspect)

qreal	positionHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setStrutSizeHint (QskAspect, const QSizeF &)
	Sets a metric hint.

bool	setStrutSizeHint (QskAspect, qreal width, qreal height)
	Sets a strut size hint.

bool	resetStrutSizeHint (QskAspect)
	Removes a strut size hint from the local table.

QSizeF	strutSizeHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a strut size hint.

bool	setMarginHint (QskAspect, qreal)
	Sets a margin hint.

bool	setMarginHint (QskAspect, const QMarginsF &)
	Sets a margin hint.

bool	resetMarginHint (QskAspect)
	Removes a margin hint from the local table.

QMarginsF	marginHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a margin hint.

bool	setPaddingHint (QskAspect, qreal)
	Sets a padding hint.

bool	setPaddingHint (QskAspect, const QMarginsF &)
	Sets a padding hint.

bool	resetPaddingHint (QskAspect)
	Removes a padding hint from the local table.

QMarginsF	paddingHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a padding hint.

bool	setGradientHint (QskAspect, const QskGradient &)
	Sets a gradient as color hint.

QskGradient	gradientHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a color hint as gradient.

bool	setBoxShapeHint (QskAspect, const QskBoxShapeMetrics &)
	Sets a shape hint.

bool	resetBoxShapeHint (QskAspect)
	Removes a shape hint from the local table.

QskBoxShapeMetrics	boxShapeHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a shape hint.

bool	setBoxBorderMetricsHint (QskAspect, const QskBoxBorderMetrics &)
	Sets a border metrics hint.

bool	resetBoxBorderMetricsHint (QskAspect)
	Removes a border metrics hint from the local table.

QskBoxBorderMetrics	boxBorderMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a border hint.

bool	setBoxBorderColorsHint (QskAspect, const QskBoxBorderColors &)
	Sets a border colors hint.

bool	resetBoxBorderColorsHint (QskAspect)
	Removes a border colors hint from the local table.

QskBoxBorderColors	boxBorderColorsHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves border colors hint.

bool	setShadowMetricsHint (QskAspect, const QskShadowMetrics &)

bool	resetShadowMetricsHint (QskAspect)

QskShadowMetrics	shadowMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setShadowColorHint (QskAspect, const QColor &)

bool	resetShadowColorHint (QskAspect)

QColor	shadowColorHint (QskAspect, QskSkinHintStatus *=nullptr) const

QskBoxHints	boxHints (QskAspect) const

bool	setArcMetricsHint (QskAspect, const QskArcMetrics &)

bool	resetArcMetricsHint (QskAspect)

QskArcMetrics	arcMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setStippleMetricsHint (QskAspect, const QskStippleMetrics &)

bool	resetStippleMetricsHint (QskAspect)

QskStippleMetrics	stippleMetricsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setSpacingHint (QskAspect, qreal)
	Sets a spacing hint.

bool	resetSpacingHint (QskAspect)
	Removes a spacing hint from the local table.

qreal	spacingHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a spacing hint.

bool	setAlignmentHint (QskAspect, Qt::Alignment)
	Sets an alignment hint.

bool	resetAlignmentHint (QskAspect)
	Removes an alignment hint from the local table.

Qt::Alignment	alignmentHint (QskAspect, Qt::Alignment=Qt::Alignment()) const
	Retrieves an alignment hint.

bool	setTextOptionsHint (QskAspect, const QskTextOptions &)

bool	resetTextOptionsHint (QskAspect)

QskTextOptions	textOptionsHint (QskAspect, QskSkinHintStatus *=nullptr) const

bool	setFontRoleHint (QskAspect, const QskFontRole &)
	Sets a font role hint.

bool	resetFontRoleHint (QskAspect)
	Removes a font role hint from the local table.

QskFontRole	fontRoleHint (QskAspect, QskSkinHintStatus *=nullptr) const
	Retrieves a font role hint.

bool	setGraphicRoleHint (QskAspect, int role)
	Sets a graphic role hint.

bool	resetGraphicRoleHint (QskAspect)
	Removes a graphic role hint from the local table.

int	graphicRoleHint (QskAspect, QskSkinHintStatus *=nullptr) const
	A Retrieves a graphic role hint.

bool	setSymbolHint (const QskAspect, const QskGraphic &)

bool	resetSymbolHint (const QskAspect)

QskGraphic	symbolHint (const QskAspect, QskSkinHintStatus *=nullptr) const

const QskSkinHintTable &	hintTable () const
	Accessor for local skin hint table.

bool	startHintTransitions (QskAspect::States, QskAspect::States, int index=-1)

bool	startHintTransitions (const QVector< QskAspect::Subcontrol > &, QskAspect::States, QskAspect::States, int index=-1)

const QskHintAnimator *	runningHintAnimator (QskAspect, int index=-1) const

Static Public Attributes
static const QskAspect::Subcontrol	Groove

static const QskAspect::Subcontrol	Fill

Static Public Attributes inherited from QskControl
static const QskAspect::Subcontrol	Background

static const QskAspect::State	Disabled

static const QskAspect::State	Hovered

static const QskAspect::State	Focused

Protected Member Functions
void	componentComplete () override

void	itemChange (ItemChange, const ItemChangeData &) override

Protected Member Functions inherited from QskBoundedControl
	QskBoundedControl (QQuickItem *parent=nullptr)

	QskBoundedControl (qreal min, qreal max, QQuickItem *parent=nullptr)

void	componentComplete () override

Protected Member Functions inherited from QskControl
bool	event (QEvent *) override

virtual void	gestureEvent (QskGestureEvent *)

void	hoverEnterEvent (QHoverEvent *) override

void	hoverLeaveEvent (QHoverEvent *) override

bool	childMouseEventFilter (QQuickItem , QEvent ) override

void	itemChange (ItemChange, const ItemChangeData &) override

void	geometryChange (const QRectF &, const QRectF &) override

void	initSizePolicy (QskSizePolicy::Policy, QskSizePolicy::Policy)

virtual void	updateResources ()

virtual void	updateLayout ()

virtual QSizeF	contentsSizeHint (Qt::SizeHint, const QSizeF &) const

virtual QSizeF	layoutSizeHint (Qt::SizeHint, const QSizeF &) const

Protected Member Functions inherited from QskItem
	QskItem (QskItemPrivate &, QQuickItem *=nullptr)

bool	event (QEvent *) override

virtual void	changeEvent (QEvent *)

virtual void	geometryChangeEvent (QskGeometryChangeEvent *)

virtual void	viewportChangeEvent (QskViewportChangeEvent *)

virtual void	windowChangeEvent (QskWindowChangeEvent *)

void	mouseUngrabEvent () override

void	touchUngrabEvent () override

void	itemChange (ItemChange, const ItemChangeData &) override

void	geometryChange (const QRectF &, const QRectF &) override

virtual void	aboutToShow ()

Protected Member Functions inherited from QskSkinnable
virtual void	updateNode (QSGNode *)

virtual bool	isTransitionAccepted (QskAspect) const
	Additional check if an transition should be started.

virtual QskAspect::Subcontrol	substitutedSubcontrol (QskAspect::Subcontrol) const

QskSkinHintTable &	hintTable ()
	Accessor for local skin hint table.

Properties
qreal	extent

bool	indeterminate

qreal	origin

qreal	value

qreal	valueAsRatio

Properties inherited from QskBoundedControl
qreal	minimum

qreal	maximum

QskIntervalF	boundaries

Properties inherited from QskControl
QLocale	locale

QskAspect::Section	section

bool	autoLayoutChildren

bool	visibleToLayout

QskMargins	margins

QskGradient	background

QskSizePolicy	sizePolicy

QskPlacementPolicy	placementPolicy

QSizeF	minimumSize

QSizeF	maximumSize

QSizeF	preferredSize

QSizeF	sizeConstraint

Properties inherited from QskItem
QRectF	geometry

QRectF	rect

bool	tabFence

bool	polishOnResize

bool	polishOnParentResize

bool	wheelEnabled

bool	visibleToParent

bool	hasChildItems

bool	initiallyPainted

UpdateFlags	updateFlags

Additional Inherited Members
Public Types inherited from QskItem
enum	UpdateFlag : quint16 { DeferredUpdate = 1 << 0 , DeferredPolish = 1 << 1 , DeferredLayout = 1 << 2 , CleanupOnVisibility = 1 << 3 , PreferRasterForTextures = 1 << 4 , DebugForceBackground = 1 << 7 }

Constructor & Destructor Documentation

◆ QskProgressIndicator() [1/3]

QskProgressIndicator::QskProgressIndicator ( QQuickItem * parent = nullptr )

Creates a new progress indicator with the given parent.

Definition at line 87 of file QskProgressIndicator.cpp.

◆ QskProgressIndicator() [2/3]

QskProgressIndicator::QskProgressIndicator	(	qreal	min,
		qreal	max,
		QQuickItem *	parent = `nullptr`
	)

Creates a new progress indicator with the progress interval [min, max] and the given parent.

Definition at line 77 of file QskProgressIndicator.cpp.

◆ QskProgressIndicator() [3/3]

QskProgressIndicator::QskProgressIndicator	(	const QskIntervalF &	interval,
		QQuickItem *	parent = `nullptr`
	)

Creates a new progress indicator with the given progress interval and the given parent.

Definition at line 92 of file QskProgressIndicator.cpp.

◆ ~QskProgressIndicator()

QskProgressIndicator::~QskProgressIndicator ( )

override

Destructor.

Definition at line 97 of file QskProgressIndicator.cpp.

Member Function Documentation

◆ componentComplete()

void QskProgressIndicator::componentComplete ( )

overrideprotected

This will adjust the value appropriately when the component is complete.

Derived classes overriding this function should call it in their implementation.

Definition at line 219 of file QskProgressIndicator.cpp.

◆ extent()

qreal QskProgressIndicator::extent ( ) const

Returns the extent, i.e. the size of the QskProgressIndicator::Groove subcontrol.

See also: setExtent(), extentChanged(), resetExtent()

Definition at line 149 of file QskProgressIndicator.cpp.

◆ extentChanged

QskProgressIndicator::extentChanged ( qreal )

signal

Will be emitted when the extent changes.

See also: extent(), setExtent(), resetExtent()

◆ fillGradient()

QskGradient QskProgressIndicator::fillGradient ( ) const

Returns the fill gradient.

See also: setFillGradient(), resetFillGradient()

Definition at line 129 of file QskProgressIndicator.cpp.

◆ hasOrigin()

bool QskProgressIndicator::hasOrigin ( ) const

Returns true if an origin has been set via setOrigin().

See also: origin(), setOrigin(), originChanged(), resetOrigin()

Definition at line 190 of file QskProgressIndicator.cpp.

◆ indeterminateChanged

QskProgressIndicator::indeterminateChanged ( bool )

signal

Will be emitted when the indicator changes from indeterminate to determinate or vice versa.

See also: isIndeterminate(), setIndeterminate()

◆ isIndeterminate()

bool QskProgressIndicator::isIndeterminate ( ) const

Returns whether the progress indicator is indeterminate, i.e. will loop forever.

See also: setIndeterminate(), indeterminateChanged()

Definition at line 102 of file QskProgressIndicator.cpp.

◆ itemChange()

void QskProgressIndicator::itemChange	(	ItemChange	,
		const ItemChangeData &
	)

overrideprotected

Checks whether the visibility has changed and animates the indicator in case it is indeterminate. I.e. when the indicator becomes visible it will start the animator, and when it becomes invisible it will stop it.

Derived classes overriding this function should call it in their implementation.

Definition at line 242 of file QskProgressIndicator.cpp.

◆ origin()

qreal QskProgressIndicator::origin ( ) const

Returns the origin, i.e. the value where the progress will start. If no origin has been set via setOrigin(), the minimum value is returned.

See also: hasOrigin(), setOrigin(), originChanged(), resetOrigin(), QskBoundedControl::minimum()

Definition at line 180 of file QskProgressIndicator.cpp.

◆ originChanged

QskProgressIndicator::originChanged ( qreal )

signal

Will be emitted when the origin changes.

See also: origin(), hasOrigin(), setOrigin(), resetOrigin()

◆ resetExtent()

void QskProgressIndicator::resetExtent ( )

Resets the extent.

See also: extent(), setExtent(), extentChanged()

Definition at line 143 of file QskProgressIndicator.cpp.

◆ resetFillGradient()

void QskProgressIndicator::resetFillGradient ( )

Resets the fill gradient.

See also: fillGradient(), setFillGradient()

Definition at line 124 of file QskProgressIndicator.cpp.

◆ resetOrigin()

void QskProgressIndicator::resetOrigin ( )

Resets the origin.

See also: hasOrigin(), origin( void ), setOrigin(), originChanged()

Definition at line 169 of file QskProgressIndicator.cpp.

◆ setExtent()

void QskProgressIndicator::setExtent ( qreal extent )

Sets the size of the extent, i.e. the QskProgressIndicator::Groove subcontrol.

See also: extent(), extentChanged(), resetExtent()

Definition at line 134 of file QskProgressIndicator.cpp.

◆ setFillGradient()

void QskProgressIndicator::setFillGradient ( const QskGradient & gradient )

Sets the fill gradient by setting the gradient hint of the QskProgressIndicator::Fill subcontrol.

See also: fillGradient(), resetFillGradient()

Definition at line 119 of file QskProgressIndicator.cpp.

◆ setIndeterminate()

void QskProgressIndicator::setIndeterminate ( bool on = true )

Sets whether the progress indicator is indeterminate.

See also: isIndeterminate(), indeterminateChanged()

Definition at line 107 of file QskProgressIndicator.cpp.

◆ setOrigin

void QskProgressIndicator::setOrigin ( qreal origin )

slot

Sets the origin.

See also: origin(), hasOrigin(), originChanged(), resetOrigin()

Definition at line 154 of file QskProgressIndicator.cpp.

◆ setValue

void QskProgressIndicator::setValue ( qreal value )

slot

Sets the value to value. If value is outside of the boundaries(), it will be bound to this range.

See also: setValueAsRatio(), value(), valueChanged()

Definition at line 195 of file QskProgressIndicator.cpp.

◆ setValueAsRatio

void QskProgressIndicator::setValueAsRatio ( qreal ratio )

slot

Sets the value as ratio of [0.0, 1.0].

If ratio is outside of this range, it will be bound to the interval [0.0, 1.0], i.e. if it is smaller than 0, it will be set to 0, and if it is greater than 1, it will be set to 1.

See also: valueAsRatio(), value(), setValue(), valueChanged()

Definition at line 208 of file QskProgressIndicator.cpp.

◆ value()

qreal QskProgressIndicator::value ( ) const

Returns the current value.

See also: valueAsRatio(), setValue(), valueChanged()

Definition at line 203 of file QskProgressIndicator.cpp.

◆ valueAsRatio() [1/2]

qreal QskProgressIndicator::valueAsRatio ( ) const

Returns the current value as ratio, i.e. as percentage in the range of [0.0, 1.0].

The ratio is calculated like this: ratio = (value() - minimum()) / (maximum() - minimum()).

See also: value(), setValueAsRatio(), valueChanged()

Definition at line 214 of file QskProgressIndicator.cpp.

◆ valueAsRatio() [2/2]

qreal QskBoundedControl::valueAsRatio ( qreal value ) const

Definition at line 37 of file QskBoundedControl.cpp.

◆ valueChanged

QskProgressIndicator::valueChanged ( qreal )

signal

Will be emitted when the value changes.

See also: value(), valueAsRatio(), setValue(), setValueAsRatio()

Member Data Documentation

◆ Fill

QskProgressIndicator::Fill

static

Showing the current value of the indicator; is drawn above the QskProgressIndicator::Groove.

Definition at line 33 of file QskProgressIndicator.h.

◆ Groove

QskProgressIndicator::Groove

static

Indicating the value range that the indicator can have; is drawn below the QskProgressIndicator::Fill.

Definition at line 33 of file QskProgressIndicator.h.

Property Documentation

◆ extent

qreal QskProgressIndicator::extent

readwrite

The extent of the indicator.

Access functions:: extent(), setExtent(), extentChanged(), resetExtent()

Definition at line 17 of file QskProgressIndicator.h.

◆ indeterminate

bool QskProgressIndicator::indeterminate

readwrite

Whether the indicator is indeterminate or not.

Access functions:: isIndeterminate(), setIndeterminate(), indeterminateChanged()

Definition at line 20 of file QskProgressIndicator.h.

◆ origin

qreal QskProgressIndicator::origin

readwrite

The origin of the indicator.

Access functions:: qreal origin(), setOrigin(), originChanged(), resetOrigin()

Definition at line 23 of file QskProgressIndicator.h.

◆ value

qreal QskProgressIndicator::value

readwrite

The value of the indicator.

Access functions:: value(), setValue(), valueChanged()

Definition at line 26 of file QskProgressIndicator.h.

◆ valueAsRatio

qreal QskProgressIndicator::valueAsRatio

readwrite

The value of the indicator as ratio.

Access functions:: valueAsRatio(), setValueAsRatio(), valueChanged()

Definition at line 27 of file QskProgressIndicator.h.

Detailed Description

Public Slots

Signals

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ QskProgressIndicator() [1/3]

◆ QskProgressIndicator() [2/3]

◆ QskProgressIndicator() [3/3]

◆ ~QskProgressIndicator()

Member Function Documentation

◆ componentComplete()

◆ extent()

◆ extentChanged

◆ fillGradient()

◆ hasOrigin()

◆ indeterminateChanged

◆ isIndeterminate()

◆ itemChange()

◆ origin()

◆ originChanged

◆ resetExtent()

◆ resetFillGradient()

◆ resetOrigin()

◆ setExtent()

◆ setFillGradient()

◆ setIndeterminate()

◆ setOrigin

◆ setValue

◆ setValueAsRatio

◆ value()

◆ valueAsRatio() [1/2]

◆ valueAsRatio() [2/2]

◆ valueChanged

Member Data Documentation

◆ Fill

◆ Groove

Property Documentation

◆ extent

◆ indeterminate

◆ origin

◆ value

◆ valueAsRatio