kanzi::StateManager::GoToDefinedStateMessageArguments Class Reference

Represents message arguments of GoToNextDefinedState message of state manager. More...

#include <kanzi/core.ui/state_manager/state_manager.hpp>

Inheritance diagram for kanzi::StateManager::GoToDefinedStateMessageArguments:
kanzi::StateManager::StateChangeMessageArguments kanzi::StateManager::StateManagerMessageArguments kanzi::MessageArguments kanzi::StateManager::GoToNextDefinedStateMessageArguments kanzi::StateManager::GoToPreviousDefinedStateMessageArguments

Public Member Functions

 GoToDefinedStateMessageArguments ()
 Constructor, do not use state manager message argument used in base message argument class. More...
 
bool isLoopStates () const
 
void setLoopStates (bool loopStates)
 
- Public Member Functions inherited from kanzi::StateManager::StateChangeMessageArguments
 StateChangeMessageArguments (StateManager *stateManager)
 
bool isImmediate () const
 
void setImmediate (bool immediate)
 
- Public Member Functions inherited from kanzi::StateManager::StateManagerMessageArguments
 StateManagerMessageArguments (StateManager *stateManager)
 
string getStateGroup () const
 
void setStateGroup (const string &stateGroupName)
 
StateManagergetStateManager () const
 
- Public Member Functions inherited from kanzi::MessageArguments
 MessageArguments ()
 
 MessageArguments (AbstractMessageType messageType)
 
 ~MessageArguments ()
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 
bool isFrom (const Node &source) const
 
shared_ptr< NodegetSource () const
 
void setHandled (bool handled)
 
bool isHandled () const
 
chrono::milliseconds getTimestamp () const
 
KzuMessageDispatchergetDispatcher () const
 
AbstractMessageType getType () const
 
void setSource (Node *source)
 
void setTimestamp (chrono::milliseconds timestamp)
 
void setValid (bool valid)
 
bool isValid () const
 
void setDispatcher_internal (KzuMessageDispatcher *dispatcher)
 Internal function. More...
 
void setType_internal (AbstractMessageType type)
 Internal function. More...
 

Static Public Attributes

static PropertyType< bool > MessageArgumentStateManagerLoopStatesProperty
 MessageArgumentStateManagerLoopStates property. More...
 
- Static Public Attributes inherited from kanzi::StateManager::StateChangeMessageArguments
static PropertyType< bool > MessageArgumentStateManagerImmediateProperty
 MessageArgumentStateManagerImmediate property. More...
 
- Static Public Attributes inherited from kanzi::StateManager::StateManagerMessageArguments
static PropertyType< string > MessageArgumentStateManagerStateGroupProperty
 MessageArgumentStateManagerStateGroup property. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::MessageArguments
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Detailed Description

Represents message arguments of GoToNextDefinedState message of state manager.

Constructor & Destructor Documentation

kanzi::StateManager::GoToDefinedStateMessageArguments::GoToDefinedStateMessageArguments ( )
inlineexplicit

Constructor, do not use state manager message argument used in base message argument class.

Member Function Documentation

bool kanzi::StateManager::GoToDefinedStateMessageArguments::isLoopStates ( ) const
inline
void kanzi::StateManager::GoToDefinedStateMessageArguments::setLoopStates ( bool  loopStates)
inline

Member Data Documentation

PropertyType<bool> kanzi::StateManager::GoToDefinedStateMessageArguments::MessageArgumentStateManagerLoopStatesProperty
static

MessageArgumentStateManagerLoopStates property.

The default value is true.

See also
setMessageArgumentStateManagerLoopStates(), isMessageArgumentStateManagerLoopStates()

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