Module scroll_view

Modules

scroll_direction_message_arguments

scroll_edge_message_arguments

scroll_message_arguments

scroll_page_message_arguments

zoomed_message_arguments

Structs

ALLOWED_SCROLL_AXIS_PROPERTY

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

DRAGGING_ACCELERATION_COEFFICIENT_PROPERTY

Sets 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.

DRAGGING_DRAG_COEFFICIENT_PROPERTY

Sets 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.

DRAGGING_IMPULSE_FACTOR_PROPERTY

Sets the amount of impulse generated from the pointing device movement when dragging a Scroll View node.

LOOPING_X_ENABLED_PROPERTY

Sets 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 Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

LOOPING_Y_ENABLED_PROPERTY

Sets 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 Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

MAXIMUM_NUMBER_OF_TOUCHES_PROPERTY

Sets the maximum number of touch points allowed for a Scroll View pan.

MINIMUM_NUMBER_OF_TOUCHES_PROPERTY

Sets 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.

RECOGNITION_THRESHOLD_PROPERTY

Sets the amount a pointing device must move for the scrolling to start on a Scroll View node.

REVERSED_X_AXIS_SCROLL_PROPERTY

Whether the scroll position of the x axis increases in relation to the direction of the pan gesture. This reverses the direction of scrolling. By default, the scroll position decreases in relation to the pan direction.

REVERSED_Y_AXIS_SCROLL_PROPERTY

Whether the scroll position of the y axis increases in relation to the direction of the pan gesture. This reverses the direction of scrolling. By default, the scroll position decreases in relation to the pan direction.

SCROLLED

Occurs when the scroll position of a Scroll View node changes.

SCROLLING_PROPERTY

Whether a Scroll View node is currently scrolling (read-only).

SCROLL_BOUNDS_MAXIMUM_PROPERTY

Sets the coordinates of the bottom-right corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.

SCROLL_BOUNDS_MINIMUM_PROPERTY

Sets the coordinates of the top-left corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.

SCROLL_DIRECTION

Sets the scroll delta to one step and starts scrolling in that direction

SCROLL_DOWN

Sets the scroll delta to one step down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_EDGE

Sets the scroll target to the edge of a Scroll View node and starts scrolling in that direction

SCROLL_END

Sets the scroll delta to end and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_ENDED

Occurs when the scroll position of a Scroll View node stops changing.

SCROLL_HOME

Sets the scroll delta to home and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_LEFT

Sets the scroll delta to one step left and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_PAGE

Sets the scroll delta to one page and starts scrolling in that direction

SCROLL_PAGE_DOWN

Sets the scroll delta to one page down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_PAGE_UP

Sets the scroll delta to one page up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_POSITION_PROPERTY

Sets the scroll position of the Scroll View along the x and y axes as a relative position within the scroll view area. Use this property to set the scroll position immediately, without scrolling. To update the scroll position with a binding, use a two-way or to-source binding.

SCROLL_RIGHT

Sets the scroll delta to one step right and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SCROLL_SPEED_PROPERTY

The current scroll speed (read-only).

SCROLL_STARTED

Occurs when the scroll position of a Scroll View node starts changing.

SCROLL_TARGET_POSITION_PROPERTY

The current target scroll value (read-only).

SCROLL_UP

Sets the scroll delta to one step up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.

SENSITIVITY_PROPERTY

Sets 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.

SET_SCROLL

Sets the scroll position of a Scroll View node.

SET_SCROLL_TARGET

Sets the scrolling target of the scroll view.

SLIDING_ACCELERATION_COEFFICIENT_PROPERTY

Sets 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.

SLIDING_DRAG_COEFFICIENT_PROPERTY

Sets 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.

SNAP_REQUEST

Occurs when a Scroll View node requests snapping target from the hosting component.

STEP_MULTIPLIER_PROPERTY

Sets the smallest distance that a Scroll View scrolls.

SWIPE_DISTANCE_PROPERTY

Sets the distance that a swipe sends the scroll value, relative to the pointing device speed.

ScrollDirectionMessageArguments

ScrollDownMessageArguments

ScrollEdgeMessageArguments

ScrollEndMessageArguments

ScrollFinishedMessageArguments

ScrollHomeMessageArguments

ScrollLeftMessageArguments

ScrollMessageArguments

ScrollPageDownMessageArguments

ScrollPageMessageArguments

ScrollPageUpMessageArguments

ScrollRightMessageArguments

ScrollStartedMessageArguments

ScrollUpMessageArguments

ScrollViewConcept

ScrolledMessageArguments

SetScrollMessageArguments

SetScrollTargetMessageArguments

SnapRequestMessageArguments

USER_SCROLL_ENDED

Occurs when the user stops scrolling a Scroll View node.

USER_SCROLL_STARTED

Occurs when the user starts scrolling a Scroll View node.

UserScrollFinishedMessageArguments

UserScrollStartedMessageArguments

ZOOMED

Occurs when the zoom level of a Scroll View node changes.

ZOOM_AFFECTS_SCROLLING_PROPERTY

Controls whether the scroll position is scaled, according to the zoom level.

ZOOM_ENABLED_PROPERTY

Sets whether to install a pinch manipulator that generates zoom messages.

ZOOM_MAXIMUM_PROPERTY

Sets the maximum zoom level.

ZOOM_MINIMUM_PROPERTY

Sets the minimum zoom level.

ZOOM_PROPERTY

Sets the current zoom level.

ZoomedMessageArguments

Enums

AllowedScrollAxis

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

Traits

IScrollViewConcept

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: