xiiProgressEvent Struct Reference

Through these events the state of a xiiProgress instance is communicated. More...

#include <Progress.h>

Public Types
enum class	Type { ProgressStarted , ProgressEnded , ProgressChanged , CancelClicked }

Public Attributes
Type	m_Type
xiiProgress *	m_pProgressbar

Detailed Description

Through these events the state of a xiiProgress instance is communicated.

Other code can use this to visualize the progress in different ways. For instance a GUI application can show a progress bar dialog and a game could show a loading screen.

Member Enumeration Documentation

Type

enum class xiiProgressEvent::Type

strong

Enumerator
ProgressStarted	Sent when the the first progress starts.
ProgressEnded	Sent when progress finishes or is canceled.
ProgressChanged	Sent whenever the progress value changes. Not necessarily in every update step.
CancelClicked	The user just clicked cancel (for the first time).

---

The documentation for this struct was generated from the following file:

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