ALBA
Public Types | Public Member Functions | Protected Member Functions | List of all members
albaWizardBlockInformation Class Reference

#include <albaWizardBlockInformation.h>

Inheritance diagram for albaWizardBlockInformation:
Inheritance graph
[legend]
Collaboration diagram for albaWizardBlockInformation:
Collaboration graph
[legend]

Public Types

enum  WIZARD_INFO { WIZARD_INFO_SHOW_ID = MINID }
 

Public Member Functions

 albaWizardBlockInformation (const char *name)
 
 ~albaWizardBlockInformation ()
 
void SetWindowTitle (const char *Title)
 
wxString GetWindowTitle ()
 
void SetDescription (const char *description)
 
wxString GetDescription ()
 
void SetImage (const char *imageFilename)
 
wxString GetImage ()
 
void SetBoxLabel (const char *label)
 
wxString GetBoxLabel ()
 
void SetImagePositionToTop ()
 
bool GetImagePositionToTop ()
 
void SetImagePositionToLeft ()
 
bool GetImagePositionToLeft ()
 
void SetImagePath (const char *path)
 
wxString GetImagePath ()
 
- Public Member Functions inherited from albaWizardBlock
 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 OnEvent (albaEventBase *alba_event)
 
- Protected Member Functions inherited from albaWizardBlock
virtual void ExcutionBegin ()
 
virtual void ExcutionEnd ()
 
void SetSelectedVME (albaVME *node)
 
void SetListener (albaObserver *Listener)
 
int Success ()
 
virtual wxString GetRequiredOperation ()
 

Additional Inherited Members

- Protected Attributes inherited from albaWizardBlock
wxString m_Name
 
wxString m_BlockType
 
wxString m_AbortBlock
 
wxString m_NextBlock
 
albaVMEm_SelectedVME
 
albaVMEm_InputVME
 
int m_Success
 
int m_Running
 
albaObserverm_Listener
 
albaString m_DescriptionLabel
 
long m_BlockProgress
 

Detailed Description

Class Name: albaWizardSelectionBlock.

Class for create a multiple choice switch inside wizard graph

Definition at line 35 of file albaWizardBlockInformation.h.

Member Enumeration Documentation

◆ WIZARD_INFO

Enumerator
WIZARD_INFO_SHOW_ID 

Definition at line 39 of file albaWizardBlockInformation.h.

Constructor & Destructor Documentation

◆ albaWizardBlockInformation()

albaWizardBlockInformation::albaWizardBlockInformation ( const char *  name)

Default constructor.

◆ ~albaWizardBlockInformation()

albaWizardBlockInformation::~albaWizardBlockInformation ( )

Default destructor.

Member Function Documentation

◆ SetWindowTitle()

void albaWizardBlockInformation::SetWindowTitle ( const char *  Title)

Set The title of the information window.

◆ GetWindowTitle()

wxString albaWizardBlockInformation::GetWindowTitle ( )
inline

Get The title of the information window.

Definition at line 54 of file albaWizardBlockInformation.h.

◆ SetDescription()

void albaWizardBlockInformation::SetDescription ( const char *  description)

Set The description.

◆ GetDescription()

wxString albaWizardBlockInformation::GetDescription ( )
inline

Get The description.

Definition at line 60 of file albaWizardBlockInformation.h.

◆ SetImage()

void albaWizardBlockInformation::SetImage ( const char *  imageFilename)

Set name of the window image if no image is setted no image will be showed The image will be stored in <APP_DIR>\WizardImages.

◆ GetImage()

wxString albaWizardBlockInformation::GetImage ( )
inline

return current image filename

Definition at line 68 of file albaWizardBlockInformation.h.

◆ SetBoxLabel()

void albaWizardBlockInformation::SetBoxLabel ( const char *  label)

Set the description box Label.

◆ GetBoxLabel()

wxString albaWizardBlockInformation::GetBoxLabel ( )
inline

Get the description box Label.

Definition at line 74 of file albaWizardBlockInformation.h.

◆ SetImagePositionToTop()

void albaWizardBlockInformation::SetImagePositionToTop ( )

Set Image Position To Top.

◆ GetImagePositionToTop()

bool albaWizardBlockInformation::GetImagePositionToTop ( )
inline

return true if image Position is set to top

Definition at line 80 of file albaWizardBlockInformation.h.

◆ SetImagePositionToLeft()

void albaWizardBlockInformation::SetImagePositionToLeft ( )

Set Image Position To Left.

◆ GetImagePositionToLeft()

bool albaWizardBlockInformation::GetImagePositionToLeft ( )
inline

return true if image Position is set to left

Definition at line 86 of file albaWizardBlockInformation.h.

◆ SetImagePath()

void albaWizardBlockInformation::SetImagePath ( const char *  path)
inline

Set the images path (default path is <ApplicationDirectory>\WizardImages)

Definition at line 89 of file albaWizardBlockInformation.h.

◆ GetImagePath()

wxString albaWizardBlockInformation::GetImagePath ( )
inline

Get the images path.

Definition at line 92 of file albaWizardBlockInformation.h.

◆ ExcutionBegin()

virtual void albaWizardBlockInformation::ExcutionBegin ( )
protectedvirtual

Starts the execution of the block.

Reimplemented from albaWizardBlock.

◆ OnEvent()

virtual void albaWizardBlockInformation::OnEvent ( albaEventBase alba_event)
protectedvirtual

Event management.

Implements albaObserver.


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