Kanzi  3.9.4
Kanzi Engine API
kanzi::ListBoxScrollingConcept::UserScrollStartedMessageArguments Class Reference

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:
[legend]

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. More...
 
void setItemIndex (optional< size_t > index)
 Sets the value of the ItemIndexProperty. More...
 
- Public Member Functions inherited from kanzi::ListBoxScrollingConcept::ScrollMessageArguments
Vector2 getScrollPosition () const
 Gets ScrollPositionProperty. More...
 
void setScrollPosition (Vector2 value)
 Sets ScrollPositionProperty. More...
 
Vector2 getScrollSpeed () const
 Gets ScrollSpeedProperty. More...
 
void setScrollSpeed (Vector2 value)
 Sets ScrollSpeedProperty. More...
 
- 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< NodegetSource () 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...
 
MessageArgumentsoperator= (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::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. More...
 
static const MetaclassgetStaticMetaclass ()
 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

static PropertyType< int > ItemIndexProperty
 Reports the index of the item where the user starts scrolling. More...
 
- Static Public Attributes inherited from kanzi::ListBoxScrollingConcept::ScrollMessageArguments
static PropertyType< Vector2ScrollPositionProperty
 ScrollPosition property. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 ScrollSpeed property. More...
 

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
indexThe 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: