kanzi::ListBoxConcept::ItemMessageArguments Class Reference

Base class for item-related message arguments. More...

#include <kanzi/ui/node/concept/list_box.hpp>

Inheritance diagram for kanzi::ListBoxConcept::ItemMessageArguments:

Public Member Functions
NodeSharedPtr	getItem () const
optional< size_t >	getItemIndex () const
void	setItem (NodeSharedPtr value)
void	setItemIndex (size_t value)
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 Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
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.

Static Public Attributes
Properties
static PropertyType< int >	ItemIndexProperty
	ItemIndex property.
static PropertyType< void * >	ItemProperty
	Item property.

Detailed Description

Base class for item-related message arguments.

Member Function Documentation

getItemIndex()

optional< size_t > kanzi::ListBoxConcept::ItemMessageArguments::getItemIndex ( ) const

inline

setItemIndex()

void kanzi::ListBoxConcept::ItemMessageArguments::setItemIndex ( size_t value )

inline

getItem()

NodeSharedPtr kanzi::ListBoxConcept::ItemMessageArguments::getItem ( ) const

inline

setItem()

void kanzi::ListBoxConcept::ItemMessageArguments::setItem ( NodeSharedPtr value )

inline

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxConcept::ItemMessageArguments::makeEditorInfo ( )

static

Member Data Documentation

ItemIndexProperty

PropertyType<int> kanzi::ListBoxConcept::ItemMessageArguments::ItemIndexProperty

static

ItemIndex property.

The default value is -1.

See also

setItemIndex(), getItemIndex()

ItemProperty

PropertyType<void*> kanzi::ListBoxConcept::ItemMessageArguments::ItemProperty

static

Item property.

The default value is nullptr.

See also

setItem(), getItem()

---

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

• kanzi/ui/node/concept/list_box.hpp