alg_indicator.h File Reference

A progress indicator. More...

#include <tool_cstring.h>
#include <system_types.h>
#include <templ_visitor.h>
#include <math_define.h>
#include <mb_property_title.h>
#include <mb_enum.h>
#include <reference_item.h>
#include <tool_multithreading.h>

Classes
class	IStrData
	Data of a string. More...
class	StrData< T >
	Specific data of a string. More...
class	BaseStrVisitor
	Base class for thread-safe visitor extracting a string. More...
struct	BaseStrVisitor::BaseAuxiliaryData
	Visitor data. Manager providing thread-safe access to the data. More...
class	IGetMsg
	The getter of a string from string data. More...
class	IProgressIndicator
	Interface of the execution progress indicator. More...
class	ProgressBarWrapper
	The wrapper of the execution progress indicator. More...

Macros
#define	EMPTY_STR   StrData<const TCHAR *>( nullptr )
	Creation of an empty string.

Functions
bool	IsProgressStopped (IProgressIndicator *prog)
	Check the progress indicator stop. More...
ProgressBarWrapper *	CreateProgressBarAddRef (IProgressIndicator *progInd, IStrData &msg)
	< Create a progress indicator. More...
ProgressBarWrapper *	CreateProgressBar (IProgressIndicator *progInd, IStrData &msg)
	< Create a progress indicator. More...
bool	SetProgressBarName (ProgressBarWrapper *progBar, IStrData &msg)
	Set the progress name. More...
bool	SetProgressBarValue (ProgressBarWrapper *progBar, size_t v)
	Set the value of a progress. More...
bool	AddProgressBarValue (ProgressBarWrapper *progBar, size_t v)
	Increase the progress value by a given step. More...
void	FinishProgressBar (ProgressBarWrapper *progBar)
	End the progress indicator. More...
bool	StopProgressBar (ProgressBarWrapper *progBar)
	Delete the progress indicator. More...
bool	UseParentName (ProgressBarWrapper *progBar, bool useParentName)
	Whether to use the name of a parent for its successor. More...
bool	IsParentNameUsed (const ProgressBarWrapper *progBar)
	Whether the name of a parent is used for its successor. More...

Detailed Description

A progress indicator.