Implementation class for TrajectoryListBoxConcept. More...

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

Inheritance diagram for kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >:

Public Member Functions
ScrollViewSharedPtr	getScrollView () const
	Returns the Scroll View that scrolls the Trajectory List Box.

Properties
ResourceSharedPtr	getTrajectory () const
	Gets the value of the TrajectoryProperty.

void	setTrajectory (ResourceSharedPtr value)
	Sets the value of the TrajectoryProperty.

float	getItemAreaBegin () const
	Gets the value of the ItemAreaBeginProperty.

void	setItemAreaBegin (float value)
	Sets the value of the ItemAreaBeginProperty.

float	getItemAreaEnd () const
	Gets the value of the ItemAreaEndProperty.

void	setItemAreaEnd (float value)
	Sets the value of the ItemAreaEndProperty.

Vector2	getScrollPosition () const
	Returns the value of the ScrollPositionProperty.

void	setScrollPosition (Vector2 scrollPosition)
	Sets the value of the ScrollPositionProperty.

bool	isAlignToTangent () const
	Gets the value of the AlignToTangentProperty.

void	setAlignToTangent (bool value)
	Sets the value of the AlignToTangentProperty.

float	getSpacing () const
	Gets the value of the SpacingProperty.

void	setSpacing (float value)
	Sets the value of the SpacingProperty.

float	getCursorOffset () const
	Gets the value of the CursorOffsetProperty.

void	setCursorOffset (float value)
	Sets the value of the CursorOffsetProperty.

float	getRecognitionThreshold () const
	Gets the value of the RecognitionThresholdProperty.

void	setRecognitionThreshold (float value)
	Sets the value of the RecognitionThresholdProperty.

int	getMinimumNumberOfTouches () const
	Gets the value of the MinimumNumberOfTouchesProperty.

void	setMinimumNumberOfTouches (int value)
	Sets the value of the MinimumNumberOfTouchesProperty.

int	getMaximumNumberOfTouches () const
	Gets the value of the MaximumNumberOfTouchesProperty.

void	setMaximumNumberOfTouches (int value)
	Sets the value of the MaximumNumberOfTouchesProperty.

float	getSensitivity () const
	Gets the value of the SensitivityProperty.

void	setSensitivity (float value)
	Sets the value of the SensitivityProperty.

float	getSlidingAccelerationCoefficient () const
	Gets the value of the SlidingAccelerationCoefficientProperty.

void	setSlidingAccelerationCoefficient (float value)
	Sets the value of the SlidingAccelerationCoefficientProperty.

float	getSlidingDragCoefficient () const
	Gets the value of the SlidingDragCoefficientProperty.

void	setSlidingDragCoefficient (float value)
	Sets the value of the SlidingDragCoefficientProperty.

float	getDraggingAccelerationCoefficient () const
	Gets the value of the DraggingAccelerationCoefficientProperty.

void	setDraggingAccelerationCoefficient (float value)
	Sets the value of the DraggingAccelerationCoefficientProperty.

float	getDraggingDragCoefficient () const
	Gets the value of the DraggingDragCoefficientProperty.

void	setDraggingDragCoefficient (float value)
	Sets the value of the DraggingDragCoefficientProperty.

float	getDraggingImpulseFactor () const
	Gets the value of the DraggingImpulseFactorProperty.

void	setDraggingImpulseFactor (float value)
	Sets the value of the DraggingImpulseFactorProperty.

float	getSwipeDistance () const
	Gets the value of the SwipeDistanceProperty.

void	setSwipeDistance (float value)
	Sets the value of the SwipeDistanceProperty.

bool	isLooping () const
	Gets the value of the LoopingProperty.

void	setLooping (bool value)
	Sets the value of the LoopingProperty.

ScrollViewConcept::AllowedScrollAxis	getAllowedScrollAxis () const
	Returns the value of the AllowedScrollAxisProperty.

void	setAllowedScrollAxis (ScrollViewConcept::AllowedScrollAxis axis)
	Sets the AllowedScrollAxisProperty value.

bool	isReversedScrolling () const
	Returns the value of the ReversedScrollingProperty.

void	setReversedScrolling (bool enable)
	Sets the value of the ReversedScrollingProperty.

Public Member Functions inherited from kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >
bool	addContentItem (NodeSharedPtr abstractItem) override

void	addItem (ItemSharedPtr item)
	Adds an item at the end of a List Box when using the default object generator.

void	arrangeOverride (LayoutVectorType actualSize) override

void	bringItemCenter (size_t itemIndex, bool smooth)
	Requests the List Box to bring the item in the passed itemIndex to the center of the list box area.

void	enableKeyNavigation (bool enabled)
	Enables directional key navigation between focusable items in a List Box.

void	extendAliveItemsRangeToItemIndex (size_t itemIndex)
	Extends the alive items range to contain the item at a given index.

optional< pair< size_t, size_t > >	getAliveItemsRange ()
	Returns the range of list items that are alive.

NodeSharedPtr	getContentItem (size_t index) override

size_t	getContentItemCount () override

optional< size_t >	getFocusedItemIndex () const
	Returns the index of the item that holds the focus in the List Box.

ItemSharedPtr	getItem (size_t index)
	Gets the item at the given index in a List Box.

string	getItemContainerGeneratorTypeName () const
	Gets the value of ItemContainerGeneratorTypeNameProperty.

PrefabTemplateSharedPtr	getItemContainerTemplate () const
	Gets the value of ItemContainerTemplateProperty.

size_t	getItemCount () const
	Returns the value of the ItemCountProperty.

string	getItemGeneratorTypeName () const
	Gets the value of ItemGeneratorTypeNameProperty.

optional< size_t >	getItemIndex (ItemSharedPtr item)
	Returns the index of the given item. If the item does not exist, returns empty.

LayoutVectorType	getItemSize (size_t index)
	Returns the size of the item at the given index.

PrefabTemplateSharedPtr	getItemTemplate () const
	Gets the value of ItemTemplateProperty.

int	getKeepAliveItemCount () const
	Gets the value of KeepAliveItemCountProperty.

PresenterSharedPtr	getPresenter () const

int	getSelectedItemIndex () const
	Gets the value of SelectedItemIndexProperty.

SelectionBehavior	getSelectionBehavior () const
	Gets the value of SelectionBehavior.

void	insertItem (size_t index, ItemSharedPtr item)
	Inserts an item at the given index in a List Box when using the default object generator.

bool	isEmpty ()
	Indicates whether a List Box has no items.

LayoutVectorType	measureOverride (LayoutVectorType availableSize) override

void	notifyItemAdded (size_t index) override
	Virtual functions for notifying item changes to list.

void	notifyItemContainerChanged ()

void	notifyItemCountChanged () override

void	notifyItemRemoved (size_t index) override

void	notifyItemReplaced (size_t index) override

void	removeAllContentItems () override

void	removeAllItems ()
	Removes all items from a List Box when using the default object generator.

bool	removeContentItem (NodeSharedPtr abstractItem) override

void	removeItem (size_t index)
	Removes the item at the given index from a List Box when using the default object generator.

void	removeLastItem ()
	Removes the last item from a List Box when using the default object generator.

void	replaceItem (size_t index, ItemSharedPtr item)
	Replaces the item at the given index in a List Box when using the default object generator.

void	selectItem (optional< size_t > itemIndex)
	Requests the List Box to select the item at the given index.

void	setItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Sets the list box item container generator.

void	setItemContainerGeneratorTypeName (string_view value)
	Sets the value of ItemContainerGeneratorTypeNameProperty.

void	setItemContainerTemplate (PrefabTemplateSharedPtr value)
	Sets the value of ItemContainerTemplateProperty.

void	setItemGenerator (ItemGeneratorSharedPtr itemGenerator)
	Sets the list box item generator.

void	setItemGeneratorTypeName (string_view value)
	Sets the value of ItemGeneratorTypeNameProperty.

void	setItemTemplate (PrefabTemplateSharedPtr value)
	Sets the value of ItemTemplateProperty.

void	setKeepAliveItemCount (int value)
	Sets the value of KeepAliveItemCountProperty.

void	setSelectedItemIndex (int value)
	Sets the value of SelectedItemIndexProperty.

void	setSelectionBehavior (SelectionBehavior value)
	Sets the value of SelectionBehavior.

bool	trySetFocusItem (size_t itemIndex, bool fallback)
	Tries to set the application focus to an item at a given index and brings the item alive.

void	updateAliveItemsRange (size_t beginIndex, size_t itemCount, bool sendMessages=true)
	Requests items from the item generator.

void	updateAliveItemsRangeQuiet (size_t beginIndex, size_t itemCount)
	Requests items from the item generator.

Public Member Functions inherited from kanzi::ContentItemCollectionModel
virtual	~ContentItemCollectionModel ()

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >
static Vector2	doMeasure (Node2D &node)

static Vector3	doMeasure (Node3D &node)

Static Public Member Functions inherited from kanzi::ListBoxConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ListBoxScrollingConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::TrajectoryListBoxConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
TDerivedClass *	getThisObject ()

const TDerivedClass *	getThisObject () const

void	initialize ()

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onNodePropertyChanged() implementation.

	TrajectoryListBoxConceptImpl (Domain *domain, string_view name)

Protected Member Functions inherited from kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >
void	applySelectionBehavior (size_t itemIndex, bool smooth)
	Applies selection behavior to the selected item.

void	assignItemContainerGenerator (ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Assigns list box item container generator to list box.

void	assignItemGenerator (ItemGeneratorSharedPtr itemGenerator)
	Assigns list box item generator to list box.

void	initialize (PresenterSharedPtr presenter)

	ListBoxConceptImpl (Domain *domain, string_view name)

bool	listBoxContainsKeyFocus () const
	Returns whether the key focus is on the List Box node or on one of the list items.

void	onAboutToGainFocus (FocusManager::PreFocusMessageArguments &messageArguments)
	Handles FocusManager::AboutToGainFocusMessage.

void	onAttached () override
	Node::onAttached() implementation.

void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles ClickManipulator::ClickMessage.

void	onDetached () override
	Node::onDetached() implementation.

void	onFocusGained (FocusManager::PostFocusMessageArguments &messageArguments)
	Handles FocusManager::FocusGainedMessage.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onNodePropertyChanged() implementation.

void	setItemContainerGeneratorByProperty ()
	Creates and assigns item container generator by ItemGeneratorTypeName property value.

void	setItemGeneratorByProperty ()
	Creates and assigns item generator by ItemGeneratorTypeName property value.

void	synchronizeFocusAndSelection (Node &selectedItemContainer)
	ListBoxConcept uses this function to update the focus in the List Box to the selected item.

void	synchronizeItemCountProperty ()
	Updates the ItemCountProperty.

void	synchronizeSelectedItemIndexProperty ()
	Updates the SelectedItemIndexProperty after the List Box internally changes the selected item index.

void	tryMoveFocusToListBox ()
	Tries to move focus to List Box node itself.

void	trySetInitialFocus ()
	Tries to move the focus to the first visible and focusable item in a List Box node that holds the key focus and has no item selected.

void	updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo) override
	Overrides Node::updateFocusScopeInfo().

void	updateGenerators (ItemGeneratorSharedPtr itemGenerator, ItemContainerGeneratorSharedPtr itemContainerGenerator)
	Replaces item and item container generators with new objects. Updates items and layout accordingly.

	~ListBoxConceptImpl () override

Additional Inherited Members
Public Types inherited from kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >
typedef shared_ptr< DefaultListBoxItemGenerator< ItemGeneratorClass > >	DefaultItemGeneratorSharedPtr

typedef ListBoxTraits::TItemClass	ItemClass

typedef ListBoxTraits::TItemContainerClass	ItemContainerClass

typedef ListBoxTraits::TItemContainerGeneratorClass	ItemContainerGeneratorClass

typedef shared_ptr< ItemContainerGeneratorClass >	ItemContainerGeneratorSharedPtr

typedef shared_ptr< ItemContainerClass >	ItemContainerSharedPtr

typedef ListBoxTraits::TItemGeneratorClass	ItemGeneratorClass

typedef shared_ptr< ItemGeneratorClass >	ItemGeneratorSharedPtr

typedef shared_ptr< ItemClass >	ItemSharedPtr

typedef TBaseClass::LayoutVectorType	LayoutVectorType

typedef ListBoxTraits::TPresenterClass	PresenterClass

typedef shared_ptr< PresenterClass >	PresenterSharedPtr

Public Types inherited from kanzi::ListBoxConcept
enum class	FocusMoveTarget { NextItem , PreviousItem , NextPage , PreviousPage , LastItem , FirstItem }
	Specifies the targets to which the focus can move in a List Box. More...

enum	SelectionBehavior { SelectionBehaviorNone , SelectionBehaviorBringToCenter }
	Behaviors for the List Box when an item in the List Box is selected. More...

Static Public Attributes inherited from kanzi::ListBoxConcept
static MessageType< ItemLoadedMessageArguments >	ItemLoadedMessage
	List Box node dispatches this message whenever the List Box loads one of its items.

static MessageType< ItemSelectedMessageArguments >	ItemSelectedMessage
	List Box node dispatches this message whenever an item in the List Box is selected.

static MessageType< ItemUnloadedMessageArguments >	ItemUnloadedMessage
	List Box node dispatches this message whenever the List Box unloads one of its items.

static PropertyType< int >	ItemCountProperty
	Reports the number of items in a List Box, including virtual items.

static PropertyType< int >	KeepAliveItemCountProperty
	Sets the size of the buffer for invisible List Box items.

static PropertyType< ListBoxConcept::SelectionBehavior >	SelectionBehaviorProperty
	Sets how a List Box node behaves when the user selects an item.

static PropertyType< string >	ItemGeneratorTypeNameProperty
	Sets the name of the item generator type to use to provide items dynamically for a List Box node.

static PropertyType< string >	ItemContainerGeneratorTypeNameProperty
	Sets the name of the item container generator type to use to provide item containers dynamically for a List Box node.

static PropertyType< ResourceSharedPtr >	ItemTemplateProperty
	Sets the prefab template to use for the List Box items.

static PropertyType< ResourceSharedPtr >	ItemContainerTemplateProperty
	Sets the ListBoxItemContainer prefab that sets the appearance and behavior of the List Box items.

static PropertyType< int >	SelectedItemIndexProperty
	Sets and reports the index of the item that is currently selected in a List Box node.

static MessageType< TrySetFocusToItemMessageArguments >	TrySetFocusToListItemMessage
	Dispatch this message to set the focus to the list item at a given index.

static MessageType< MoveFocusMessageArguments >	MoveFocusMessage
	Dispatch this message to move the focus between List Box items to a given target.

Static Public Attributes inherited from kanzi::ListBoxScrollingConcept
static MessageType< ScrolledMessageArguments >	ScrolledMessage
	List Box node dispatches this message whenever the List Box node scrolls.

static MessageType< ScrollFinishedMessageArguments >	ScrollFinishedMessage
	List Box node dispatches this message whenever the List Box stops scrolling.

static MessageType< ScrollStartedMessageArguments >	ScrollStartedMessage
	List Box node dispatches this message whenever the List Box starts to scroll.

static MessageType< TargetChangedMessageArguments >	TargetChangedMessage
	List Box node dispatches this message whenever there is a change in scroll target item in List Box.

static MessageType< UserScrollFinishedMessageArguments >	UserScrollFinishedMessage
	List Box node dispatches this message when the user stops scrolling the List Box content.

static MessageType< UserScrollStartedMessageArguments >	UserScrollStartedMessage
	List Box node dispatches this message when the user starts to scroll the List Box content.

Static Public Attributes inherited from kanzi::TrajectoryListBoxConcept
static PropertyType< ResourceSharedPtr >	TrajectoryProperty
	Sets the resource ID of the Trajectory along which the Trajectory List Box 3D arranges its items.

static PropertyType< float >	ItemAreaBeginProperty
	Defines the starting point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

static PropertyType< float >	ItemAreaEndProperty
	Defines the ending point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

static PropertyType< Vector2 >	ScrollPositionProperty
	Reports the scroll position of a Trajectory List Box 3D node along the x and y axes as a relative position within the Trajectory List Box 3D area.

static PropertyType< bool >	AlignToTangentProperty
	Indicates whether to align the Trajectory List Box 3D items to match the tangent of the Trajectory.

static PropertyType< float >	SpacingProperty
	Sets the distance between the items in the Trajectory List Box 3D node.

static PropertyType< float >	CursorOffsetProperty
	Sets the offset of the position to use to select the active item, in proportional range [0,1].

static PropertyType< float >	RecognitionThresholdProperty
	Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D node.

static PropertyType< int >	MinimumNumberOfTouchesProperty
	Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling.

static PropertyType< int >	MaximumNumberOfTouchesProperty
	Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling.

static PropertyType< float >	SensitivityProperty
	Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of a Trajectory List Box 3D node.

static PropertyType< float >	SlidingAccelerationCoefficientProperty
	Sets the acceleration of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

static PropertyType< float >	SlidingDragCoefficientProperty
	Sets the amount that drag affects the movement of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

static PropertyType< float >	DraggingAccelerationCoefficientProperty
	Sets the acceleration of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

static PropertyType< float >	DraggingDragCoefficientProperty
	Sets the amount that drag affects the movement of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

static PropertyType< float >	DraggingImpulseFactorProperty
	Sets the amount of impulse to generate from the pointer movement when the user scrolls a Trajectory List Box 3D node by dragging the pointer.

static PropertyType< float >	SwipeDistanceProperty
	Sets the distance that a swipe sends the scroll value in a Trajectory List Box 3D node, relative to the speed of the pointer.

static PropertyType< bool >	LoopingProperty
	Indicates whether to show items in a Trajectory List Box 3D from the beginning after reaching the last item, and the other way around.

static PropertyType< ScrollViewConcept::AllowedScrollAxis >	AllowedScrollAxisProperty
	Sets the axis on which you want to allow a Trajectory List Box 3D node to scroll.

static PropertyType< bool >	ReversedScrollingProperty
	Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture.

Static Protected Member Functions inherited from kanzi::ListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Detailed Description

template<typename TBaseClass, typename TDerivedClass, typename TTraitsClass>
class kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >

Implementation class for TrajectoryListBoxConcept.

Use the Trajectory List Box to create scrollable lists of items arranged along a Trajectory.

Template Parameters

TBaseClass	The base Node class. Use Node2D for 2D controls and Node3D for 3D.
TDerivedClass	Type of the derived Trajectory List Box you want to define.
TTraitsClass	Class defining the traits for a Trajectory List Box. See TrajectoryListBoxTraits.

See also: TrajectoryListBoxTraits

Examples

To define a custom Trajectory Presenter:

template <class TListBoxClass>
class CustomTrajectoryListBoxPresenter : public ListBoxTrajectoryPresenter<CustomTrajectoryListBoxPresenter<TListBoxClass>, TListBoxClass, TrajectoryLayout3D, ListBoxItemContainer3D, ScrollView3D>
{
    using ParentClass = ListBoxTrajectoryPresenter<CustomTrajectoryListBoxPresenter<TListBoxClass>, TListBoxClass, TrajectoryLayout3D, ListBoxItemContainer3D, ScrollView3D>;
 
public:
    explicit CustomTrajectoryListBoxPresenter() :
        ParentClass()
    {
    }
 
    // Custom implementation of snap. Kanzi uses static polymorphism to select the appropriate method implementations.
    void snap(Vector2 position, Vector2 /*direction*/, bool changeTarget, Vector2* out_position, int* out_itemIndex)
    {
        // In this implementation we ignore the scroll direction. Instead we pass (0.0f, 0.0f) to the parent's class snap() method,
        // which effectively enables snap to closest item in both directions, not only in the direction of the scroll.
        ParentClass::snap(position, Vector2{ 0.0f, 0.0f }, changeTarget, out_position, out_itemIndex);
    }
 
    // Invert navigational keys behavior.
    void startNavigation(NavigationDirection direction)
    {
        switch (direction)
        {
            case NavigationDirection::Up:
            case NavigationDirection::Left:
            {
                this->tryMoveFocusInDirection(ListBoxConcept::FocusMoveTarget::NextItem);
                break;
            }
            case NavigationDirection::Down:
            case NavigationDirection::Right:
            {
                this->tryMoveFocusInDirection(ListBoxConcept::FocusMoveTarget::PreviousItem);
                break;
            }
            case NavigationDirection::Home:
            {
                this->tryMoveFocusToEdge(ListBoxConcept::FocusMoveTarget::FirstItem);
                break;
            }
            case NavigationDirection::End:
            {
                this->tryMoveFocusToEdge(ListBoxConcept::FocusMoveTarget::LastItem);
                break;
            }
            default:
                break;
        }
    }
};

To define a custom Trajectory List Box:

// Forward declarations.
class CustomTrajectoryListBox;
using CustomTrajectoryListBoxSharedPtr = shared_ptr<CustomTrajectoryListBox>;
 
// Define traits for a custom trajectory list box which uses the custom presenter.
using CustomTrajectoryListBoxTraits = TrajectoryListBoxTraits<
    Node3D,
    ListBoxItemContainer3D,
    CustomTrajectoryListBoxPresenter<CustomTrajectoryListBox>,
    ListBoxItemGenerator3D,
    ListBoxItemContainerGenerator3D,
    ScrollView3D,
    TrajectoryLayout3D>;
 
// Template instantiation for a TrajectoryListBoxConceptImpl's parent class.
template class ListBoxConceptImpl<Node3D, CustomTrajectoryListBox, CustomTrajectoryListBoxTraits>;
 
// Define a custom trajectory list box.
// Custom trajectory list box does not contain any logic, it only defines a new TrajectoryListBoxConceptImpl which is set to use a custom presenter.
class CustomTrajectoryListBox : public TrajectoryListBoxConceptImpl<Node3D, CustomTrajectoryListBox, CustomTrajectoryListBoxTraits>
{
    using ConceptClass = TrajectoryListBoxConceptImpl<Node3D, CustomTrajectoryListBox, CustomTrajectoryListBoxTraits>;
 
public:
    // Creates a CustomTrajectoryListBox node.
    static CustomTrajectoryListBoxSharedPtr create(Domain* domain, string_view name)
    {
        CustomTrajectoryListBoxSharedPtr node = make_polymorphic_shared_ptr<Node>(new CustomTrajectoryListBox(domain, name));
        node->initialize();
        return node;
    }
 
protected:
    // Constructor.
    explicit CustomTrajectoryListBox(Domain* domain, string_view name) :
        ConceptClass(domain, name)
    {
    }
};

Since: Kanzi 4.1.0

Constructor & Destructor Documentation

◆ TrajectoryListBoxConceptImpl()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::TrajectoryListBoxConceptImpl	(	Domain *	domain,
		string_view	name )

inlineexplicitprotected

Member Function Documentation

◆ getTrajectory()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

ResourceSharedPtr kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getTrajectory ( ) const

inline

Gets the value of the TrajectoryProperty.

See also: setTrajectory()

◆ setTrajectory()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setTrajectory ( ResourceSharedPtr value )

inline

Sets the value of the TrajectoryProperty.

See also: getTrajectory()

◆ getItemAreaBegin()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getItemAreaBegin ( ) const

inline

Gets the value of the ItemAreaBeginProperty.

See also: setItemAreaBegin()

◆ setItemAreaBegin()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setItemAreaBegin ( float value )

inline

Sets the value of the ItemAreaBeginProperty.

See also: getItemAreaBegin()

◆ getItemAreaEnd()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getItemAreaEnd ( ) const

inline

Gets the value of the ItemAreaEndProperty.

See also: setItemAreaEnd()

◆ setItemAreaEnd()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setItemAreaEnd ( float value )

inline

Sets the value of the ItemAreaEndProperty.

See also: getItemAreaEnd()

◆ getScrollPosition()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

Vector2 kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getScrollPosition ( ) const

inline

Returns the value of the ScrollPositionProperty.

Returns: The current scroll position of the Trajectory List Box node.

See also: setScrollPosition()

◆ setScrollPosition()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setScrollPosition ( Vector2 scrollPosition )

inline

Sets the value of the ScrollPositionProperty.

Parameters

scrollPosition The scroll position to set for the Trajectory List Box node.

See also: getScrollPosition()

◆ isAlignToTangent()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

bool kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::isAlignToTangent ( ) const

inline

Gets the value of the AlignToTangentProperty.

See also: setAlignToTangent()

◆ setAlignToTangent()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setAlignToTangent ( bool value )

inline

Sets the value of the AlignToTangentProperty.

See also: isAlignToTangent()

◆ getSpacing()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getSpacing ( ) const

inline

Gets the value of the SpacingProperty.

See also: setSpacing()

◆ setSpacing()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setSpacing ( float value )

inline

Sets the value of the SpacingProperty.

See also: getSpacing()

◆ getCursorOffset()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getCursorOffset ( ) const

inline

Gets the value of the CursorOffsetProperty.

See also: setCursorOffset()

◆ setCursorOffset()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setCursorOffset ( float value )

inline

Sets the value of the CursorOffsetProperty.

See also: getCursorOffset()

◆ getRecognitionThreshold()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getRecognitionThreshold ( ) const

inline

Gets the value of the RecognitionThresholdProperty.

See also: setRecognitionThreshold()

◆ setRecognitionThreshold()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setRecognitionThreshold ( float value )

inline

Sets the value of the RecognitionThresholdProperty.

See also: getRecognitionThreshold()

◆ getMinimumNumberOfTouches()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

int kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getMinimumNumberOfTouches ( ) const

inline

Gets the value of the MinimumNumberOfTouchesProperty.

See also: setMinimumNumberOfTouches()

◆ setMinimumNumberOfTouches()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setMinimumNumberOfTouches ( int value )

inline

Sets the value of the MinimumNumberOfTouchesProperty.

See also: getMinimumNumberOfTouches()

◆ getMaximumNumberOfTouches()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

int kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getMaximumNumberOfTouches ( ) const

inline

Gets the value of the MaximumNumberOfTouchesProperty.

See also: setMaximumNumberOfTouches()

◆ setMaximumNumberOfTouches()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setMaximumNumberOfTouches ( int value )

inline

Sets the value of the MaximumNumberOfTouchesProperty.

See also: getMaximumNumberOfTouches()

◆ getSensitivity()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getSensitivity ( ) const

inline

Gets the value of the SensitivityProperty.

See also: setSensitivity()

◆ setSensitivity()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setSensitivity ( float value )

inline

Sets the value of the SensitivityProperty.

See also: getSensitivity()

◆ getSlidingAccelerationCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getSlidingAccelerationCoefficient ( ) const

inline

Gets the value of the SlidingAccelerationCoefficientProperty.

See also: setSlidingAccelerationCoefficient()

◆ setSlidingAccelerationCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setSlidingAccelerationCoefficient ( float value )

inline

Sets the value of the SlidingAccelerationCoefficientProperty.

See also: getSlidingAccelerationCoefficient()

◆ getSlidingDragCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getSlidingDragCoefficient ( ) const

inline

Gets the value of the SlidingDragCoefficientProperty.

See also: setSlidingDragCoefficient()

◆ setSlidingDragCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setSlidingDragCoefficient ( float value )

inline

Sets the value of the SlidingDragCoefficientProperty.

See also: getSlidingDragCoefficient()

◆ getDraggingAccelerationCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getDraggingAccelerationCoefficient ( ) const

inline

Gets the value of the DraggingAccelerationCoefficientProperty.

See also: setDraggingAccelerationCoefficient()

◆ setDraggingAccelerationCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setDraggingAccelerationCoefficient ( float value )

inline

Sets the value of the DraggingAccelerationCoefficientProperty.

See also: getDraggingAccelerationCoefficient()

◆ getDraggingDragCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getDraggingDragCoefficient ( ) const

inline

Gets the value of the DraggingDragCoefficientProperty.

See also: setDraggingDragCoefficient()

◆ setDraggingDragCoefficient()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setDraggingDragCoefficient ( float value )

inline

Sets the value of the DraggingDragCoefficientProperty.

See also: getDraggingDragCoefficient()

◆ getDraggingImpulseFactor()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getDraggingImpulseFactor ( ) const

inline

Gets the value of the DraggingImpulseFactorProperty.

See also: setDraggingImpulseFactor()

◆ setDraggingImpulseFactor()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setDraggingImpulseFactor ( float value )

inline

Sets the value of the DraggingImpulseFactorProperty.

See also: getDraggingImpulseFactor()

◆ getSwipeDistance()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

float kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getSwipeDistance ( ) const

inline

Gets the value of the SwipeDistanceProperty.

See also: setSwipeDistance()

◆ setSwipeDistance()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setSwipeDistance ( float value )

inline

Sets the value of the SwipeDistanceProperty.

See also: getSwipeDistance()

◆ isLooping()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

bool kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::isLooping ( ) const

inline

Gets the value of the LoopingProperty.

See also: setLooping()

◆ setLooping()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setLooping ( bool value )

inline

Sets the value of the LoopingProperty.

See also: isLooping()

◆ getAllowedScrollAxis()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

ScrollViewConcept::AllowedScrollAxis kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getAllowedScrollAxis ( ) const

inline

Returns the value of the AllowedScrollAxisProperty.

See also: setAllowedScrollAxis()

◆ setAllowedScrollAxis()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setAllowedScrollAxis ( ScrollViewConcept::AllowedScrollAxis axis )

inline

Sets the AllowedScrollAxisProperty value.

Parameters

axis	The axis on which you want to allow scrolling.

See also: getAllowedScrollAxis()

◆ isReversedScrolling()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

bool kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::isReversedScrolling ( ) const

inline

Returns the value of the ReversedScrollingProperty.

See also: setReversedScrolling()

◆ setReversedScrolling()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::setReversedScrolling ( bool enable )

inline

Sets the value of the ReversedScrollingProperty.

Parameters

enable To reverse the direction of scrolling, pass true, otherwise false.

See also: isReversedScrolling()

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::makeEditorInfo ( )

inlinestatic

◆ getScrollView()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

ScrollViewSharedPtr kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getScrollView ( ) const

inline

Returns the Scroll View that scrolls the Trajectory List Box.

Use this function to access the properties of the Scroll View or to modify the scrolling behavior.

Returns: The Scroll View that scrolls the Trajectory List Box.

◆ initialize()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::initialize ( )

inlineprotected

◆ onNodePropertyChanged()

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

void kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

inlineoverrideprotected

Node::onNodePropertyChanged() implementation.

◆ getThisObject() [1/2]

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

TDerivedClass * kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getThisObject ( )

inlineprotected

◆ getThisObject() [2/2]

template<typename TBaseClass , typename TDerivedClass , typename TTraitsClass >

const TDerivedClass * kanzi::TrajectoryListBoxConceptImpl< TBaseClass, TDerivedClass, TTraitsClass >::getThisObject ( ) const

inlineprotected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

◆ TrajectoryListBoxConceptImpl()

Member Function Documentation

◆ getTrajectory()

◆ setTrajectory()

◆ getItemAreaBegin()

◆ setItemAreaBegin()

◆ getItemAreaEnd()

◆ setItemAreaEnd()

◆ getScrollPosition()

◆ setScrollPosition()

◆ isAlignToTangent()

◆ setAlignToTangent()

◆ getSpacing()

◆ setSpacing()

◆ getCursorOffset()

◆ setCursorOffset()

◆ getRecognitionThreshold()

◆ setRecognitionThreshold()

◆ getMinimumNumberOfTouches()

◆ setMinimumNumberOfTouches()

◆ getMaximumNumberOfTouches()

◆ setMaximumNumberOfTouches()

◆ getSensitivity()

◆ setSensitivity()

◆ getSlidingAccelerationCoefficient()

◆ setSlidingAccelerationCoefficient()

◆ getSlidingDragCoefficient()

◆ setSlidingDragCoefficient()

◆ getDraggingAccelerationCoefficient()

◆ setDraggingAccelerationCoefficient()

◆ getDraggingDragCoefficient()

◆ setDraggingDragCoefficient()

◆ getDraggingImpulseFactor()

◆ setDraggingImpulseFactor()

◆ getSwipeDistance()

◆ setSwipeDistance()

◆ isLooping()

◆ setLooping()

◆ getAllowedScrollAxis()

◆ setAllowedScrollAxis()

◆ isReversedScrolling()

◆ setReversedScrolling()

◆ makeEditorInfo()

◆ getScrollView()

◆ initialize()

◆ onNodePropertyChanged()

◆ getThisObject() [1/2]

◆ getThisObject() [2/2]