Message arguments for the message about the set focus execution received on a List Box node. More...

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

Inheritance diagram for kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments:

Public Member Functions
void	enableFallback (bool fallback)
	Sets the value of the FallbackProperty.

int	getItemIndex () const
	Returns the value of the ItemIndexProperty.

bool	isFallbackEnabled () const
	Returns the value of the FallbackProperty.

void	setItemIndex (int index)
	Sets the value of the ItemIndexProperty.

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< int >	ItemIndexProperty
	The index of the item to which to set the focus.

static PropertyType< bool >	FallbackProperty
	Indicates whether to set the focus to the List Box node if the list item cannot receive the focus.

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

Message arguments for the message about the set focus execution received on a List Box node.

Since: Kanzi 4.0.0

Member Function Documentation

◆ setItemIndex()

void kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments::setItemIndex ( int index )

inline

Sets the value of the ItemIndexProperty.

Parameters

index The index of the item to which to set the focus.

◆ getItemIndex()

int kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments::getItemIndex ( ) const

inline

Returns the value of the ItemIndexProperty.

Returns: The value of the ItemIndexProperty in the message argument.

◆ enableFallback()

void kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments::enableFallback ( bool fallback )

inline

Sets the value of the FallbackProperty.

Parameters

fallback To set the focus to the List Box node if the list item cannot receive the focus, set to true.

◆ isFallbackEnabled()

bool kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments::isFallbackEnabled ( ) const

inline

Returns the value of the FallbackProperty.

Returns: The value of the FallbackProperty in the message argument.

Member Data Documentation

◆ ItemIndexProperty

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

static

The index of the item to which to set the focus.

The default value is 0.

See also: setItemIndex(), getItemIndex()

◆ FallbackProperty

PropertyType<bool> kanzi::ListBoxConcept::TrySetFocusToItemMessageArguments::FallbackProperty

static

Indicates whether to set the focus to the List Box node if the list item cannot receive the focus.

By default, if the list item cannot receive the focus, the focus stays where it was.

See also: enableFallback(), isFallbackEnabled()

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

kanzi/ui/node/concept/list_box.hpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ setItemIndex()

◆ getItemIndex()

◆ enableFallback()

◆ isFallbackEnabled()

Member Data Documentation

◆ ItemIndexProperty

◆ FallbackProperty