xiiProgress Class Reference

#include <Progress.h>

Public Member Functions
float	GetCompletion () const
	Returns the current overall progress in [0; 1] range.
void	SetCompletion (float fCompletion)
	Sets the current overall progress in [0; 1] range. Should not be called directly, typically called by xiiProgreesRange.
xiiStringView	GetMainDisplayText () const
	Returns the current 'headline' text for the progress bar.
xiiStringView	GetStepDisplayText () const
	Returns the current detail text for the progress bar.
void	UserClickedCancel ()
	Used to inform xiiProgress of outside user input. May have an effect or not.
bool	WasCanceled () const
	Whether the user requested to cancel the operation.
bool	AllowUserCancel () const
	Returns whether the current operations may be canceled or not.

Static Public Member Functions
static xiiProgress *	GetGlobalProgressbar ()
	Returns the currently set default xiiProgress instance. This will always be valid.
static void	SetGlobalProgressbar (xiiProgress *pProgress)
	Allows to set a custom xiiProgress instance as the global default instance.

Public Attributes
xiiEvent< const xiiProgressEvent & >	m_Events
	Events are sent when the progress changes.
void *	m_pUserData = nullptr
	Custom user data.

Friends
class	xiiProgressRange

Detailed Description

Manages the way a progress bar is subdivided and advanced.

xiiProgress represents a single progress bar. It can be sub-divided into groups and sub-groups using xiiProgressbarRange. From the ranges and the current advancement, a final progress percentage is computed. Every time a significant change takes place, an event is broadcast. This allows other code to display the progress, either in a GUI application or in a fullscreen loading screen or in any other way appropriate.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Utilities/Progress.h
• /home/runner/work/XII/XII/Source/Engine/Foundation/Utilities/Implementation/Progress.cpp