Kanzi framework  3.9.1
Kanzi Engine API
Public Types | Static Public Member Functions | List of all members
kanzi::GridListBoxConcept Class Reference
Interactivity Controls

GridListBoxConcept provides the common properties and messages for the Grid List Box nodes. More...

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

Inheritance diagram for kanzi::GridListBoxConcept:
[legend]

Public Types

enum  GridDirection { GridDirectionRight, GridDirectionDown }
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

Properties
static PropertyType< GridListBoxConcept::GridDirection > DirectionProperty
 Direction property. More...
 
static PropertyType< float > CellWidthProperty
 CellWidth property. More...
 
static PropertyType< float > CellHeightProperty
 CellHeight property. More...
 
static PropertyType< float > ItemAreaBeginProperty
 ItemAreaBegin property. More...
 
static PropertyType< float > ItemAreaEndProperty
 ItemAreaEnd 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< float > CalculatedOffsetProperty
 CalculatedOffset property. More...
 
static PropertyType< Vector2 > ScrollPositionProperty
 Reports the scroll position of the Grid List Box node along the x and y axes as a relative position within the Grid List Box area. More...
 
static PropertyType< Vector2 > ScrollTargetPositionProperty
 ScrollTargetPosition property. More...
 
static PropertyType< Vector2 > ScrollSpeedProperty
 ScrollSpeed property. More...
 
static PropertyType< bool > ScrollingProperty
 Scrolling property. More...
 

Detailed Description

GridListBoxConcept provides the common properties and messages for the Grid List Box nodes.

Member Enumeration Documentation

◆ GridDirection

enum kanzi::GridListBoxConcept::GridDirection
Enumerator
GridDirectionRight 

Layout first right, then down.

GridDirectionDown 

Layout first down, then right.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::GridListBoxConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ DirectionProperty

PropertyType<GridListBoxConcept::GridDirection> kanzi::GridListBoxConcept::DirectionProperty
static

Direction property.

The default value is GridListBoxConcept::GridDirectionRight.

See also
setDirection(), getDirection()

◆ CellWidthProperty

PropertyType<float> kanzi::GridListBoxConcept::CellWidthProperty
static

CellWidth property.

The default value is 1.0f.

See also
setCellWidth(), getCellWidth()

◆ CellHeightProperty

PropertyType<float> kanzi::GridListBoxConcept::CellHeightProperty
static

CellHeight property.

The default value is 1.0f.

See also
setCellHeight(), getCellHeight()

◆ ItemAreaBeginProperty

PropertyType<float> kanzi::GridListBoxConcept::ItemAreaBeginProperty
static

ItemAreaBegin property.

The default value is 0.0f.

See also
setItemAreaBegin(), getItemAreaBegin()

◆ ItemAreaEndProperty

PropertyType<float> kanzi::GridListBoxConcept::ItemAreaEndProperty
static

ItemAreaEnd property.

The default value is 1.0f.

See also
setItemAreaEnd(), getItemAreaEnd()

◆ RecognitionThresholdProperty

PropertyType<float> kanzi::GridListBoxConcept::RecognitionThresholdProperty
static

RecognitionThreshold property.

The default value is 5.0f.

See also
setRecognitionThreshold(), getRecognitionThreshold()

◆ MinimumNumberOfTouchesProperty

PropertyType<int> kanzi::GridListBoxConcept::MinimumNumberOfTouchesProperty
static

MinimumNumberOfTouches property.

The default value is 1.

See also
setMinimumNumberOfTouches(), getMinimumNumberOfTouches()

◆ MaximumNumberOfTouchesProperty

PropertyType<int> kanzi::GridListBoxConcept::MaximumNumberOfTouchesProperty
static

MaximumNumberOfTouches property.

The default value is 10.

See also
setMaximumNumberOfTouches(), getMaximumNumberOfTouches()

◆ SensitivityProperty

PropertyType<float> kanzi::GridListBoxConcept::SensitivityProperty
static

Sensitivity property.

The default value is 1.0f.

See also
setSensitivity(), getSensitivity()

◆ SlidingAccelerationCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::SlidingAccelerationCoefficientProperty
static

SlidingAccelerationCoefficient property.

The default value is 40.0f.

See also
setSlidingAccelerationCoefficient(), getSlidingAccelerationCoefficient()

◆ SlidingDragCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::SlidingDragCoefficientProperty
static

SlidingDragCoefficient property.

The default value is 80.0f.

See also
setSlidingDragCoefficient(), getSlidingDragCoefficient()

◆ DraggingAccelerationCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingAccelerationCoefficientProperty
static

DraggingAccelerationCoefficient property.

The default value is 80.0f.

See also
setDraggingAccelerationCoefficient(), getDraggingAccelerationCoefficient()

◆ DraggingDragCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingDragCoefficientProperty
static

DraggingDragCoefficient property.

The default value is 150.0f.

See also
setDraggingDragCoefficient(), getDraggingDragCoefficient()

◆ DraggingImpulseFactorProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingImpulseFactorProperty
static

DraggingImpulseFactor property.

The default value is 2.0f.

See also
setDraggingImpulseFactor(), getDraggingImpulseFactor()

◆ SwipeDistanceProperty

PropertyType<float> kanzi::GridListBoxConcept::SwipeDistanceProperty
static

SwipeDistance property.

The default value is 0.01f.

See also
setSwipeDistance(), getSwipeDistance()

◆ CalculatedOffsetProperty

PropertyType<float> kanzi::GridListBoxConcept::CalculatedOffsetProperty
static

CalculatedOffset property.

The default value is 0.0f.

See also
setCalculatedOffset(), getCalculatedOffset()

◆ ScrollPositionProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollPositionProperty
static

Reports the scroll position of the Grid List Box node along the x and y axes as a relative position within the Grid List Box area.

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

See also
setScrollPosition(), getScrollPosition()

◆ ScrollTargetPositionProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollTargetPositionProperty
static

ScrollTargetPosition property.

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

See also
setScrollTargetPosition(), getScrollTargetPosition()

◆ ScrollSpeedProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollSpeedProperty
static

ScrollSpeed property.

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

See also
setScrollSpeed(), getScrollSpeed()

◆ ScrollingProperty

PropertyType<bool> kanzi::GridListBoxConcept::ScrollingProperty
static

Scrolling property.

The default value is false.

See also
setScrolling(), isScrolling()
The documentation for this class was generated from the following file: