albaWizardBlock Class Reference

#include <albaWizardBlock.h>

Inheritance diagram for albaWizardBlock:

Collaboration diagram for albaWizardBlock:

Public Member Functions
	albaWizardBlock (const char *name)
virtual	~albaWizardBlock ()
wxString	GetName ()
virtual void	SetNextBlock (const char *block)
virtual wxString	GetNextBlock ()
virtual void	Delete ()
albaString	GetDescriptionLabel ()
void	SetDescriptionLabel (const char *label)
void	SetNextBlockOnAbort (const char *label)
virtual void	Abort ()
void	SetBlockProgress (int progress)
int	GetBlockProgress ()

Protected Member Functions
virtual void	ExcutionBegin ()
virtual void	ExcutionEnd ()
void	SetSelectedVME (albaVME *node)
void	SetListener (albaObserver *Listener)
int	Success ()
virtual wxString	GetRequiredOperation ()

Protected Attributes
wxString	m_Name
wxString	m_BlockType
wxString	m_AbortBlock
wxString	m_NextBlock
albaVME *	m_SelectedVME
albaVME *	m_InputVME
int	m_Success
int	m_Running
albaObserver *	m_Listener
albaString	m_DescriptionLabel
long	m_BlockProgress

Friends
class	albaWizard

Detailed Description

Class Name: albaWizardBlock.

Class for the base wizard block, each block on a wizard must extend this block

Definition at line 36 of file albaWizardBlock.h.

Constructor & Destructor Documentation

albaWizardBlock()

albaWizardBlock::albaWizardBlock

(

const char *

name

)

Default constructor
Requires the name of the block "START","END" are reserved.

~albaWizardBlock()

virtual albaWizardBlock::~albaWizardBlock ( )

virtual

Default destructor.

Member Function Documentation

GetName()

wxString albaWizardBlock::GetName

(

)

Get the name of the block.

SetNextBlock()

virtual void albaWizardBlock::SetNextBlock ( const char *  block )

virtual

Set name of the Block called after operation.

There are some special blocks: WIZARD{<name>} Switch to the wizard <name> and execute it START Goes to the first block of the wizard END Exits from the wizard

Reimplemented in albaWizardBlockSelection, and albaWizardBlockYesNoSelection.

GetNextBlock()

virtual wxString albaWizardBlock::GetNextBlock ( )

virtual

Return the name of the Block witch will be executed after this.

Reimplemented in albaWizardBlockFileExistCheck, albaWizardBlockSelection, albaWizardBlockTypeCheck, and albaWizardBlockYesNoSelection.

Delete()

virtual void albaWizardBlock::Delete ( )

inlinevirtual

Called to clean up memory.

Definition at line 65 of file albaWizardBlock.h.

GetDescriptionLabel()

albaString albaWizardBlock::GetDescriptionLabel

(

)

Get a Label containing a description of the the current step.

SetDescriptionLabel()

void albaWizardBlock::SetDescriptionLabel

(

const char *

label

)

Set a Label containing a description of the the current step.

SetNextBlockOnAbort()

void albaWizardBlock::SetNextBlockOnAbort

(

const char *

label

)

Set a Label containing a description of the the current step.

Abort()

virtual void albaWizardBlock::Abort ( )

virtual

Abort the execution of the block.

SetBlockProgress()

void albaWizardBlock::SetBlockProgress ( int  progress )

inline

Set the progress associated to this block.

Definition at line 80 of file albaWizardBlock.h.

GetBlockProgress()

int albaWizardBlock::GetBlockProgress ( )

inline

Get the progress associated to this block.

Definition at line 83 of file albaWizardBlock.h.

ExcutionBegin()

virtual void albaWizardBlock::ExcutionBegin ( )

protectedvirtual

Starts the execution of the block.

Reimplemented in albaWizardBlockFileExistCheck, albaWizardBlockInformation, albaWizardBlockOperation, albaWizardBlockSelection, albaWizardBlockTypeCheck, albaWizardBlockVMEFindOrSelection, albaWizardBlockVMESelection, and albaWizardBlockYesNoSelection.

ExcutionEnd()

virtual void albaWizardBlock::ExcutionEnd ( )

protectedvirtual

Ends the execution of the block.

Reimplemented in albaWizardBlockOperation.

SetSelectedVME()

void albaWizardBlock::SetSelectedVME ( albaVME *  node )

protected

Set the selected VME, this function must be called before execution begin.

SetListener()

void albaWizardBlock::SetListener ( albaObserver *  Listener )

protected

Sets The event listener.

Success()

int albaWizardBlock::Success ( )

protected

Return true if the user has aborted the operation.

GetRequiredOperation()

virtual wxString albaWizardBlock::GetRequiredOperation ( )

protectedvirtual

Returns the name of the operation required by this block Return an empty string if no operation is required.

Reimplemented in albaWizardBlockOperation.

Friends And Related Function Documentation

albaWizard

friend class albaWizard

friend

Definition at line 120 of file albaWizardBlock.h.

Member Data Documentation

m_Name

wxString albaWizardBlock::m_Name

protected

Definition at line 106 of file albaWizardBlock.h.

m_BlockType

wxString albaWizardBlock::m_BlockType

protected

Definition at line 107 of file albaWizardBlock.h.

m_AbortBlock

wxString albaWizardBlock::m_AbortBlock

protected

Definition at line 108 of file albaWizardBlock.h.

m_NextBlock

wxString albaWizardBlock::m_NextBlock

protected

Definition at line 109 of file albaWizardBlock.h.

m_SelectedVME

albaVME* albaWizardBlock::m_SelectedVME

protected

Pointer to the current selected node.

Definition at line 110 of file albaWizardBlock.h.

m_InputVME

albaVME* albaWizardBlock::m_InputVME

protected

The vme selected on operation start.

Definition at line 111 of file albaWizardBlock.h.

m_Success

int albaWizardBlock::m_Success

protected

Definition at line 112 of file albaWizardBlock.h.

m_Running

int albaWizardBlock::m_Running

protected

Definition at line 113 of file albaWizardBlock.h.

m_Listener

albaObserver* albaWizardBlock::m_Listener

protected

Definition at line 114 of file albaWizardBlock.h.

m_DescriptionLabel

albaString albaWizardBlock::m_DescriptionLabel

protected

Definition at line 115 of file albaWizardBlock.h.

m_BlockProgress

long albaWizardBlock::m_BlockProgress

protected

Definition at line 116 of file albaWizardBlock.h.

---

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

• albaWizardBlock.h