FlowEngine::ProgressBarInterface Class Reference

#include <ProgressBarInterface.h>

Inheritance diagram for FlowEngine::ProgressBarInterface:

Public Member Functions
virtual void	finish ()=0
virtual void	resetGlobalTicks (unsigned int nGlobalTicks, const char *nLoadingText)=0
virtual void	resetTicks (unsigned int nTicks, const char *nLoadingText)=0
virtual void	start (const char *nWindowTitle, bool nShowGlobalProgress, bool nShowCancelButton)=0
virtual void	update ()=0
virtual void	updateGlobal ()=0
virtual	~ProgressBarInterface ()=default

Detailed Description

Pure virtual Progress Bar interface.

Pure virtual progress bar interface. Override for your own gui.

Constructor & Destructor Documentation

~ProgressBarInterface()

virtual FlowEngine::ProgressBarInterface::~ProgressBarInterface ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

finish()

virtual void FlowEngine::ProgressBarInterface::finish ( )

pure virtual

Hide the loading bar.

Implemented in FlowEngine::ProgressBarEmpty.

resetGlobalTicks()

virtual void FlowEngine::ProgressBarInterface::resetGlobalTicks ( unsigned int  nGlobalTicks, const char *  nLoadingText  )

pure virtual

Set global progress bar ticks (if any) and reset the counter to 0

Parameters

nGlobalTicks	the number of steps to take in order for the main task to finish. when set to 0, the main task has an indefinite number of steps
nLoadingText	pointer to a null terminated string that names the current main task phase

Implemented in FlowEngine::ProgressBarEmpty.

resetTicks()

virtual void FlowEngine::ProgressBarInterface::resetTicks ( unsigned int  nTicks, const char *  nLoadingText  )

pure virtual

Set progress bar ticks and reset the counter to 0

Parameters

nTicks	the number of steps to take in order for the task to finish. when set to 0, the task has an indefinite number of steps
nLoadingText	pointer to a null terminated string that names the current task phase

Implemented in FlowEngine::ProgressBarEmpty.

start()

virtual void FlowEngine::ProgressBarInterface::start ( const char *  nWindowTitle, bool  nShowGlobalProgress, bool  nShowCancelButton  )

pure virtual

Show the progress bar

Parameters

nWindowTitle	a pointer to a null terminated string that names the main task
nShowGlobalProgress	when true, the progress is split in main and secondary tasks
nShowCancelButton	when true, the running task is cancellable

Implemented in FlowEngine::ProgressBarEmpty.

update()

virtual void FlowEngine::ProgressBarInterface::update ( )

pure virtual

Progress the loading bar - Add + 1 Tick.

Implemented in FlowEngine::ProgressBarEmpty.

updateGlobal()

virtual void FlowEngine::ProgressBarInterface::updateGlobal ( )

pure virtual

Progress the global progress bar - Add + 1 Tick.

Implemented in FlowEngine::ProgressBarEmpty.