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

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

Inheritance diagram for kanzi::StateManager::GoToStateMessageArguments:

Public Member Functions
string	getState () const

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

void	setState (const string &stateName)

Public Member Functions inherited from kanzi::StateManager::StateChangeMessageArguments
bool	isImmediate () const

void	setImmediate (bool immediate)

	StateChangeMessageArguments ()

	StateChangeMessageArguments (StateManagerSharedPtr stateManager)

Public Member Functions inherited from kanzi::StateManager::StateManagerMessageArguments
string	getStateGroup () const

StateManagerSharedPtr	getStateManager () const

void	setStateGroup (const string &stateGroupName)

	StateManagerMessageArguments ()

	StateManagerMessageArguments (StateManagerSharedPtr stateManager)

Public Member Functions inherited from kanzi::MessageArguments
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
	Returns the value of an argument using AbstractPropertyType.

template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

detail::MessageDispatcher *	getDispatcher () const
	Returns the message dispatcher that dispatches a message.

template<typename TDataType >
optional< TDataType >	getOptionalArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument.

shared_ptr< Node >	getSource () const
	Returns the source node for a message.

TimePoint	getTimestamp () const
	Returns the timestamp of a message.

AbstractMessageType	getType () const
	Returns the message type of these message arguments as an AbstractMessageType instance.

bool	isFrom (const Node &source) const
	Returns whether a node is the source node of a message.

bool	isHandled () const
	Returns whether the message is handled.

bool	isValid () const
	Returns whether a message is valid.

	MessageArguments ()=default
	Constructor.

	MessageArguments (const MessageArguments &)=delete
	Deleted copy.

MessageArguments &	operator= (const MessageArguments &)=delete
	Deleted assignment.

void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
	Sets the value of an argument using AbstractPropertyType.

template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
	Sets the value of an argument.

void	setDispatcher (detail::MessageDispatcher *dispatcher)
	Sets a dispatcher for a message.

void	setHandled (bool handled)
	Sets the handling status for a message.

void	setSource (Node *source)
	Sets the source node that dispatches a message.

void	setTimestamp (TimePoint timestamp)
	Sets the timestamp of a message.

void	setType (AbstractMessageType type)
	Sets the type of a message.

void	setValid (bool valid)
	Sets the validity of a message.

	~MessageArguments ()
	Destructor.

Static Public Attributes
Properties
static PropertyType< string >	MessageArgumentStateManagerStateProperty
	MessageArgumentStateManagerState property.

Static Public Attributes inherited from kanzi::StateManager::StateChangeMessageArguments
static PropertyType< bool >	MessageArgumentStateManagerImmediateProperty
	MessageArgumentStateManagerImmediate property.

Static Public Attributes inherited from kanzi::StateManager::StateManagerMessageArguments
static PropertyType< string >	MessageArgumentStateManagerStateGroupProperty
	MessageArgumentStateManagerStateGroup property.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::MessageArguments
static size_t	getArgumentAllocatorPoolSize ()
	Gets the current size of memory pool of argument entries.

static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information.

Detailed Description

Represents message arguments of GoToState message of state manager.

Constructor & Destructor Documentation

◆ GoToStateMessageArguments()

kanzi::StateManager::GoToStateMessageArguments::GoToStateMessageArguments ( )

inlineexplicit

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

Member Function Documentation

◆ getState()

string kanzi::StateManager::GoToStateMessageArguments::getState ( ) const

inline

◆ setState()

void kanzi::StateManager::GoToStateMessageArguments::setState ( const string & stateName )

inline

Member Data Documentation

◆ MessageArgumentStateManagerStateProperty

PropertyType<string> kanzi::StateManager::GoToStateMessageArguments::MessageArgumentStateManagerStateProperty

static

MessageArgumentStateManagerState property.

The default value is "".

See also: setMessageArgumentStateManagerState(), getMessageArgumentStateManagerState()

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

kanzi/core.ui/state_manager/state_manager.hpp

Public Member Functions

Static Public Attributes

Additional Inherited Members