Struct describing the current execution state of a TOOL. More...

Public Member Functions
	TOOL_STATE (TOOL_BASE *aTool)

	TOOL_STATE (const TOOL_STATE &aState)

	~TOOL_STATE ()

TOOL_STATE &	operator= (const TOOL_STATE &aState)

bool	operator== (const TOOL_MANAGER::TOOL_STATE &aRhs) const

bool	operator!= (const TOOL_MANAGER::TOOL_STATE &aRhs) const

void	Push ()
	Store the current state of the tool on stack. More...

bool	Pop ()
	Restore state of the tool from stack. More...

Public Attributes
TOOL_BASE *	theTool
	The tool itself. More...

bool	idle
	Is the tool active (pending execution) or disabled at the moment. More...

bool	shutdown
	Should the tool shutdown during next execution. More...

bool	pendingWait
	Flag defining if the tool is waiting for any event (i.e. More...

bool	pendingContextMenu
	Is there a context menu being displayed. More...

ACTION_MENU *	contextMenu
	Context menu currently used by the tool. More...

CONTEXT_MENU_TRIGGER	contextMenuTrigger
	Defines when the context menu is opened. More...

COROUTINE< int, const TOOL_EVENT & > *	cofunc
	Tool execution context. More...

TOOL_EVENT	initialEvent
	The first event that triggered activation of the tool. More...

TOOL_EVENT	wakeupEvent
	The event that triggered the execution/wakeup of the tool after Wait() call. More...

TOOL_EVENT_LIST	waitEvents
	List of events the tool is currently waiting for. More...

std::vector< TRANSITION >	transitions
	List of possible transitions (ie. More...

KIGFX::VC_SETTINGS	vcSettings
	VIEW_CONTROLS settings to preserve settings when the tools are switched. More...

Private Member Functions
void	clear ()

Private Attributes
std::stack< std::unique_ptr< TOOL_STATE > >	stateStack
	< Stack preserving previous states of a TOOL. More...

Detailed Description

Struct describing the current execution state of a TOOL.

Definition at line 51 of file tool_manager.cpp.

Constructor & Destructor Documentation

◆ TOOL_STATE() [1/2]

TOOL_MANAGER::TOOL_STATE::TOOL_STATE ( TOOL_BASE * aTool )

inline

Definition at line 53 of file tool_manager.cpp.

 :
 theTool( aTool )
 {
 clear();
 }

References clear().

◆ TOOL_STATE() [2/2]

TOOL_MANAGER::TOOL_STATE::TOOL_STATE ( const TOOL_STATE & aState )

inline

Definition at line 59 of file tool_manager.cpp.

 {
 theTool = aState.theTool;
 idle = aState.idle;
 shutdown = aState.shutdown;
 pendingWait = aState.pendingWait;
 pendingContextMenu = aState.pendingContextMenu;
 contextMenu = aState.contextMenu;
 contextMenuTrigger = aState.contextMenuTrigger;
 cofunc = aState.cofunc;
 initialEvent = aState.initialEvent;
 wakeupEvent = aState.wakeupEvent;
 waitEvents = aState.waitEvents;
 transitions = aState.transitions;
 vcSettings = aState.vcSettings;
 // do not copy stateStack
 }

References cofunc, contextMenu, contextMenuTrigger, idle, initialEvent, pendingContextMenu, pendingWait, shutdown, theTool, transitions, vcSettings, waitEvents, and wakeupEvent.

◆ ~TOOL_STATE()

TOOL_MANAGER::TOOL_STATE::~TOOL_STATE ( )

inline

Definition at line 77 of file tool_manager.cpp.

 {
 if( !stateStack.empty() )
 wxFAIL;
 }

References stateStack.

Member Function Documentation

◆ clear()

void TOOL_MANAGER::TOOL_STATE::clear ( )

inlineprivate

Definition at line 192 of file tool_manager.cpp.

 {
 idle = true;
 shutdown = false;
 pendingWait = false;
 pendingContextMenu = false;
 cofunc = nullptr;
 contextMenu = nullptr;
 contextMenuTrigger = CMENU_OFF;
 vcSettings.Reset();
 transitions.clear();
 }

References CMENU_OFF, cofunc, contextMenu, contextMenuTrigger, idle, pendingContextMenu, pendingWait, KIGFX::VC_SETTINGS::Reset(), shutdown, transitions, and vcSettings.

Referenced by Push(), and TOOL_STATE().

◆ operator!=()

bool TOOL_MANAGER::TOOL_STATE::operator!= ( const TOOL_MANAGER::TOOL_STATE & aRhs ) const

inline

Definition at line 148 of file tool_manager.cpp.

 {
 return aRhs.theTool != theTool;
 }

References theTool.

◆ operator=()

TOOL_STATE & TOOL_MANAGER::TOOL_STATE::operator= ( const TOOL_STATE & aState )

inline

Definition at line 124 of file tool_manager.cpp.

 {
 theTool = aState.theTool;
 idle = aState.idle;
 shutdown = aState.shutdown;
 pendingWait = aState.pendingWait;
 pendingContextMenu = aState.pendingContextMenu;
 contextMenu = aState.contextMenu;
 contextMenuTrigger = aState.contextMenuTrigger;
 cofunc = aState.cofunc;
 initialEvent = aState.initialEvent;
 wakeupEvent = aState.wakeupEvent;
 waitEvents = aState.waitEvents;
 transitions = aState.transitions;
 vcSettings = aState.vcSettings;
 // do not copy stateStack
 return *this;
 }

References cofunc, contextMenu, contextMenuTrigger, idle, initialEvent, pendingContextMenu, pendingWait, shutdown, theTool, transitions, vcSettings, waitEvents, and wakeupEvent.

◆ operator==()

bool TOOL_MANAGER::TOOL_STATE::operator== ( const TOOL_MANAGER::TOOL_STATE & aRhs ) const

inline

Definition at line 143 of file tool_manager.cpp.

 {
 return aRhs.theTool == theTool;
 }

References theTool.

◆ Pop()

bool TOOL_MANAGER::TOOL_STATE::Pop ( )

inline

Restore state of the tool from stack.

Stacks are stored internally and are not shared between different TOOL_STATE objects.

Returns: True if state was restored, false if the stack was empty.

Definition at line 170 of file tool_manager.cpp.

 {
 delete cofunc;
 
 if( !stateStack.empty() )
 {
 *this = *stateStack.top().get();
 stateStack.pop();
 return true;
 }
 else
 {
 cofunc = nullptr;
 return false;
 }
 }

References cofunc, and stateStack.

Referenced by TOOL_MANAGER::finishTool().

◆ Push()

void TOOL_MANAGER::TOOL_STATE::Push ( )

inline

Store the current state of the tool on stack.

Stacks are stored internally and are not shared between different TOOL_STATE objects.

Definition at line 157 of file tool_manager.cpp.

 {
 auto state = std::make_unique<TOOL_STATE>( *this );
 stateStack.push( std::move( state ) );
 clear();
 }

References clear(), and stateStack.

Referenced by TOOL_MANAGER::dispatchInternal().

Member Data Documentation

◆ cofunc

COROUTINE<int, const TOOL_EVENT&>* TOOL_MANAGER::TOOL_STATE::cofunc

Tool execution context.

Definition at line 106 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), Pop(), TOOL_MANAGER::RunMainStack(), TOOL_MANAGER::ScheduleWait(), TOOL_MANAGER::ShutdownTool(), and TOOL_STATE().

◆ contextMenu

ACTION_MENU* TOOL_MANAGER::TOOL_STATE::contextMenu

Context menu currently used by the tool.

Definition at line 100 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), operator=(), TOOL_MANAGER::ScheduleContextMenu(), and TOOL_STATE().

◆ contextMenuTrigger

CONTEXT_MENU_TRIGGER TOOL_MANAGER::TOOL_STATE::contextMenuTrigger

Defines when the context menu is opened.

Definition at line 103 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), operator=(), TOOL_MANAGER::ScheduleContextMenu(), and TOOL_STATE().

◆ idle

bool TOOL_MANAGER::TOOL_STATE::idle

Is the tool active (pending execution) or disabled at the moment.

Definition at line 87 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::finishTool(), operator=(), and TOOL_STATE().

◆ initialEvent

TOOL_EVENT TOOL_MANAGER::TOOL_STATE::initialEvent

The first event that triggered activation of the tool.

Definition at line 109 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::dispatchInternal(), operator=(), and TOOL_STATE().

◆ pendingContextMenu

bool TOOL_MANAGER::TOOL_STATE::pendingContextMenu

Is there a context menu being displayed.

Definition at line 97 of file tool_manager.cpp.

Referenced by clear(), operator=(), and TOOL_STATE().

◆ pendingWait

bool TOOL_MANAGER::TOOL_STATE::pendingWait

Flag defining if the tool is waiting for any event (i.e.

if it issued a Wait() call).

Definition at line 94 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), TOOL_MANAGER::ShutdownTool(), and TOOL_STATE().

◆ shutdown

bool TOOL_MANAGER::TOOL_STATE::shutdown

Should the tool shutdown during next execution.

Definition at line 90 of file tool_manager.cpp.

Referenced by clear(), operator=(), TOOL_MANAGER::ScheduleWait(), TOOL_MANAGER::ShutdownTool(), and TOOL_STATE().

◆ stateStack

std::stack<std::unique_ptr<TOOL_STATE> > TOOL_MANAGER::TOOL_STATE::stateStack

private

< Stack preserving previous states of a TOOL.

Restores the initial state.

Definition at line 189 of file tool_manager.cpp.

Referenced by Pop(), Push(), and ~TOOL_STATE().

◆ theTool

TOOL_BASE* TOOL_MANAGER::TOOL_STATE::theTool

The tool itself.

Definition at line 84 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::finishTool(), operator!=(), operator=(), operator==(), TOOL_MANAGER::RegisterTool(), TOOL_MANAGER::saveViewControls(), TOOL_MANAGER::ShutdownTool(), and TOOL_STATE().

◆ transitions

std::vector<TRANSITION> TOOL_MANAGER::TOOL_STATE::transitions

List of possible transitions (ie.

association of events and state handlers that are executed upon the event reception

Definition at line 119 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleNextState(), and TOOL_STATE().

◆ vcSettings

KIGFX::VC_SETTINGS TOOL_MANAGER::TOOL_STATE::vcSettings

VIEW_CONTROLS settings to preserve settings when the tools are switched.

Definition at line 122 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::applyViewControls(), clear(), TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::saveViewControls(), and TOOL_STATE().

◆ waitEvents

TOOL_EVENT_LIST TOOL_MANAGER::TOOL_STATE::waitEvents

List of events the tool is currently waiting for.

Definition at line 115 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), TOOL_MANAGER::ShutdownTool(), and TOOL_STATE().

◆ wakeupEvent

TOOL_EVENT TOOL_MANAGER::TOOL_STATE::wakeupEvent

The event that triggered the execution/wakeup of the tool after Wait() call.

Definition at line 112 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), and TOOL_STATE().

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

tool_manager.cpp

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOOL_STATE() [1/2]

◆ TOOL_STATE() [2/2]

◆ ~TOOL_STATE()

Member Function Documentation

◆ clear()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ Pop()

◆ Push()

Member Data Documentation

◆ cofunc

◆ contextMenu

◆ contextMenuTrigger

◆ idle

◆ initialEvent

◆ pendingContextMenu

◆ pendingWait

◆ shutdown

◆ stateStack

◆ theTool

◆ transitions

◆ vcSettings

◆ waitEvents

◆ wakeupEvent