albaProgressBarHelper Class Reference

#include <albaProgressBarHelper.h>

Collaboration diagram for albaProgressBarHelper:

Public Member Functions
	albaProgressBarHelper (albaObserver *listener)
virtual	~albaProgressBarHelper ()
void	InitProgressBar (wxString label="", bool showBusyCursor=true)
void	CloseProgressBar ()
void	UpdateProgressBar (long progress)
void	ResetProgress ()
void	SetBarText (albaString text)
bool	GetTextMode ()
void	SetTextMode (bool textMode)

Protected Attributes
bool	m_TextMode
bool	m_Inited
long	m_Progress
albaGUIBusyInfo *	m_BusyInfo
wxBusyCursor *	m_BusyCursor
albaObserver *	m_Listener

Detailed Description

albaProgressBarHelper Is an helper for manage progress bar advance

Definition at line 30 of file albaProgressBarHelper.h.

Constructor & Destructor Documentation

albaProgressBarHelper()

albaProgressBarHelper::albaProgressBarHelper

(

albaObserver *

listener

)

~albaProgressBarHelper()

virtual albaProgressBarHelper::~albaProgressBarHelper ( )

virtual

Member Function Documentation

InitProgressBar()

void albaProgressBarHelper::InitProgressBar	(	wxString	label = "",
		bool	showBusyCursor = true
	)

Init the Progress Bar, if label is not an empty string a busy info is created.

CloseProgressBar()

void albaProgressBarHelper::CloseProgressBar

(

)

Close the Progress Bar.

UpdateProgressBar()

void albaProgressBarHelper::UpdateProgressBar

(

long

progress

)

Updates the progress bar.

ResetProgress()

void albaProgressBarHelper::ResetProgress

(

)

Resets the progress to zero.

SetBarText()

void albaProgressBarHelper::SetBarText

(

albaString

text

)

Sets the progress bar text.

GetTextMode()

bool albaProgressBarHelper::GetTextMode

(

)

Get TextMode.

SetTextMode()

void albaProgressBarHelper::SetTextMode

(

bool

textMode

)

Set Text Mode, By default is off.

Member Data Documentation

m_TextMode

bool albaProgressBarHelper::m_TextMode

protected

Definition at line 61 of file albaProgressBarHelper.h.

m_Inited

bool albaProgressBarHelper::m_Inited

protected

Definition at line 62 of file albaProgressBarHelper.h.

m_Progress

long albaProgressBarHelper::m_Progress

protected

Definition at line 63 of file albaProgressBarHelper.h.

m_BusyInfo

albaGUIBusyInfo* albaProgressBarHelper::m_BusyInfo

protected

Definition at line 64 of file albaProgressBarHelper.h.

m_BusyCursor

wxBusyCursor* albaProgressBarHelper::m_BusyCursor

protected

Definition at line 65 of file albaProgressBarHelper.h.

m_Listener

albaObserver* albaProgressBarHelper::m_Listener

protected

Definition at line 66 of file albaProgressBarHelper.h.

---

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

• albaProgressBarHelper.h