kanzi::ScrollViewConcept Class Reference

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

Inheritance diagram for kanzi::ScrollViewConcept:

Classes
class	ScrollDirectionMessageArguments
class	ScrollEdgeMessageArguments
class	ScrolledMessageArguments
class	ScrollFinishedMessageArguments
class	ScrollMessageArguments
class	ScrollPageMessageArguments
class	ScrollPositionMessageArguments
class	ScrollStartedMessageArguments
class	ScrollTargetMessageArguments
class	SetScrollMessageArguments
class	SetScrollTargetMessageArguments
class	SnapMessageArguments
class	SnapRequestMessageArguments
class	UserScrollFinishedMessageArguments
class	UserScrollStartedMessageArguments
class	ZoomedMessageArguments

Public Types
enum	ScrollDirection { ScrollUp, ScrollDown, ScrollLeft, ScrollRight }
	Enumeration for possible directions when scrolling by step. More...
enum	ScrollPage { ScrollPageUp, ScrollPageDown }
	Enumeration for possible directions when scrolling by page. More...
enum	ScrollEdge { ScrollHome, ScrollEnd }
	Enumeration for possible directions when scrolling to edge. More...
enum	PanState { PanInitial, PanStarted, PanCancelling, PanCanceled }
	Enumeration for pan state. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< ScrollStartedMessageArguments >	ScrollStartedMessage
static MessageType< ScrollFinishedMessageArguments >	ScrollFinishedMessage
static MessageType< UserScrollStartedMessageArguments >	UserScrollStartedMessage
static MessageType< UserScrollFinishedMessageArguments >	UserScrollFinishedMessage
static MessageType< ZoomedMessageArguments >	ZoomedMessage
static MessageType< ScrolledMessageArguments >	ScrolledMessage
static MessageType< SnapRequestMessageArguments >	SnapRequestMessage
static MessageType< ScrollDirectionMessageArguments >	ScrollDirectionMessage
static MessageType< ScrollPageMessageArguments >	ScrollPageMessage
static MessageType< ScrollEdgeMessageArguments >	ScrollEdgeMessage
static MessageType< SetScrollTargetMessageArguments >	SetScrollTargetMessage
static MessageType< SetScrollMessageArguments >	SetScrollMessage
Properties
static PropertyType< float >	MessageArgumentScrollViewScrollPositionXProperty
	MessageArgumentScrollViewScrollPositionX property. More...
static PropertyType< float >	MessageArgumentScrollViewScrollPositionYProperty
	MessageArgumentScrollViewScrollPositionY property. More...
static PropertyType< Vector2 >	MessageArgumentScrollViewScrollPositionProperty
	MessageArgumentScrollViewScrollPosition property. More...
static PropertyType< Vector2 >	MessageArgumentScrollViewScrollSpeedProperty
	MessageArgumentScrollViewScrollSpeed property. More...
static PropertyType< Vector2 >	MessageArgumentScrollViewScrollTargetProperty
	MessageArgumentScrollViewScrollTarget property. More...
static PropertyType< int >	MessageArgumentScrollViewScrollDirectionProperty
	MessageArgumentScrollViewScrollDirection property. More...
static PropertyType< int >	MessageArgumentScrollViewScrollPageProperty
	MessageArgumentScrollViewScrollPage property. More...
static PropertyType< int >	MessageArgumentScrollViewScrollEdgeProperty
	MessageArgumentScrollViewScrollEdge property. More...
static PropertyType< float >	MessageArgumentScrollViewZoomProperty
	MessageArgumentScrollViewZoom property. More...
static PropertyType< Vector2 >	MessageArgumentScrollViewSnapPositionProperty
	MessageArgumentScrollViewSnapPosition property. More...
static PropertyType< Vector2 >	MessageArgumentScrollViewSnapDirectionProperty
	MessageArgumentScrollViewSnapDirection property. More...
static PropertyType< Vector2 >	ScrollAxisProperty
	ScrollAxis property. More...
static PropertyType< float >	RecognitionThresholdProperty
	RecognitionThreshold property. More...
static PropertyType< int >	MinimumNumberOfTouchesProperty
	MinimumNumberOfTouches property. More...
static PropertyType< int >	MaximumNumberOfTouchesProperty
	MaximumNumberOfTouches property. More...
static PropertyType< float >	SensitivityProperty
	Sensitivity property. More...
static PropertyType< float >	SlidingAccelerationCoefficientProperty
	SlidingAccelerationCoefficient property. More...
static PropertyType< float >	SlidingDragCoefficientProperty
	SlidingDragCoefficient property. More...
static PropertyType< float >	DraggingAccelerationCoefficientProperty
	DraggingAccelerationCoefficient property. More...
static PropertyType< float >	DraggingDragCoefficientProperty
	DraggingDragCoefficient property. More...
static PropertyType< float >	DraggingImpulseFactorProperty
	DraggingImpulseFactor property. More...
static PropertyType< float >	SwipeDistanceProperty
	SwipeDistance property. More...
static PropertyType< Vector2 >	ScrollPositionProperty
	ScrollPosition property. More...
static PropertyType< Vector2 >	ScrollTargetPositionProperty
	ScrollTargetPosition property. More...
static PropertyType< Vector2 >	ScrollSpeedProperty
	ScrollSpeed property. More...
static PropertyType< bool >	ScrollingProperty
	Scrolling property. More...
static PropertyType< bool >	ZoomAffectsScrollingProperty
	ZoomAffectsScrolling property. More...
static PropertyType< Vector2 >	ScrollBoundsMinimumProperty
	ScrollBoundsMinimum property. More...
static PropertyType< Vector2 >	ScrollBoundsMaximumProperty
	ScrollBoundsMaximum property. More...
static PropertyType< bool >	LoopingXEnabledProperty
	LoopingXEnabled property. More...
static PropertyType< bool >	LoopingYEnabledProperty
	LoopingYEnabled property. More...
static PropertyType< bool >	ZoomEnabledProperty
	ZoomEnabled property. More...
static PropertyType< float >	ZoomProperty
	Zoom property. More...
static PropertyType< float >	ZoomMinimumProperty
	ZoomMinimum property. More...
static PropertyType< float >	ZoomMaximumProperty
	ZoomMaximum property. More...
static PropertyType< float >	StepMultiplierProperty
	StepMultiplier property. More...

Member Enumeration Documentation

enum kanzi::ScrollViewConcept::ScrollDirection

Enumeration for possible directions when scrolling by step.

Enumerator
ScrollUp
ScrollDown
ScrollLeft
ScrollRight

enum kanzi::ScrollViewConcept::ScrollPage

Enumeration for possible directions when scrolling by page.

Enumerator
ScrollPageUp
ScrollPageDown

enum kanzi::ScrollViewConcept::ScrollEdge

Enumeration for possible directions when scrolling to edge.

Enumerator
ScrollHome
ScrollEnd

enum kanzi::ScrollViewConcept::PanState

Enumeration for pan state.

Enumerator
PanInitial	Initial pan state.
PanStarted	Pan has been started.
PanCancelling	Pan is canceling.
PanCanceled	Pan has been canceled.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::ScrollViewConcept::makeEditorInfo ( )

static

Member Data Documentation

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionXProperty

static

MessageArgumentScrollViewScrollPositionX property.

The default value is 0.0f.

See also

setMessageArgumentScrollViewScrollPositionX(), getMessageArgumentScrollViewScrollPositionX()

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionYProperty

static

MessageArgumentScrollViewScrollPositionY property.

The default value is 0.0f.

See also

setMessageArgumentScrollViewScrollPositionY(), getMessageArgumentScrollViewScrollPositionY()

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPositionProperty

static

MessageArgumentScrollViewScrollPosition property.

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

See also

setMessageArgumentScrollViewScrollPosition(), getMessageArgumentScrollViewScrollPosition()

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollSpeedProperty

static

MessageArgumentScrollViewScrollSpeed property.

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

See also

setMessageArgumentScrollViewScrollSpeed(), getMessageArgumentScrollViewScrollSpeed()

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollTargetProperty

static

MessageArgumentScrollViewScrollTarget property.

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

See also

setMessageArgumentScrollViewScrollTarget(), getMessageArgumentScrollViewScrollTarget()

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollDirectionProperty

static

MessageArgumentScrollViewScrollDirection property.

The default value is ScrollViewConcept::ScrollDown.

See also

setMessageArgumentScrollViewScrollDirection(), getMessageArgumentScrollViewScrollDirection()

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollPageProperty

static

MessageArgumentScrollViewScrollPage property.

The default value is ScrollViewConcept::ScrollPageDown.

See also

setMessageArgumentScrollViewScrollPage(), getMessageArgumentScrollViewScrollPage()

PropertyType<int> kanzi::ScrollViewConcept::MessageArgumentScrollViewScrollEdgeProperty

static

MessageArgumentScrollViewScrollEdge property.

The default value is ScrollViewConcept::ScrollEnd.

See also

setMessageArgumentScrollViewScrollEdge(), getMessageArgumentScrollViewScrollEdge()

PropertyType<float> kanzi::ScrollViewConcept::MessageArgumentScrollViewZoomProperty

static

MessageArgumentScrollViewZoom property.

The default value is 1.0f.

See also

setMessageArgumentScrollViewZoom(), getMessageArgumentScrollViewZoom()

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewSnapPositionProperty

static

MessageArgumentScrollViewSnapPosition property.

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

See also

setMessageArgumentScrollViewSnapPosition(), getMessageArgumentScrollViewSnapPosition()

PropertyType<Vector2> kanzi::ScrollViewConcept::MessageArgumentScrollViewSnapDirectionProperty

static

MessageArgumentScrollViewSnapDirection property.

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

See also

setMessageArgumentScrollViewSnapDirection(), getMessageArgumentScrollViewSnapDirection()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollAxisProperty

static

ScrollAxis property.

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

See also

setScrollAxis(), getScrollAxis()

PropertyType<float> kanzi::ScrollViewConcept::RecognitionThresholdProperty

static

RecognitionThreshold property.

The default value is 5.0f.

See also

setRecognitionThreshold(), getRecognitionThreshold()

PropertyType<int> kanzi::ScrollViewConcept::MinimumNumberOfTouchesProperty

static

MinimumNumberOfTouches property.

The default value is 1.

See also

setMinimumNumberOfTouches(), getMinimumNumberOfTouches()

PropertyType<int> kanzi::ScrollViewConcept::MaximumNumberOfTouchesProperty

static

MaximumNumberOfTouches property.

The default value is 10.

See also

setMaximumNumberOfTouches(), getMaximumNumberOfTouches()

PropertyType<float> kanzi::ScrollViewConcept::SensitivityProperty

static

Sensitivity property.

The default value is 1.0f.

See also

setSensitivity(), getSensitivity()

PropertyType<float> kanzi::ScrollViewConcept::SlidingAccelerationCoefficientProperty

static

SlidingAccelerationCoefficient property.

The default value is 40.0f.

See also

setSlidingAccelerationCoefficient(), getSlidingAccelerationCoefficient()

PropertyType<float> kanzi::ScrollViewConcept::SlidingDragCoefficientProperty

static

SlidingDragCoefficient property.

The default value is 80.0f.

See also

setSlidingDragCoefficient(), getSlidingDragCoefficient()

PropertyType<float> kanzi::ScrollViewConcept::DraggingAccelerationCoefficientProperty

static

DraggingAccelerationCoefficient property.

The default value is 80.0f.

See also

setDraggingAccelerationCoefficient(), getDraggingAccelerationCoefficient()

PropertyType<float> kanzi::ScrollViewConcept::DraggingDragCoefficientProperty

static

DraggingDragCoefficient property.

The default value is 150.0f.

See also

setDraggingDragCoefficient(), getDraggingDragCoefficient()

PropertyType<float> kanzi::ScrollViewConcept::DraggingImpulseFactorProperty

static

DraggingImpulseFactor property.

The default value is 2.0f.

See also

setDraggingImpulseFactor(), getDraggingImpulseFactor()

PropertyType<float> kanzi::ScrollViewConcept::SwipeDistanceProperty

static

SwipeDistance property.

The default value is 0.005f.

See also

setSwipeDistance(), getSwipeDistance()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollPositionProperty

static

ScrollPosition property.

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

See also

setScrollPosition(), getScrollPosition()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollTargetPositionProperty

static

ScrollTargetPosition property.

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

See also

setScrollTargetPosition(), getScrollTargetPosition()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollSpeedProperty

static

ScrollSpeed property.

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

See also

setScrollSpeed(), getScrollSpeed()

PropertyType<bool> kanzi::ScrollViewConcept::ScrollingProperty

static

Scrolling property.

The default value is false.

See also

setScrolling(), isScrolling()

PropertyType<bool> kanzi::ScrollViewConcept::ZoomAffectsScrollingProperty

static

ZoomAffectsScrolling property.

The default value is true.

See also

setZoomAffectsScrolling(), isZoomAffectsScrolling()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollBoundsMinimumProperty

static

ScrollBoundsMinimum property.

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

See also

setScrollBoundsMinimum(), getScrollBoundsMinimum()

PropertyType<Vector2> kanzi::ScrollViewConcept::ScrollBoundsMaximumProperty

static

ScrollBoundsMaximum property.

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

See also

setScrollBoundsMaximum(), getScrollBoundsMaximum()

PropertyType<bool> kanzi::ScrollViewConcept::LoopingXEnabledProperty

static

LoopingXEnabled property.

The default value is false.

See also

setLoopingXEnabled(), isLoopingXEnabled()

PropertyType<bool> kanzi::ScrollViewConcept::LoopingYEnabledProperty

static

LoopingYEnabled property.

The default value is false.

See also

setLoopingYEnabled(), isLoopingYEnabled()

PropertyType<bool> kanzi::ScrollViewConcept::ZoomEnabledProperty

static

ZoomEnabled property.

The default value is false.

See also

setZoomEnabled(), isZoomEnabled()

PropertyType<float> kanzi::ScrollViewConcept::ZoomProperty

static

Zoom property.

The default value is 1.0f.

See also

setZoom(), getZoom()

PropertyType<float> kanzi::ScrollViewConcept::ZoomMinimumProperty

static

ZoomMinimum property.

The default value is 0.2f.

See also

setZoomMinimum(), getZoomMinimum()

PropertyType<float> kanzi::ScrollViewConcept::ZoomMaximumProperty

static

ZoomMaximum property.

The default value is 6.0f.

See also

setZoomMaximum(), getZoomMaximum()

PropertyType<float> kanzi::ScrollViewConcept::StepMultiplierProperty

static

StepMultiplier property.

The default value is 0.25f.

See also

setStepMultiplier(), getStepMultiplier()

MessageType<ScrollStartedMessageArguments> kanzi::ScrollViewConcept::ScrollStartedMessage

static

MessageType<ScrollFinishedMessageArguments> kanzi::ScrollViewConcept::ScrollFinishedMessage

static

MessageType<UserScrollStartedMessageArguments> kanzi::ScrollViewConcept::UserScrollStartedMessage

static

MessageType<UserScrollFinishedMessageArguments> kanzi::ScrollViewConcept::UserScrollFinishedMessage

static

MessageType<ZoomedMessageArguments> kanzi::ScrollViewConcept::ZoomedMessage

static

MessageType<ScrolledMessageArguments> kanzi::ScrollViewConcept::ScrolledMessage

static

MessageType<SnapRequestMessageArguments> kanzi::ScrollViewConcept::SnapRequestMessage

static

MessageType<ScrollDirectionMessageArguments> kanzi::ScrollViewConcept::ScrollDirectionMessage

static

MessageType<ScrollPageMessageArguments> kanzi::ScrollViewConcept::ScrollPageMessage

static

MessageType<ScrollEdgeMessageArguments> kanzi::ScrollViewConcept::ScrollEdgeMessage

static

MessageType<SetScrollTargetMessageArguments> kanzi::ScrollViewConcept::SetScrollTargetMessage

static

MessageType<SetScrollMessageArguments> kanzi::ScrollViewConcept::SetScrollMessage

static

---

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

• kanzi/ui/node/concept/scroll_view.hpp