StateManager Class Reference

#include "stage/ctrl/state-manager.hpp"

Description

Interface: handling of persistent interface state.

Operations to retrieve previously captured state and to re-play this state towards the originating UI-elements. It is assumed that the actual implementation is connected to the UI-Bus and captures state mark notifications. State is first grouped by ID of the originating interface element, and recorded per distinct property within each element.

Definition at line 70 of file state-manager.hpp.

Public Member Functions
virtual StateMark	currentState (ID uiElm, string propertyKey) const =0
virtual void	replayState (ID uiElm, string propertyKey)=0
virtual void	replayAllState ()=0
virtual void	replayAllState (string propertyKey)=0
virtual void	replayAllProperties (ID uiElm)=0
virtual void	clearState ()=0

Protected Types
using	ID = lib::idi::BareEntryID const &
using	StateMark = lib::diff::GenNode const &

Protected Member Functions
virtual	~StateManager ()
	this is an interface

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

~StateManager()

~StateManager ( )

protectedvirtual

this is an interface

Definition at line 38 of file ui-state.cpp.

Member Typedef Documentation

ID

using ID = lib::idi::BareEntryID const&

protected

Definition at line 76 of file state-manager.hpp.

StateMark

using StateMark = lib::diff::GenNode const&

protected

Definition at line 77 of file state-manager.hpp.

Member Function Documentation

currentState()

virtual StateMark currentState ( ID  uiElm, string  propertyKey  ) const

pure virtual

Implemented in StateRecorder.

replayState()

virtual void replayState ( ID  uiElm, string  propertyKey  )

pure virtual

Implemented in StateRecorder.

replayAllState() [1/2]

virtual void replayAllState ( )

pure virtual

Implemented in StateRecorder.

replayAllState() [2/2]

virtual void replayAllState ( string  propertyKey )

pure virtual

Implemented in StateRecorder.

replayAllProperties()

virtual void replayAllProperties ( ID  uiElm )

pure virtual

Implemented in StateRecorder.

clearState()

virtual void clearState ( )

pure virtual

Implemented in StateRecorder.

Inheritance diagram for StateManager:

Collaboration diagram for StateManager:

---

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

• state-manager.hpp
• ui-state.cpp