Message arguments for the messages about the user scroll started event in a List Box node. More...

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

Inheritance diagram for kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments:

Public Member Functions
optional< size_t >	getItemIndex () const
	Returns the value of the ItemIndexProperty which contains the index of the item where the user starts scrolling.

void	setItemIndex (optional< size_t > index)
	Sets the value of the ItemIndexProperty.

Public Member Functions inherited from kanzi::ListBoxScrollingConcept::ScrollMessageArguments
Vector2	getScrollPosition () const
	Gets ScrollPositionProperty.

void	setScrollPosition (Vector2 value)
	Sets ScrollPositionProperty.

Vector2	getScrollSpeed () const
	Gets ScrollSpeedProperty.

void	setScrollSpeed (Vector2 value)
	Sets ScrollSpeedProperty.

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::ListBoxScrollingConcept::ScrollMessageArguments
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
static PropertyType< int >	ItemIndexProperty
	Reports the index of the item where the user starts scrolling.

Static Public Attributes inherited from kanzi::ListBoxScrollingConcept::ScrollMessageArguments
static PropertyType< Vector2 >	ScrollPositionProperty
	ScrollPosition property.

static PropertyType< Vector2 >	ScrollSpeedProperty
	ScrollSpeed property.

Detailed Description

Message arguments for the messages about the user scroll started event in a List Box node.

These arguments hold the information about the scroll position and scroll speed in a List Box node and the index of the item where the user starts scrolling.

Member Function Documentation

◆ getItemIndex()

optional< size_t > kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments::getItemIndex ( ) const

inline

Returns the value of the ItemIndexProperty which contains the index of the item where the user starts scrolling.

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

◆ setItemIndex()

void kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments::setItemIndex ( optional< size_t > index )

inline

Sets the value of the ItemIndexProperty.

Parameters

index The index of the item where the user starts scrolling.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments::makeEditorInfo ( )

static

Member Data Documentation

◆ ItemIndexProperty

PropertyType<int> kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments::ItemIndexProperty

static

Reports the index of the item where the user starts scrolling.

The default value is -1.

See also: setItemIndex(), getItemIndex()

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

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

Public Member Functions

Static Public Member Functions