Kanzi  3.9.7
Kanzi Engine API
kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Stack layout concept implementation base class. More...

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

Inheritance diagram for kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >:
[legend]

Public Member Functions

LayoutDirection getDirection () const
 Gets the value of DirectionProperty. More...
 
bool isReversed () const
 Gets the value of ReversedProperty. More...
 
void setDirection (LayoutDirection value)
 Sets the value of DirectionProperty. More...
 
void setReversed (bool value)
 Sets the value of ReversedProperty. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::StackLayoutConcept
static size_t directionToIndex (LayoutDirection direction)
 
static size_t directionToOppositeIndex (LayoutDirection direction)
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

 StackLayoutConceptImpl (Domain *domain, string_view name)
 Constructor. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::StackLayoutConcept
enum  LayoutDirection { DirectionX, DirectionY, DirectionZ }
 Direction in which stack layout arranges its items. More...
 
- Static Public Attributes inherited from kanzi::StackLayoutConcept
static PropertyType< StackLayoutConcept::LayoutDirectionDirectionProperty
 Direction property. More...
 
static PropertyType< bool > ReversedProperty
 Reversed property. More...
 

Detailed Description

template<typename TBaseClass, typename TDerivedClass>
class kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >

Stack layout concept implementation base class.

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

StackLayoutConceptImpl provides the functionality to implement a stack layout. StackLayoutConceptImpl derives from StackLayoutConcept, which defines the data and property types used by the implementation. To implement a custom stack layout derive from StackLayoutConceptImpl. The expected inheritance graph is TBaseClass <- StackLayoutConceptImpl <- YourClass.

Constructor & Destructor Documentation

template<typename TBaseClass , typename TDerivedClass >
kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::StackLayoutConceptImpl ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.

Member Function Documentation

template<typename TBaseClass , typename TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
static
template<typename TBaseClass , typename TDerivedClass >
StackLayoutConcept::LayoutDirection kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::getDirection ( ) const

Gets the value of DirectionProperty.

See also
setDirection()
template<typename TBaseClass , typename TDerivedClass >
void kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::setDirection ( StackLayoutConcept::LayoutDirection  value)

Sets the value of DirectionProperty.

See also
getDirection()
template<typename TBaseClass , typename TDerivedClass >
bool kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::isReversed ( ) const

Gets the value of ReversedProperty.

See also
setReversed()
template<typename TBaseClass , typename TDerivedClass >
void kanzi::StackLayoutConceptImpl< TBaseClass, TDerivedClass >::setReversed ( bool  value)

Sets the value of ReversedProperty.

See also
isReversed()

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