kanzi::ListBoxConcept::ItemSelectedMessageArguments Class Reference

Message arguments for the messages about the item selected event in a List Box node. More...

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

Inheritance diagram for kanzi::ListBoxConcept::ItemSelectedMessageArguments:

Public Member Functions
optional< size_t >	getPreviouslySelectedItemIndex () const
optional< size_t >	getSelectedItemIndex () const
void	setPreviouslySelectedItemIndex (optional< size_t > value)
void	setSelectedItemIndex (optional< 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. More...
template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument. More...
detail::MessageDispatcher *	getDispatcher () const
	Returns the message dispatcher that dispatches a message. More...
template<typename TDataType >
optional< TDataType >	getOptionalArgument (const PropertyType< TDataType > &argumentType) const
	Returns the value of an argument. More...
shared_ptr< Node >	getSource () const
	Returns the source node for a message. More...
TimePoint	getTimestamp () const
	Returns the timestamp of a message. More...
AbstractMessageType	getType () const
	Returns the message type of these message arguments as an AbstractMessageType instance. More...
bool	isFrom (const Node &source) const
	Returns whether a node is the source node of a message. More...
bool	isHandled () const
	Returns whether the message is handled. More...
bool	isValid () const
	Returns whether a message is valid. More...
	MessageArguments ()=default
	Constructor. More...
	MessageArguments (const MessageArguments &)=delete
	Deleted copy. More...
MessageArguments &	operator= (const MessageArguments &)=delete
	Deleted assignment. More...
void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
	Sets the value of an argument using AbstractPropertyType. More...
template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
	Sets the value of an argument. More...
void	setDispatcher (detail::MessageDispatcher *dispatcher)
	Sets a dispatcher for a message. More...
void	setHandled (bool handled)
	Sets the handling status for a message. More...
void	setSource (Node *source)
	Sets the source node that dispatches a message. More...
void	setTimestamp (TimePoint timestamp)
	Sets the timestamp of a message. More...
void	setType (AbstractMessageType type)
	Sets the type of a message. More...
void	setValid (bool valid)
	Sets the validity of a message. More...
	~MessageArguments ()
	Destructor. More...

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. More...
static const Metaclass *	getStaticMetaclass ()
	Initializes and returns static metadata of base MessageArguments class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Initializes and returns the Kanzi Studio editor information. More...

Static Public Attributes
Properties
static PropertyType< int >	SelectedItemIndexProperty
	SelectedItemIndex property. More...
static PropertyType< int >	PreviousSelectedItemIndexProperty
	PreviousSelectedItemIndex property. More...

Detailed Description

Message arguments for the messages about the item selected event in a List Box node.

These arguments hold the information about the selected item index and previously selected item index.

Member Function Documentation

getSelectedItemIndex()

optional<size_t> kanzi::ListBoxConcept::ItemSelectedMessageArguments::getSelectedItemIndex ( ) const

inline

setSelectedItemIndex()

void kanzi::ListBoxConcept::ItemSelectedMessageArguments::setSelectedItemIndex ( optional< size_t >  value )

inline

getPreviouslySelectedItemIndex()

optional<size_t> kanzi::ListBoxConcept::ItemSelectedMessageArguments::getPreviouslySelectedItemIndex ( ) const

inline

setPreviouslySelectedItemIndex()

void kanzi::ListBoxConcept::ItemSelectedMessageArguments::setPreviouslySelectedItemIndex ( optional< size_t >  value )

inline

makeEditorInfo()

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

static

Member Data Documentation

SelectedItemIndexProperty

PropertyType<int> kanzi::ListBoxConcept::ItemSelectedMessageArguments::SelectedItemIndexProperty

static

SelectedItemIndex property.

The default value is -1.

See also

setSelectedItemIndex(), getSelectedItemIndex()

PreviousSelectedItemIndexProperty

PropertyType<int> kanzi::ListBoxConcept::ItemSelectedMessageArguments::PreviousSelectedItemIndexProperty

static

PreviousSelectedItemIndex property.

The default value is -1.

See also

setPreviousSelectedItemIndex(), getPreviousSelectedItemIndex()

---

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

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