kanzi::ListBoxScrollingConcept::ScrollMessageArguments Class Reference

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

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

Inheritance diagram for kanzi::ListBoxScrollingConcept::ScrollMessageArguments:

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.

Properties
static PropertyType< Vector2 >	ScrollPositionProperty
	ScrollPosition property.
static PropertyType< Vector2 >	ScrollSpeedProperty
	ScrollSpeed property.
Vector2	getScrollPosition () const
	Gets ScrollPositionProperty.
void	setScrollPosition (Vector2 value)
	Sets ScrollPositionProperty.
Vector2	getScrollSpeed () const
	Gets ScrollSpeedProperty.
void	setScrollSpeed (Vector2 value)
	Sets ScrollSpeedProperty.

Additional Inherited Members
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.

Detailed Description

Base class for scroll-related message arguments.

Member Function Documentation

getScrollPosition()

Vector2 kanzi::ListBoxScrollingConcept::ScrollMessageArguments::getScrollPosition ( ) const

inline

Gets ScrollPositionProperty.

Returns

Argument value.

setScrollPosition()

void kanzi::ListBoxScrollingConcept::ScrollMessageArguments::setScrollPosition ( Vector2 value )

inline

Sets ScrollPositionProperty.

Parameters

value

New Argument value.

getScrollSpeed()

Vector2 kanzi::ListBoxScrollingConcept::ScrollMessageArguments::getScrollSpeed ( ) const

inline

Gets ScrollSpeedProperty.

Returns

Argument value.

setScrollSpeed()

void kanzi::ListBoxScrollingConcept::ScrollMessageArguments::setScrollSpeed ( Vector2 value )

inline

Sets ScrollSpeedProperty.

Parameters

value

New Argument value.

makeEditorInfo()

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

static

Member Data Documentation

ScrollPositionProperty

PropertyType<Vector2> kanzi::ListBoxScrollingConcept::ScrollMessageArguments::ScrollPositionProperty

static

ScrollPosition property.

ScrollSpeedProperty

PropertyType<Vector2> kanzi::ListBoxScrollingConcept::ScrollMessageArguments::ScrollSpeedProperty

static

ScrollSpeed property.

---

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

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