MockProgressListener Class Reference

mock class to show how the Progress and ProgressListener classes work More...

Inheritance diagram for MockProgressListener:

Public Member Functions
void	OnProgressStatus (int a_stackIndex, double a_fractionComplete) override
	Listen to progress status. More...
int	OnBeginOperationString (const std::string &a_operation) override
	Listen to when operation begins. More...
void	OnEndOperation (int a_stackIndex) override
	Listen to when operation ends. More...
void	OnUpdateMessage (int a_stackIndex, const std::string &a_message) override
	Listen to when operation ends. More...
Public Member Functions inherited from xms::ProgressListener
virtual	~ProgressListener ()
	Destructor.

Public Attributes
std::string	m_messages
	stored up messages
int	m_stackIndex = 0
	the size of the progess stack

Additional Inherited Members
Static Public Member Functions inherited from xms::ProgressListener
static void	SetListener (BSHP< ProgressListener > a_listener)
	Set the current progress listener. More...
static BSHP< ProgressListener >	GetListener ()
	Get the current progress listener. More...

Detailed Description

mock class to show how the Progress and ProgressListener classes work

Definition at line 160 of file Progress.cpp.

Member Function Documentation

OnBeginOperationString()

int MockProgressListener::OnBeginOperationString ( const std::string &  a_operation )

inlineoverridevirtual

Listen to when operation begins.

Parameters

[in]

a_operation

the name of the operation

Returns

the ID for progress stack (0 for first)

Implements xms::ProgressListener.

Definition at line 182 of file Progress.cpp.

References xms::Progress::m_stackIndex.

OnEndOperation()

void MockProgressListener::OnEndOperation ( int  a_stackIndex )

inlineoverridevirtual

Listen to when operation ends.

Parameters

[in]

a_stackIndex

the ID for progress stack (0 for first)

Implements xms::ProgressListener.

Definition at line 195 of file Progress.cpp.

References xms::Progress::m_stackIndex.

OnProgressStatus()

void MockProgressListener::OnProgressStatus ( int  a_stackIndex, double  a_fractionComplete  )

inlineoverridevirtual

Listen to progress status.

Parameters

[in]	a_stackIndex	the ID for progress stack (0 for first)
[in]	a_fractionComplete	amount complete from 0.0 to 1.0

Implements xms::ProgressListener.

Definition at line 171 of file Progress.cpp.

OnUpdateMessage()

void MockProgressListener::OnUpdateMessage ( int  a_stackIndex, const std::string &  a_message  )

inlineoverridevirtual

Listen to when operation ends.

Parameters

[in]	a_stackIndex	the ID for progress stack (0 for first)
[in]	a_message	the new message for an operation

Implements xms::ProgressListener.

Definition at line 208 of file Progress.cpp.

---

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

• /home/conan/xmscore/misc/Progress.cpp