albaWizard Class Reference

#include <albaWizard.h>

Inheritance diagram for albaWizard:

Collaboration diagram for albaWizard:

Public Member Functions
	albaWizard ()
	albaWizard (const wxString &label, const wxString &name="")
	~albaWizard ()
void	SetMenuPath (wxString path)
wxString	GetMenuPath ()
wxString	GetLabel ()
wxString	GetName ()
virtual void	SetParameters (void *param)
void	ShowProgressBar (bool show=true)
bool	GetShowProgressBar ()

Protected Member Functions
virtual bool	Accept (albaVME *vme)
void	Execute ()
void	SetListener (albaObserver *Listener)
albaString	GetDescriptionTitle ()
void	SetId (int id)
int	GetId ()
void	AddBlock (albaWizardBlock *block)
virtual void	OnEvent (albaEventBase *alba_event)
void	ContinueExecution (int opSuccess)
void	SetSelectedVME (albaVME *node)

Protected Attributes
albaObserver *	m_Listener

Friends
class	albaWizardManager

Detailed Description

Class Name: albaWizard.

Class for wizard creation each wizard must extend this block

Definition at line 45 of file albaWizard.h.

Constructor & Destructor Documentation

albaWizard() [1/2]

albaWizard::albaWizard

(

)

Default constructor.

albaWizard() [2/2]

albaWizard::albaWizard	(	const wxString &	label,
		const wxString &	name = ""
	)

Default constructor.

~albaWizard()

albaWizard::~albaWizard

(

)

Default destructor.

Member Function Documentation

SetMenuPath()

void albaWizard::SetMenuPath

(

wxString

path

)

Sets the menu path.

GetMenuPath()

wxString albaWizard::GetMenuPath

(

)

Sets the menu path.

GetLabel()

wxString albaWizard::GetLabel

(

)

Return the Menu label of the wizard.

GetName()

wxString albaWizard::GetName

(

)

Return the name of the wizard.

SetParameters()

virtual void albaWizard::SetParameters ( void *  param )

inlinevirtual

Initialize wizard's variables according to the parameter's list.

Definition at line 72 of file albaWizard.h.

ShowProgressBar()

void albaWizard::ShowProgressBar ( bool  show = true )

inline

Enable/disable the visualization of the progress bar during the wizard.

Definition at line 75 of file albaWizard.h.

GetShowProgressBar()

bool albaWizard::GetShowProgressBar ( )

inline

Return true if progress bar show is enabled.

Definition at line 78 of file albaWizard.h.

Accept()

virtual bool albaWizard::Accept ( albaVME *  vme )

protectedvirtual

Return true for the acceptable vme type.

Execute()

void albaWizard::Execute ( )

protected

Execute the wizard.

SetListener()

void albaWizard::SetListener ( albaObserver *  Listener )

protected

Sets The event listener.

GetDescriptionTitle()

albaString albaWizard::GetDescriptionTitle ( )

protected

returns a description about current step in wizard

SetId()

void albaWizard::SetId ( int  id )

protected

Set the wizard id.

GetId()

int albaWizard::GetId ( )

protected

Get the wizard id.

AddBlock()

void albaWizard::AddBlock ( albaWizardBlock *  block )

protected

Add a new Block to the wizard Added blocks will be auto-deleted form the wizard.

OnEvent()

virtual void albaWizard::OnEvent ( albaEventBase *  alba_event )

protectedvirtual

Event management.

Implements albaObserver.

ContinueExecution()

void albaWizard::ContinueExecution ( int  opSuccess )

protected

Used to continue wizard execution after operation termination.

SetSelectedVME()

void albaWizard::SetSelectedVME ( albaVME *  node )

protected

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

Friends And Related Function Documentation

albaWizardManager

friend class albaWizardManager

friend

Definition at line 139 of file albaWizard.h.

Member Data Documentation

m_Listener

albaObserver* albaWizard::m_Listener

protected

Definition at line 112 of file albaWizard.h.

---

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

• albaWizard.h