Kanzi  3.9.4
Kanzi Engine API
kanzi::StackLayoutConcept Class Reference

Stack layout concept base class. More...

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

Inheritance diagram for kanzi::StackLayoutConcept:
[legend]

Public Types

enum  LayoutDirection { DirectionX, DirectionY, DirectionZ }
 Direction in which stack layout arranges its items. More...
 

Static Public Member Functions

static size_t directionToIndex (LayoutDirection direction)
 
static size_t directionToOppositeIndex (LayoutDirection direction)
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static PropertyType< StackLayoutConcept::LayoutDirectionDirectionProperty
 Direction property. More...
 
static PropertyType< bool > ReversedProperty
 Reversed property. More...
 

Detailed Description

Stack layout concept base class.

Note
Do not use this class directly. To use a stack layout in your application use StackLayout3D or StackLayout2D.

StackLayoutConcept defines the data and property types used to implement a stack layout. StackLayoutConceptImpl derives from StackLayoutConcept to provide the functionality to implement a stack layout. To implement a custom stack layout derive from StackLayoutConceptImpl.

Member Enumeration Documentation

◆ LayoutDirection

Direction in which stack layout arranges its items.

Enumerator
DirectionX 

Arrange items along the x axis.

DirectionY 

Arrange items along the y axis.

DirectionZ 

Arrange items along the z axis.

Member Function Documentation

◆ directionToIndex()

static size_t kanzi::StackLayoutConcept::directionToIndex ( LayoutDirection  direction)
inlinestatic

◆ directionToOppositeIndex()

static size_t kanzi::StackLayoutConcept::directionToOppositeIndex ( LayoutDirection  direction)
inlinestatic

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::StackLayoutConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ DirectionProperty

PropertyType<StackLayoutConcept::LayoutDirection> kanzi::StackLayoutConcept::DirectionProperty
static

Direction property.

Defines the axis along which the stack layout arranges its items. The default value is StackLayoutConcept::DirectionX.

See also
setDirection(), getDirection()

◆ ReversedProperty

PropertyType<bool> kanzi::StackLayoutConcept::ReversedProperty
static

Reversed property.

Defines whether the stack layout arranges its items in reverse order. The default value is false.

See also
setReversed(), isReversed()

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