ScrollViewConcept is the base class that provides the functionality for the ScrollView2D and ScrollView3D classes. More...

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

Inheritance diagram for kanzi::ScrollViewConcept:

[legend]

Classes
class	ScrollDirectionMessageArguments

class	ScrollDownMessageArguments
	Message arguments used by the ScrollDownMessage. More...

class	ScrollEdgeMessageArguments

class	ScrolledMessageArguments

class	ScrollEndMessageArguments
	Message arguments used by the ScrollEndMessage. More...

class	ScrollFinishedMessageArguments

class	ScrollHomeMessageArguments
	Message arguments used by the ScrollHomeMessage. More...

class	ScrollLeftMessageArguments
	Message arguments used by the ScrollLeftMessage. More...

class	ScrollMessageArguments

class	ScrollPageDownMessageArguments
	Message arguments used by the ScrollPageDownMessage. More...

class	ScrollPageMessageArguments

class	ScrollPageUpMessageArguments
	Message arguments used by the ScrollPageUpMessage. More...

class	ScrollPositionMessageArguments

class	ScrollRightMessageArguments
	Message arguments used by the ScrollRightMessage. More...

class	ScrollStartedMessageArguments

class	ScrollTargetMessageArguments

class	ScrollUpMessageArguments
	Message arguments used by the ScrollUpMessage. More...

class	SetScrollMessageArguments

class	SetScrollTargetMessageArguments

class	SnapMessageArguments

class	SnapRequestMessageArguments

class	UserScrollFinishedMessageArguments

class	UserScrollStartedMessageArguments

class	ZoomedMessageArguments

Public Types
enum	AllowedScrollAxis { XAxis, YAxis, AllAxes }
	Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll. More...

enum	PanState { PanInitial, PanStarted, PanCancelling, PanCanceled }
	Enumeration for the state of pan. More...

enum	ScrollDirection { ScrollUp, ScrollDown, ScrollLeft, ScrollRight }
	Enumeration for the available directions when scrolling by step. More...

enum	ScrollEdge { ScrollHome, ScrollEnd }
	Enumeration for the available directions when scrolling to the edge of a Scroll View. More...

enum	ScrollPage { ScrollPageUp, ScrollPageDown }
	Enumeration for the available directions when scrolling a Scroll View node by page. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< ScrollDirectionMessageArguments >	ScrollDirectionMessage
	Send this message to a Scroll View node to scroll one step in a given direction. More...

static MessageType< ScrollDownMessageArguments >	ScrollDownMessage
	Send this message to a Scroll View node to scroll down the distance that you set using the StepMultiplierProperty. More...

static MessageType< ScrollEdgeMessageArguments >	ScrollEdgeMessage
	Send this message to a Scroll View node to scroll to the top or bottom of that Scroll View node. More...

static MessageType< ScrolledMessageArguments >	ScrolledMessage
	Scroll View sends this message whenever the Scroll View node scrolls. More...

static MessageType< ScrollEndMessageArguments >	ScrollEndMessage
	Send this message to a Scroll View node to scroll to the end of that Scroll View node. More...

static MessageType< ScrollFinishedMessageArguments >	ScrollFinishedMessage
	Scroll View sends this message when scrolling ends, regardless of how the scrolling ended. More...

static MessageType< ScrollHomeMessageArguments >	ScrollHomeMessage
	Send this message to a Scroll View node to scroll to the beginning of that Scroll View node. More...

static MessageType< ScrollLeftMessageArguments >	ScrollLeftMessage
	Send this message to a Scroll View node to scroll left the distance that you set using the StepMultiplierProperty. More...

static MessageType< ScrollPageDownMessageArguments >	ScrollPageDownMessage
	Send this message to a Scroll View node to scroll down the distance of the layout height of that Scroll View node. More...

static MessageType< ScrollPageMessageArguments >	ScrollPageMessage
	Send this message to a Scroll View node to scroll the distance of the layout height of that Scroll View node. More...

static MessageType< ScrollPageUpMessageArguments >	ScrollPageUpMessage
	Send this message to a Scroll View node to scroll up the distance of the layout height of that Scroll View node. More...

static MessageType< ScrollRightMessageArguments >	ScrollRightMessage
	Send this message to a Scroll View node to scroll right the distance that you set using the StepMultiplierProperty. More...

static MessageType< ScrollStartedMessageArguments >	ScrollStartedMessage
	Scroll View sends this message when scrolling starts, regardless of how the scrolling started. More...

static MessageType< ScrollUpMessageArguments >	ScrollUpMessage
	Send this message to a Scroll View node to scroll up the distance that you set using the StepMultiplierProperty. More...

static MessageType< SetScrollMessageArguments >	SetScrollMessage
	Send this message to a Scroll View to go a scroll position immediatelly without scrolling. More...

static MessageType< SetScrollTargetMessageArguments >	SetScrollTargetMessage
	Send this message to a Scroll View to scroll to a specific position in that Scroll View node. More...

static MessageType< SnapRequestMessageArguments >	SnapRequestMessage
	Scroll View sends this message when scrolling stops, but the Scroll View node needs to snap to the nearest item. More...

static MessageType< UserScrollFinishedMessageArguments >	UserScrollFinishedMessage
	Scroll View sends this message when user interaction causes the scrolling to end. More...

static MessageType< UserScrollStartedMessageArguments >	UserScrollStartedMessage
	Scroll View sends this message when user interaction causes the scrolling to start. More...

static MessageType< ZoomedMessageArguments >	ZoomedMessage
	Scroll View sends this message when zoom in or zoom out occurs. More...

Properties
static PropertyType< float >	MessageArgumentScrollViewScrollPositionXProperty
	Use the MessageArgumentScrollViewScrollPositionX argument to set the x axis coordinate for the new scroll position of a Scroll View node. More...

static PropertyType< float >	MessageArgumentScrollViewScrollPositionYProperty
	Use the MessageArgumentScrollViewScrollPositionY argument to set the y axis coordinate for the new scroll position of a Scroll View node. More...

static PropertyType< Vector2 >	MessageArgumentScrollViewScrollPositionProperty
	Use the MessageArgumentScrollViewScrollPosition argument to set the x and y axis coordinates for the new scroll position of a Scroll View node. More...

static PropertyType< Vector2 >	MessageArgumentScrollViewScrollSpeedProperty
	Use the MessageArgumentScrollViewScrollSpeed argument to set the scrolling speed of a Scroll View node. More...

static PropertyType< Vector2 >	MessageArgumentScrollViewScrollTargetProperty
	Use the MessageArgumentScrollViewScrollTarget argument to set the scroll target for a Scroll View node. More...

static PropertyType< int >	MessageArgumentScrollViewScrollDirectionProperty
	Use the MessageArgumentScrollViewScrollDirection argument to set the scrolling direction for a Scroll View node. More...

static PropertyType< int >	MessageArgumentScrollViewScrollPageProperty
	Use the MessageArgumentScrollViewScrollPage argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node. More...

static PropertyType< int >	MessageArgumentScrollViewScrollEdgeProperty
	Use the MessageArgumentScrollViewScrollEdge argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges. More...

static PropertyType< float >	MessageArgumentScrollViewZoomProperty
	Use the MessageArgumentScrollViewZoom argument to set the zoom level for a Scroll View node. More...

static PropertyType< Vector2 >	MessageArgumentScrollViewSnapPositionProperty
	Use the MessageArgumentScrollViewSnapPosition argument to set the target of a snap request. More...

static PropertyType< Vector2 >	MessageArgumentScrollViewSnapDirectionProperty
	Use the MessageArgumentScrollViewSnapDirection argument to set the direction of a snap request. More...

static PropertyType< float >	RecognitionThresholdProperty
	Use the Recognition Threshold property to set the amount a pointing device must move for the scrolling to start on a Scroll View node. More...

static PropertyType< int >	MinimumNumberOfTouchesProperty
	Use the Minimum Number Of Touches property to set the required number of touch points pressed for a Scroll View node pan to start. More...

static PropertyType< int >	MaximumNumberOfTouchesProperty
	Use the Maximum Number Of Touches property to set the maximum number of touch points allowed for a Scroll View to pan. More...

static PropertyType< float >	SensitivityProperty
	Use the Sensitivity property to set the amount the position changes relative to the movement of the pointer that starts the swiping. More...

static PropertyType< float >	SlidingAccelerationCoefficientProperty
	Use the Sliding Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...

static PropertyType< float >	SlidingDragCoefficientProperty
	Use the Sliding Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...

static PropertyType< float >	DraggingAccelerationCoefficientProperty
	Use the Dragging Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. More...

static PropertyType< float >	DraggingDragCoefficientProperty
	Use the Dragging Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. More...

static PropertyType< float >	DraggingImpulseFactorProperty
	Use the Dragging Impulse Factor property to set the amount of impulse generated from the pointing device movement when dragging a Scroll View node. More...

static PropertyType< float >	SwipeDistanceProperty
	Use the Swipe Distance property to set the distance that a swipe sends the scroll value, relative to the pointing device speed. More...

static PropertyType< Vector2 >	ScrollPositionProperty
	Reports the scroll position of the Scroll View node along the x and y axes as a relative position within the Scroll View area. More...

static PropertyType< Vector2 >	ScrollTargetPositionProperty
	Use the Scroll Target Position property to set the value for the current scroll target. More...

static PropertyType< Vector2 >	ScrollSpeedProperty
	Use the Scroll Speed property to set the current scroll speed. More...

static PropertyType< bool >	ScrollingProperty
	Use the Scrolling property to find out whether a Scroll View node is currently scrolling. More...

static PropertyType< bool >	ZoomAffectsScrollingProperty
	Use the Zoom Affects Scrolling property to set whether the scroll position is scaled according to the zoom level. More...

static PropertyType< Vector2 >	ScrollBoundsMinimumProperty
	Use the Scroll Bounds Minimum property to set the coordinates of the top-left corner of the scroll bounds rectangle. More...

static PropertyType< Vector2 >	ScrollBoundsMaximumProperty
	Use the Scroll Bounds Maximum property to set the coordinates of the bottom-right corner of the scroll bounds rectangle. More...

static PropertyType< bool >	LoopingXEnabledProperty
	Use the Looping X Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. More...

static PropertyType< bool >	LoopingYEnabledProperty
	Use the Looping Y Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. More...

static PropertyType< bool >	ZoomEnabledProperty
	Use the Zoom Enabled property to set whether to install a pinch manipulator that generates zoom messages. More...

static PropertyType< float >	ZoomProperty
	Use the Zoom property to set the current zoom level. More...

static PropertyType< float >	ZoomMinimumProperty
	Use the Zoom Minimum property to set the minimum zoom level. More...

static PropertyType< float >	ZoomMaximumProperty
	Use the Zoom Maximum property to set the maximum zoom level. More...

static PropertyType< float >	StepMultiplierProperty
	Use the Step Multiplier property to set the smallest distance that a Scroll View scrolls. More...

static PropertyType< AllowedScrollAxis >	AllowedScrollAxisProperty
	Sets the axis on which you want to allow a Scroll View node to scroll. More...

Detailed Description

ScrollViewConcept is the base class that provides the functionality for the ScrollView2D and ScrollView3D classes.

Both of these Scroll View types inherit the ScrollViewConceptImpl, a specialization of the base class:

ScrollView2D inherits the ScrollViewConceptImpl specialization for the Node2D.
ScrollView3D inherits the ScrollViewConceptImpl specialization for the Node3D.

Scroll View nodes provide an area that receives touch input which is translated to pan and zoom events. You can listen and react to these events by subscribing to the messages that a Scroll View node sends. You can scroll to a specific position in a Scroll View node by sending the Scroll View messages to that Scroll View node.

To disable a Scroll View node, set the Node::EnabledProperty to false. A disabled Scroll View does not respond to input. To visually indicate the disabled state of a Scroll View node, create a state manager and use the Node::EffectivelyEnabledProperty as its controller property. When Kanzi disables a Scroll View node, it cancels the ongoing gestures and preserves the scroll and zoom values of that Scroll View node.

Some Kanzi nodes internally use a Scroll View to achieve a pannable area. For example, the GridListBox2D and TrajectoryListBox3D nodes use a Scroll View.

See also: For details and examples of how to use the Scroll View nodes, see ScrollView2D and ScrollView3D.

Member Enumeration Documentation

◆ ScrollDirection

enum kanzi::ScrollViewConcept::ScrollDirection

Enumeration for the available directions when scrolling by step.

Enumerator
ScrollUp
ScrollDown
ScrollLeft
ScrollRight

◆ AllowedScrollAxis

enum kanzi::ScrollViewConcept::AllowedScrollAxis

Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll.

Enumerator
XAxis	Allow scrolling only on the x axis.
YAxis	Allow scrolling only on the y axis.
AllAxes	Allow scrolling on both the x and y axes.

◆ ScrollPage

enum kanzi::ScrollViewConcept::ScrollPage

Enumeration for the available directions when scrolling a Scroll View node by page.

Enumerator
ScrollPageUp
ScrollPageDown

◆ ScrollEdge

enum kanzi::ScrollViewConcept::ScrollEdge

Enumeration for the available directions when scrolling to the edge of a Scroll View.

Enumerator
ScrollHome
ScrollEnd

◆ PanState

enum kanzi::ScrollViewConcept::PanState

Enumeration for the state of pan.

Enumerator
PanInitial	The initial pan state.
PanStarted	Pan started.
PanCancelling	Pan is canceling.
PanCanceled	Pan canceled.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ScrollViewConcept::makeEditorInfo ( )

static

Member Data Documentation

◆ MessageArgumentScrollViewScrollPositionXProperty

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionXProperty

static

Use the MessageArgumentScrollViewScrollPositionX argument to set the x axis coordinate for the new scroll position of a Scroll View node.

Scroll position is a relative position within a Scroll View. The default value is 0.0f.

See also: ScrollMessageArguments::setScrollPositionX(), ScrollMessageArguments::getScrollPositionX()

◆ MessageArgumentScrollViewScrollPositionYProperty

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionYProperty

static

Use the MessageArgumentScrollViewScrollPositionY argument to set the y axis coordinate for the new scroll position of a Scroll View node.

Scroll position is a relative position within a Scroll View. The default value is 0.0f.

See also: ScrollMessageArguments::setScrollPositionY(), ScrollMessageArguments::getScrollPositionY()

◆ MessageArgumentScrollViewScrollPositionProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionProperty

static

Use the MessageArgumentScrollViewScrollPosition argument to set the x and y axis coordinates for the new scroll position of a Scroll View node.

Scroll position is a relative position within a Scroll View. The default value is Vector2(0.0f, 0.0f).

See also: ScrollMessageArguments::setScrollPosition(), ScrollMessageArguments::getScrollPosition()

◆ MessageArgumentScrollViewScrollSpeedProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollSpeedProperty

static

Use the MessageArgumentScrollViewScrollSpeed argument to set the scrolling speed of a Scroll View node.

The default value is Vector2(0.0f, 0.0f).

See also: ScrollMessageArguments::setScrollSpeed(), ScrollMessageArguments::getScrollSpeed()

◆ MessageArgumentScrollViewScrollTargetProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollTargetProperty

static

Use the MessageArgumentScrollViewScrollTarget argument to set the scroll target for a Scroll View node.

Scroll target is a position to which a Scroll View is going to scroll. The default value is Vector2(0.0f, 0.0f).

See also: ScrollMessageArguments::setScrollTarget(), ScrollMessageArguments::getScrollTarget()

◆ MessageArgumentScrollViewScrollDirectionProperty

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollDirectionProperty

static

Use the MessageArgumentScrollViewScrollDirection argument to set the scrolling direction for a Scroll View node.

The default value is ScrollViewConcept::ScrollDown.

See also: ScrollDirectionMessageArguments::setScroll(), ScrollDirectionMessageArguments::getScroll()

◆ MessageArgumentScrollViewScrollPageProperty

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPageProperty

static

Use the MessageArgumentScrollViewScrollPage argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node.

The default value is ScrollViewConcept::ScrollPageDown.

See also: ScrollPageMessageArguments::setScroll(), ScrollPageMessageArguments::getScroll()

◆ MessageArgumentScrollViewScrollEdgeProperty

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollEdgeProperty

static

Use the MessageArgumentScrollViewScrollEdge argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges.

The default value is ScrollViewConcept::ScrollEnd.

See also: ScrollEdgeMessageArguments::setScroll(), ScrollEdgeMessageArguments::getScroll()

◆ MessageArgumentScrollViewZoomProperty

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewZoomProperty

static

Use the MessageArgumentScrollViewZoom argument to set the zoom level for a Scroll View node.

The default value is 1.0f.

See also: ZoomedMessageArguments::setZoom(), ZoomedMessageArguments::getZoom()

◆ MessageArgumentScrollViewSnapPositionProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewSnapPositionProperty

static

Use the MessageArgumentScrollViewSnapPosition argument to set the target of a snap request.

The default value is Vector2(0.0f, 0.0f).

See also: SnapRequestMessageArguments::setSnapPosition(), SnapRequestMessageArguments::getSnapPosition()

◆ MessageArgumentScrollViewSnapDirectionProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewSnapDirectionProperty

static

Use the MessageArgumentScrollViewSnapDirection argument to set the direction of a snap request.

The default value is Vector2(0.0f, 0.0f).

See also: SnapRequestMessageArguments::getSnapDirection, SnapRequestMessageArguments::getSnapDirection()

◆ RecognitionThresholdProperty

PropertyType<float> kanzi::ScrollViewConcept::RecognitionThresholdProperty

static

Use the Recognition Threshold property to set the amount a pointing device must move for the scrolling to start on a Scroll View node.

The default value is 5.0f.

See also: ScrollViewConceptImpl::setRecognitionThreshold(), ScrollViewConceptImpl::getRecognitionThreshold()

◆ MinimumNumberOfTouchesProperty

PropertyType<int> kanzi::ScrollViewConcept::MinimumNumberOfTouchesProperty

static

Use the Minimum Number Of Touches property to set the required number of touch points pressed for a Scroll View node pan to start.

Scroll View nodes with minimum number of touches greater than one precede the children in touch processing. The default value is 1.

See also: ScrollViewConceptImpl::setMinimumNumberOfTouches(), ScrollViewConceptImpl::getMinimumNumberOfTouches()

◆ MaximumNumberOfTouchesProperty

PropertyType<int> kanzi::ScrollViewConcept::MaximumNumberOfTouchesProperty

static

Use the Maximum Number Of Touches property to set the maximum number of touch points allowed for a Scroll View to pan.

The default value is 10.

See also: ScrollViewConceptImpl::setMaximumNumberOfTouches(), ScrollViewConceptImpl::getMaximumNumberOfTouches()

◆ SensitivityProperty

PropertyType<float> kanzi::ScrollViewConcept::SensitivityProperty

static

Use the Sensitivity property to set the amount the position changes relative to the movement of the pointer that starts the swiping.

The higher the value the more the position of the node controlled by a Scroll View node changes. The default value is 1.0f.

See also: ScrollViewConceptImpl::setSensitivity(), ScrollViewConceptImpl::getSensitivity()

◆ SlidingAccelerationCoefficientProperty

PropertyType<float> kanzi::ScrollViewConcept::SlidingAccelerationCoefficientProperty

static

Use the Sliding Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe.

Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position. The default value is 40.0f.

See also: ScrollViewConceptImpl::setSlidingAccelerationCoefficient(), ScrollViewConceptImpl::getSlidingAccelerationCoefficient()

◆ SlidingDragCoefficientProperty

PropertyType<float> kanzi::ScrollViewConcept::SlidingDragCoefficientProperty

static

Use the Sliding Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe.

The lower the value the higher the drag and the faster the sliding of the object controlled by the Scroll View node stops. The default value is 80.0f.

See also: ScrollViewConceptImpl::setSlidingDragCoefficient(), ScrollViewConceptImpl::getSlidingDragCoefficient()

◆ DraggingAccelerationCoefficientProperty

PropertyType<float> kanzi::ScrollViewConcept::DraggingAccelerationCoefficientProperty

static

Use the Dragging Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node.

Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position. The default value is 80.0f.

See also: ScrollViewConceptImpl::setDraggingAccelerationCoefficient(), ScrollViewConceptImpl::getDraggingAccelerationCoefficient()

◆ DraggingDragCoefficientProperty

PropertyType<float> kanzi::ScrollViewConcept::DraggingDragCoefficientProperty

static

Use the Dragging Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node.

The lower the value the higher the drag and the faster the sliding of that node stops. The default value is 150.0f.

See also: ScrollViewConceptImpl::setDraggingDragCoefficient(), ScrollViewConceptImpl::getDraggingDragCoefficient()

◆ DraggingImpulseFactorProperty

PropertyType<float> kanzi::ScrollViewConcept::DraggingImpulseFactorProperty

static

Use the Dragging Impulse Factor property to set the amount of impulse generated from the pointing device movement when dragging a Scroll View node.

The default value is 2.0f.

See also: ScrollViewConceptImpl::setDraggingImpulseFactor(), ScrollViewConceptImpl::getDraggingImpulseFactor()

◆ SwipeDistanceProperty

PropertyType<float> kanzi::ScrollViewConcept::SwipeDistanceProperty

static

Use the Swipe Distance property to set the distance that a swipe sends the scroll value, relative to the pointing device speed.

The default value is 0.005f.

See also: ScrollViewConceptImpl::setSwipeDistance(), ScrollViewConceptImpl::getSwipeDistance()

◆ ScrollPositionProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollPositionProperty

static

Reports the scroll position of the Scroll View node along the x and y axes as a relative position within the Scroll View area.

When the user:

Pans right and down, the scroll position value decreases.
Scrolls right and down, the scroll position value increases.

The default value is Vector2(0.0f, 0.0f). Use this property to set the scroll position immediately, without scrolling. To update the scroll position with a binding, use a TwoWayBinding or ToSourceBinding. During scrolling the Scroll View node internally overrides any one-way binding that targets this property.

See also: ScrollViewConceptImpl::setScrollPosition(), ScrollViewConceptImpl::getScrollPosition()

◆ ScrollTargetPositionProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollTargetPositionProperty

static

Use the Scroll Target Position property to set the value for the current scroll target.

Scroll target is a position to which a Scroll View is going to scroll. The default value is Vector2(0.0f, 0.0f).

See also: ScrollViewConceptImpl::setScrollTargetPosition(), ScrollViewConceptImpl::getScrollTargetPosition()

◆ ScrollSpeedProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollSpeedProperty

static

Use the Scroll Speed property to set the current scroll speed.

The default value is Vector2(0.0f, 0.0f).

See also: ScrollViewConceptImpl::setScrollSpeed(), ScrollViewConceptImpl::getScrollSpeed()

◆ ScrollingProperty

PropertyType<bool> kanzi::ScrollViewConcept::ScrollingProperty

static

Use the Scrolling property to find out whether a Scroll View node is currently scrolling.

The default value is False.

See also: ScrollViewConceptImpl::setScrolling(), ScrollViewConceptImpl::isScrolling()

◆ ZoomAffectsScrollingProperty

PropertyType<bool> kanzi::ScrollViewConcept::ZoomAffectsScrollingProperty

static

Use the Zoom Affects Scrolling property to set whether the scroll position is scaled according to the zoom level.

The default value is True.

See also: ScrollViewConceptImpl::setZoomAffectsScrolling(), ScrollViewConceptImpl::isZoomAffectsScrolling()

◆ ScrollBoundsMinimumProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollBoundsMinimumProperty

static

Use the Scroll Bounds Minimum property to set the coordinates of the top-left corner of the scroll bounds rectangle.

Scroll bounds define where the scrolling begins and ends. The default value is Vector2(0.0f, 0.0f).

See also: ScrollViewConceptImpl::setScrollBoundsMinimum(), ScrollViewConceptImpl::getScrollBoundsMinimum(), LoopingXEnabledProperty, LoopingYEnabledProperty

◆ ScrollBoundsMaximumProperty

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollBoundsMaximumProperty

static

Use the Scroll Bounds Maximum property to set the coordinates of the bottom-right corner of the scroll bounds rectangle.

Scroll bounds define where the scrolling begins and ends. The default value is Vector2(0.0f, 0.0f).

See also: ScrollViewConceptImpl::setScrollBoundsMaximum(), ScrollViewConceptImpl::getScrollBoundsMaximum(), LoopingXEnabledProperty, LoopingYEnabledProperty

◆ LoopingXEnabledProperty

PropertyType<bool> kanzi::ScrollViewConcept::LoopingXEnabledProperty

static

Use the Looping X Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis.

When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the ScrollBoundsMinimumProperty and ScrollBoundsMaximumProperty properties to set the scroll bounds. The default value is False.

See also: ScrollViewConceptImpl::setLoopingXEnabled(), ScrollViewConceptImpl::isLoopingXEnabled(), ScrollBoundsMinimumProperty, ScrollBoundsMaximumProperty

◆ LoopingYEnabledProperty

PropertyType<bool> kanzi::ScrollViewConcept::LoopingYEnabledProperty

static

Use the Looping Y Enabled property to set the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis.

When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the ScrollBoundsMinimumProperty and ScrollBoundsMaximumProperty properties to set the scroll bounds. The default value is False.

See also: ScrollViewConceptImpl::setLoopingYEnabled(), ScrollViewConceptImpl::isLoopingYEnabled(), ScrollBoundsMinimumProperty, ScrollBoundsMaximumProperty

◆ ZoomEnabledProperty

PropertyType<bool> kanzi::ScrollViewConcept::ZoomEnabledProperty

static

Use the Zoom Enabled property to set whether to install a pinch manipulator that generates zoom messages.

The default value is False.

See also: ScrollViewConceptImpl::setZoomEnabled(), ScrollViewConceptImpl::isZoomEnabled()

◆ ZoomProperty

PropertyType<float> kanzi::ScrollViewConcept::ZoomProperty

static

Use the Zoom property to set the current zoom level.

The default value is 1.0f.

See also: ScrollViewConceptImpl::setZoom(), ScrollViewConceptImpl::getZoom()

◆ ZoomMinimumProperty

PropertyType<float> kanzi::ScrollViewConcept::ZoomMinimumProperty

static

Use the Zoom Minimum property to set the minimum zoom level.

The default value is 0.2f.

See also: ScrollViewConceptImpl::setZoomMinimum(), ScrollViewConceptImpl::getZoomMinimum()

◆ ZoomMaximumProperty

PropertyType<float> kanzi::ScrollViewConcept::ZoomMaximumProperty

static

Use the Zoom Maximum property to set the maximum zoom level.

The default value is 6.0f.

See also: ScrollViewConceptImpl::setZoomMaximum(), ScrollViewConceptImpl::getZoomMaximum()

◆ StepMultiplierProperty

PropertyType<float> kanzi::ScrollViewConcept::StepMultiplierProperty

static

Use the Step Multiplier property to set the smallest distance that a Scroll View scrolls.

Kanzi uses the property value to multiply the Scroll View dimension for the scroll direction to calculate the smallest scroll distance. The default value is 0.25f.

See also: ScrollViewConceptImpl::setStepMultiplier(), ScrollViewConceptImpl::getStepMultiplier()

◆ AllowedScrollAxisProperty

PropertyType<AllowedScrollAxis> kanzi::ScrollViewConcept::AllowedScrollAxisProperty

static

Sets the axis on which you want to allow a Scroll View node to scroll.

The default value is AllAxes.

◆ ScrollStartedMessage

MessageType<ScrollStartedMessageArguments> kanzi::ScrollViewConcept::ScrollStartedMessage

static

Scroll View sends this message when scrolling starts, regardless of how the scrolling started.

◆ ScrollFinishedMessage

MessageType<ScrollFinishedMessageArguments> kanzi::ScrollViewConcept::ScrollFinishedMessage

static

Scroll View sends this message when scrolling ends, regardless of how the scrolling ended.

A scroll ends when the interpolators reach the target values and the current position no longer changes.

◆ UserScrollStartedMessage

MessageType<UserScrollStartedMessageArguments> kanzi::ScrollViewConcept::UserScrollStartedMessage

static

Scroll View sends this message when user interaction causes the scrolling to start.

◆ UserScrollFinishedMessage

MessageType<UserScrollFinishedMessageArguments> kanzi::ScrollViewConcept::UserScrollFinishedMessage

static

Scroll View sends this message when user interaction causes the scrolling to end.

At this point the user interaction ended, but the scrolling movement can still continue.

◆ ZoomedMessage

MessageType<ZoomedMessageArguments> kanzi::ScrollViewConcept::ZoomedMessage

static

Scroll View sends this message when zoom in or zoom out occurs.

◆ ScrolledMessage

MessageType<ScrolledMessageArguments> kanzi::ScrollViewConcept::ScrolledMessage

static

Scroll View sends this message whenever the Scroll View node scrolls.

◆ SnapRequestMessage

MessageType<SnapRequestMessageArguments> kanzi::ScrollViewConcept::SnapRequestMessage

static

Scroll View sends this message when scrolling stops, but the Scroll View node needs to snap to the nearest item.

List Box nodes use this message to react to the snap request to snap to the nearest item in a List Box node.

◆ ScrollDirectionMessage

MessageType<ScrollDirectionMessageArguments> kanzi::ScrollViewConcept::ScrollDirectionMessage

static

Send this message to a Scroll View node to scroll one step in a given direction.

You can set the size of the step with the StepMultiplierProperty.

Deprecated:: In Kanzi 3.9.0. Use ScrollUpMessage, ScrollDownMessage, ScrollLeftMessage, and ScrollRightMessage.

◆ ScrollPageMessage

MessageType<ScrollPageMessageArguments> kanzi::ScrollViewConcept::ScrollPageMessage

static

Send this message to a Scroll View node to scroll the distance of the layout height of that Scroll View node.

Deprecated:: In Kanzi 3.9.0. Use ScrollPageUpMessage and ScrollPageDownMessage.

◆ ScrollEdgeMessage

MessageType<ScrollEdgeMessageArguments> kanzi::ScrollViewConcept::ScrollEdgeMessage

static

Send this message to a Scroll View node to scroll to the top or bottom of that Scroll View node.

Deprecated:: In Kanzi 3.9.0. Use ScrollHomeMessage and ScrollEndMessage.

◆ ScrollUpMessage

MessageType<ScrollUpMessageArguments> kanzi::ScrollViewConcept::ScrollUpMessage

static

Send this message to a Scroll View node to scroll up the distance that you set using the StepMultiplierProperty.

Since: Kanzi 3.9.0

◆ ScrollDownMessage

MessageType<ScrollDownMessageArguments> kanzi::ScrollViewConcept::ScrollDownMessage

static

Send this message to a Scroll View node to scroll down the distance that you set using the StepMultiplierProperty.

Since: Kanzi 3.9.0

◆ ScrollLeftMessage

MessageType<ScrollLeftMessageArguments> kanzi::ScrollViewConcept::ScrollLeftMessage

static

Send this message to a Scroll View node to scroll left the distance that you set using the StepMultiplierProperty.

Since: Kanzi 3.9.0

◆ ScrollRightMessage

MessageType<ScrollRightMessageArguments> kanzi::ScrollViewConcept::ScrollRightMessage

static

Send this message to a Scroll View node to scroll right the distance that you set using the StepMultiplierProperty.

Since: Kanzi 3.9.0

◆ ScrollHomeMessage

MessageType<ScrollHomeMessageArguments> kanzi::ScrollViewConcept::ScrollHomeMessage

static

Send this message to a Scroll View node to scroll to the beginning of that Scroll View node.

Since: Kanzi 3.9.0

◆ ScrollEndMessage

MessageType<ScrollEndMessageArguments> kanzi::ScrollViewConcept::ScrollEndMessage

static

Send this message to a Scroll View node to scroll to the end of that Scroll View node.

Since: Kanzi 3.9.0

◆ ScrollPageUpMessage

MessageType<ScrollPageUpMessageArguments> kanzi::ScrollViewConcept::ScrollPageUpMessage

static

Send this message to a Scroll View node to scroll up the distance of the layout height of that Scroll View node.

Since: Kanzi 3.9.0

◆ ScrollPageDownMessage

MessageType<ScrollPageDownMessageArguments> kanzi::ScrollViewConcept::ScrollPageDownMessage

static

Send this message to a Scroll View node to scroll down the distance of the layout height of that Scroll View node.

Since: Kanzi 3.9.0

◆ SetScrollTargetMessage

MessageType<SetScrollTargetMessageArguments> kanzi::ScrollViewConcept::SetScrollTargetMessage

static

Send this message to a Scroll View to scroll to a specific position in that Scroll View node.

◆ SetScrollMessage

MessageType<SetScrollMessageArguments> kanzi::ScrollViewConcept::SetScrollMessage

static

Send this message to a Scroll View to go a scroll position immediatelly without scrolling.

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

kanzi/ui/node/concept/scroll_view.hpp

Classes

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ ScrollDirection

◆ AllowedScrollAxis

◆ ScrollPage

◆ ScrollEdge

◆ PanState

Member Function Documentation

◆ makeEditorInfo()

Member Data Documentation

◆ MessageArgumentScrollViewScrollPositionXProperty

◆ MessageArgumentScrollViewScrollPositionYProperty

◆ MessageArgumentScrollViewScrollPositionProperty

◆ MessageArgumentScrollViewScrollSpeedProperty

◆ MessageArgumentScrollViewScrollTargetProperty

◆ MessageArgumentScrollViewScrollDirectionProperty

◆ MessageArgumentScrollViewScrollPageProperty

◆ MessageArgumentScrollViewScrollEdgeProperty

◆ MessageArgumentScrollViewZoomProperty

◆ MessageArgumentScrollViewSnapPositionProperty

◆ MessageArgumentScrollViewSnapDirectionProperty

◆ RecognitionThresholdProperty

◆ MinimumNumberOfTouchesProperty

◆ MaximumNumberOfTouchesProperty

◆ SensitivityProperty

◆ SlidingAccelerationCoefficientProperty

◆ SlidingDragCoefficientProperty

◆ DraggingAccelerationCoefficientProperty

◆ DraggingDragCoefficientProperty

◆ DraggingImpulseFactorProperty

◆ SwipeDistanceProperty

◆ ScrollPositionProperty

◆ ScrollTargetPositionProperty

◆ ScrollSpeedProperty

◆ ScrollingProperty

◆ ZoomAffectsScrollingProperty

◆ ScrollBoundsMinimumProperty

◆ ScrollBoundsMaximumProperty

◆ LoopingXEnabledProperty

◆ LoopingYEnabledProperty

◆ ZoomEnabledProperty

◆ ZoomProperty

◆ ZoomMinimumProperty

◆ ZoomMaximumProperty

◆ StepMultiplierProperty

◆ AllowedScrollAxisProperty

◆ ScrollStartedMessage

◆ ScrollFinishedMessage

◆ UserScrollStartedMessage

◆ UserScrollFinishedMessage

◆ ZoomedMessage

◆ ScrolledMessage

◆ SnapRequestMessage

◆ ScrollDirectionMessage

◆ ScrollPageMessage

◆ ScrollEdgeMessage

◆ ScrollUpMessage

◆ ScrollDownMessage

◆ ScrollLeftMessage

◆ ScrollRightMessage

◆ ScrollHomeMessage

◆ ScrollEndMessage

◆ ScrollPageUpMessage

◆ ScrollPageDownMessage

◆ SetScrollTargetMessage

◆ SetScrollMessage