#include <albaOp.h>

Inheritance diagram for albaOp:

[legend]

Collaboration diagram for albaOp:

[legend]

Public Types
enum	ALBAOP_ID { ID_HELP = MINID , MINID }

Public Member Functions
	albaTypeMacro (albaOp, albaObject)

	albaOp ()

	albaOp (const wxString &label)

virtual	~albaOp ()

void	SetListener (albaObserver *Listener)

int	GetType ()

virtual void	OnEvent (albaEventBase *alba_event)

virtual albaOp *	Copy ()

virtual void	OpRun ()

virtual void	SetParameters (void *param)

virtual albaString	GetParameters ()

virtual void	OpDo ()

virtual void	OpUndo ()

virtual albaGUI *	GetGui ()

virtual void	SetInput (albaVME *vme)

virtual albaVME *	GetInput ()

virtual albaVME *	GetOutput ()

virtual void	SetOutput (albaVME *output)

bool	Accept (albaVME *vme)

void	EnableAccept (bool enable=true)

virtual bool	CanUndo ()

bool	IsInputPreserving ()

void	ShowGui ()

void	HideGui ()

virtual bool	OkEnabled ()

virtual void	ForceStopWithOk ()

virtual void	ForceStopWithCancel ()

bool	IsCompatible (long state)

virtual const char **	GetActions ()

void	SetMouse (albaDeviceButtonsPadMouse *mouse)

albaDeviceButtonsPadMouse *	GetMouse ()

void	TestModeOn ()

void	TestModeOff ()

bool	GetTestMode ()

void	SetCanundo (bool can_undo=true)

bool	GetCanundo ()

void	SetSetting (albaGUISettings *setting)

albaGUISettings *	GetSetting ()

virtual char **	GetIcon ()

Public Member Functions inherited from albaObserver
	albaObserver ()

virtual	~albaObserver ()

virtual void	OnEvent (albaEventBase *e)=0

Public Member Functions inherited from albaObject
	albaObject ()

virtual	~albaObject ()

virtual void	Delete ()

virtual const char *	GetTypeName () const

virtual bool	IsA (const char *type_name) const

virtual bool	IsA (const albaTypeID &type_id) const

virtual albaObject *	NewObjectInstance () const =0

virtual const albaTypeID &	GetTypeId () const

virtual void	Print (std::ostream &os, const int indent=0) const

	albaObject (const albaObject &c)

Public Attributes
wxString	m_Label

int	m_Id

albaOp *	m_Next

long	m_Compatibility

wxMenuItem *	m_MenuItem

wxString	m_OpMenuPath

Protected Member Functions
virtual bool	InternalAccept (albaVME *vme)

virtual void	OpStop (int result)

Protected Attributes
albaVME *	m_Input

albaVME *	m_Output

albaGUI *	m_Gui

albaGUIHolder *	m_Guih

bool	m_Canundo

int	m_OpType

bool	m_InputPreserving

albaObserver *	m_Listener

albaDeviceButtonsPadMouse *	m_Mouse

albaGUISettings *	m_SettingPanel

bool	m_TestMode

bool	m_EnableAccept

Protected Attributes inherited from albaObject
bool	m_HeapFlag

Additional Inherited Members
Static Public Member Functions inherited from albaObject
static const char *	GetStaticTypeName ()

static bool	IsStaticType (const char *type_name)

static bool	IsStaticType (const albaTypeID &type_id)

static const albaTypeID &	GetStaticTypeId ()

static albaObject *	SafeDownCast (albaObject *o)

Detailed Description

Definition at line 50 of file albaOp.h.

Member Enumeration Documentation

◆ ALBAOP_ID

enum albaOp::ALBAOP_ID

Enumerator
ID_HELP
MINID

Definition at line 53 of file albaOp.h.

Constructor & Destructor Documentation

◆ albaOp() [1/2]

albaOp::albaOp ( )

◆ albaOp() [2/2]

albaOp::albaOp ( const wxString & label )

◆ ~albaOp()

virtual albaOp::~albaOp ( )

virtual

Member Function Documentation

◆ albaTypeMacro()

albaOp::albaTypeMacro	(	albaOp	,
		albaObject
	)

◆ SetListener()

void albaOp::SetListener ( albaObserver * Listener )

inline

Definition at line 64 of file albaOp.h.

◆ GetType()

int albaOp::GetType ( )

Return the type of the operation: OPTYPE_OP, OPTYPE_IMPORTER, OPTYPE_EXPORTER, OPTYPE_EDIT or OPTYPE_STATECHANGER.

◆ OnEvent()

virtual void albaOp::OnEvent ( albaEventBase * e )

virtual

process the events sent by subjects

Implements albaObserver.

Reimplemented in albaWizardWaitOp.

◆ Copy()

virtual albaOp * albaOp::Copy ( )

virtual

Reimplemented in albaWizardWaitOp, albaOpSelect, albaOpCut, albaOpCopy, albaOpPaste, and albaOpRename.

◆ OpRun()

virtual void albaOp::OpRun ( )

virtual

Builds operation's interface.

Reimplemented in albaWizardWaitOp, albaOpSelect, and albaOpEdit.

◆ SetParameters()

virtual void albaOp::SetParameters ( void * param )

inlinevirtual

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

Definition at line 76 of file albaOp.h.

◆ GetParameters()

virtual albaString albaOp::GetParameters ( )

inlinevirtual

Return parameters used by operation.

Definition at line 79 of file albaOp.h.

◆ OpDo()

virtual void albaOp::OpDo ( )

virtual

Execute the operation.

Reimplemented in albaOpSelect, albaOpCut, albaOpCopy, albaOpPaste, and albaOpRename.

◆ OpUndo()

virtual void albaOp::OpUndo ( )

virtual

Makes the undo for the operation.

Reimplemented in albaOpSelect, albaOpCut, albaOpCopy, albaOpPaste, and albaOpRename.

◆ GetGui()

virtual albaGUI * albaOp::GetGui ( )

inlinevirtual

Return the operation's interface.

Definition at line 88 of file albaOp.h.

◆ SetInput()

virtual void albaOp::SetInput ( albaVME * vme )

inlinevirtual

Set/Get the input vme for the operation.

Reimplemented in albaOpSelect, and albaOpEdit.

Definition at line 91 of file albaOp.h.

◆ GetInput()

virtual albaVME * albaOp::GetInput ( )

inlinevirtual

Reimplemented in albaOpSelect.

Definition at line 92 of file albaOp.h.

◆ GetOutput()

virtual albaVME * albaOp::GetOutput ( )

inlinevirtual

Return the albaVME result of the operation.

Definition at line 95 of file albaOp.h.

◆ SetOutput()

virtual void albaOp::SetOutput ( albaVME * output )

inlinevirtual

Definition at line 96 of file albaOp.h.

◆ Accept()

bool albaOp::Accept ( albaVME * vme )

Return true for the acceptable vme type.

◆ EnableAccept()

void albaOp::EnableAccept ( bool enable = true )

inline

Definition at line 101 of file albaOp.h.

◆ CanUndo()

virtual bool albaOp::CanUndo ( )

virtual

Return true if the operation is undoable.

◆ IsInputPreserving()

bool albaOp::IsInputPreserving ( )

inline

Return true if the operation preserve the input vme.

Definition at line 107 of file albaOp.h.

◆ ShowGui()

void albaOp::ShowGui ( )

Puts the operation's interface into the gui holder and send the event to plug the interface on the side bar.

◆ HideGui()

void albaOp::HideGui ( )

Send the event to remove the interface from the side bar.

◆ OkEnabled()

virtual bool albaOp::OkEnabled ( )

virtual

Return true if the OK button in operation's interface is enabled.

◆ ForceStopWithOk()

virtual void albaOp::ForceStopWithOk ( )

virtual

Stop operation with OK condition.

◆ ForceStopWithCancel()

virtual void albaOp::ForceStopWithCancel ( )

virtual

Stop operation with CANCEL condition.

◆ IsCompatible()

bool albaOp::IsCompatible ( long state )

◆ GetActions()

virtual const char ** albaOp::GetActions ( )

inlinevirtual

Definition at line 135 of file albaOp.h.

◆ SetMouse()

void albaOp::SetMouse ( albaDeviceButtonsPadMouse * mouse )

Initialize the mouse device.

◆ GetMouse()

albaDeviceButtonsPadMouse * albaOp::GetMouse ( )

inline

Definition at line 139 of file albaOp.h.

◆ TestModeOn()

void albaOp::TestModeOn ( )

inline

Turn On m_TestMode flag.

The m_TestMode flag is used to exclude the execution of splash screen or wxBusyInfo that conflicts with test machine.

Definition at line 143 of file albaOp.h.

◆ TestModeOff()

void albaOp::TestModeOff ( )

inline

Used to turn off m_TestMode flag.

Definition at line 146 of file albaOp.h.

◆ GetTestMode()

bool albaOp::GetTestMode ( )

inline

Get TestMode.

Definition at line 149 of file albaOp.h.

◆ SetCanundo()

void albaOp::SetCanundo ( bool can_undo = true )

inline

Set the Canundo flag for the operation when is plugged.

Definition at line 152 of file albaOp.h.

◆ GetCanundo()

bool albaOp::GetCanundo ( )

inline

Return the Canundo flag for the operation.

Definition at line 155 of file albaOp.h.

◆ SetSetting()

void albaOp::SetSetting ( albaGUISettings * setting )

inline

Set the reference to the operation's setting panel.

Definition at line 158 of file albaOp.h.

◆ GetSetting()

albaGUISettings * albaOp::GetSetting ( )

inline

Get the reference to the operation's setting panel.

Definition at line 161 of file albaOp.h.

◆ GetIcon()

virtual char ** albaOp::GetIcon ( )

virtual

Return an xpm-icon that can be used to represent this operation.

◆ InternalAccept()

virtual bool albaOp::InternalAccept ( albaVME * vme )

protectedvirtual

Return true for the acceptable vme type.

◆ OpStop()

virtual void albaOp::OpStop ( int result )

protectedvirtual

This method is called at the end of the operation and result contain the wxOK or wxCANCEL.

Member Data Documentation

◆ m_Label

wxString albaOp::m_Label

Label of the operation that will appear on the SideBar tab.

Definition at line 124 of file albaOp.h.

◆ m_Id

int albaOp::m_Id

Index of the operation referring to the operation list.

Definition at line 125 of file albaOp.h.

◆ m_Next

albaOp* albaOp::m_Next

Pointer to the next operation in the operation's list.

Definition at line 126 of file albaOp.h.

◆ m_Compatibility

long albaOp::m_Compatibility

Definition at line 129 of file albaOp.h.

◆ m_MenuItem

wxMenuItem* albaOp::m_MenuItem

Definition at line 131 of file albaOp.h.

◆ m_OpMenuPath

wxString albaOp::m_OpMenuPath

Definition at line 132 of file albaOp.h.

◆ m_Input

albaVME* albaOp::m_Input

protected

Pointer to the Input VME.

Definition at line 174 of file albaOp.h.

◆ m_Output

albaVME* albaOp::m_Output

protected

Pointer to the Output VME.

Definition at line 175 of file albaOp.h.

◆ m_Gui

albaGUI* albaOp::m_Gui

protected

Pointer to the operation's GUI.

Definition at line 176 of file albaOp.h.

◆ m_Guih

albaGUIHolder* albaOp::m_Guih

protected

Definition at line 177 of file albaOp.h.

◆ m_Canundo

bool albaOp::m_Canundo

protected

Flag to establish if the operation define the UnDo method or not.

Definition at line 178 of file albaOp.h.

◆ m_OpType

int albaOp::m_OpType

protected

Store the type of the operation: OPTYPE_OP, OPTYPE_IMPORTER, OPTYPE_EXPORTER.

Definition at line 179 of file albaOp.h.

◆ m_InputPreserving

bool albaOp::m_InputPreserving

protected

Flag to say if the operation change the input data (m_InputPreserving = false) or not.

Definition at line 180 of file albaOp.h.

◆ m_Listener

albaObserver* albaOp::m_Listener

protected

Definition at line 181 of file albaOp.h.

◆ m_Mouse

albaDeviceButtonsPadMouse* albaOp::m_Mouse

protected

Definition at line 182 of file albaOp.h.

◆ m_SettingPanel

albaGUISettings* albaOp::m_SettingPanel

protected

Definition at line 183 of file albaOp.h.

◆ m_TestMode

bool albaOp::m_TestMode

protected

Flag used with cppunitTest: put this flag at true when executing tests to avoid busy-info or splash screen to be created, default is false.

Definition at line 184 of file albaOp.h.

◆ m_EnableAccept

bool albaOp::m_EnableAccept

protected

Definition at line 185 of file albaOp.h.

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

albaOp.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ALBAOP_ID

Constructor & Destructor Documentation

◆ albaOp() [1/2]

◆ albaOp() [2/2]

◆ ~albaOp()

Member Function Documentation

◆ albaTypeMacro()

◆ SetListener()

◆ GetType()

◆ OnEvent()

◆ Copy()

◆ OpRun()

◆ SetParameters()

◆ GetParameters()

◆ OpDo()

◆ OpUndo()

◆ GetGui()

◆ SetInput()

◆ GetInput()

◆ GetOutput()

◆ SetOutput()

◆ Accept()

◆ EnableAccept()

◆ CanUndo()

◆ IsInputPreserving()

◆ ShowGui()

◆ HideGui()

◆ OkEnabled()

◆ ForceStopWithOk()

◆ ForceStopWithCancel()

◆ IsCompatible()

◆ GetActions()

◆ SetMouse()

◆ GetMouse()

◆ TestModeOn()

◆ TestModeOff()

◆ GetTestMode()

◆ SetCanundo()

◆ GetCanundo()

◆ SetSetting()

◆ GetSetting()

◆ GetIcon()

◆ InternalAccept()

◆ OpStop()

Member Data Documentation

◆ m_Label

◆ m_Id

◆ m_Next

◆ m_Compatibility

◆ m_MenuItem

◆ m_OpMenuPath

◆ m_Input

◆ m_Output

◆ m_Gui

◆ m_Guih

◆ m_Canundo

◆ m_OpType

◆ m_InputPreserving

◆ m_Listener

◆ m_Mouse

◆ m_SettingPanel

◆ m_TestMode

◆ m_EnableAccept