kanzi::MessageArguments Class Reference

Message arguments is the base class for arguments passed in messages. More...

#include <kanzi/core.ui/message/message_arguments.hpp>

Inheritance diagram for kanzi::MessageArguments:

Classes
struct	ArgumentEntry
	Linked list entry containing arguments type and value. More...

Public Member Functions
	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< Node >	getSource () const
void	setHandled (bool handled)
bool	isHandled () const
chrono::milliseconds	getTimestamp () const
KzuMessageDispatcher *	getDispatcher () 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 Member Functions
static size_t	getArgumentAllocatorPoolSize ()
	Gets the current size of memory pool of argument entries. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

Message arguments is the base class for arguments passed in messages.

Constructor & Destructor Documentation

kanzi::MessageArguments::MessageArguments ( )

explicit

kanzi::MessageArguments::MessageArguments ( AbstractMessageType  messageType )

explicit

kanzi::MessageArguments::~MessageArguments

(

)

Member Function Documentation

template<typename TDataType >

TDataType kanzi::MessageArguments::getArgument ( const PropertyType< TDataType > &  argumentType ) const

inline

bool kanzi::MessageArguments::getAbstractArgument	(	AbstractPropertyType	argumentType,
		Variant &	variant
	)		const

template<typename TDataType >

void kanzi::MessageArguments::setArgument ( const PropertyType< TDataType > &  argumentType, typename PropertyType< TDataType >::DataType  value  )

inline

void kanzi::MessageArguments::setAbstractArgument	(	AbstractPropertyType	argumentType,
		const Variant &	variant
	)

bool kanzi::MessageArguments::isFrom ( const Node &  source ) const

inline

shared_ptr<Node> kanzi::MessageArguments::getSource

(

)

const

void kanzi::MessageArguments::setHandled ( bool  handled )

inline

bool kanzi::MessageArguments::isHandled ( ) const

inline

chrono::milliseconds kanzi::MessageArguments::getTimestamp ( ) const

inline

KzuMessageDispatcher* kanzi::MessageArguments::getDispatcher ( ) const

inline

AbstractMessageType kanzi::MessageArguments::getType ( ) const

inline

void kanzi::MessageArguments::setSource ( Node *  source )

inline

void kanzi::MessageArguments::setTimestamp ( chrono::milliseconds  timestamp )

inline

void kanzi::MessageArguments::setValid ( bool  valid )

inline

bool kanzi::MessageArguments::isValid ( ) const

inline

void kanzi::MessageArguments::setDispatcher_internal ( KzuMessageDispatcher *  dispatcher )

inline

Internal function.

void kanzi::MessageArguments::setType_internal ( AbstractMessageType  type )

inline

Internal function.

static size_t kanzi::MessageArguments::getArgumentAllocatorPoolSize ( )

static

Gets the current size of memory pool of argument entries.

static PropertyTypeEditorInfoSharedPtr kanzi::MessageArguments::makeEditorInfo ( )

inlinestatic

---

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

• kanzi/core.ui/message/message_arguments.hpp