Kanzi  3.9.5
Kanzi Engine API
kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Flow layout concept implementation base class. More...

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

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

Public Member Functions

LayoutDirection getPrimaryDirection () const
 Gets the value of PrimaryDirectionProperty. More...
 
LayoutDirection getSecondaryDirection () const
 Gets the value of SecondaryDirectionProperty. More...
 
void setPrimaryDirection (LayoutDirection value)
 Sets the value of PrimaryDirectionProperty. More...
 
void setSecondaryDirection (LayoutDirection value)
 Sets the value of SecondaryDirectionProperty. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::FlowLayoutConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from kanzi::FlowLayoutConcept
enum  LayoutDirection {
  DirectionLeftToRight, DirectionRightToLeft, DirectionTopToBottom, DirectionBottomToTop,
  DirectionNearToFar, DirectionFarToNear
}
 Direction (or axis) of the layout, used in both primary and secondary direction. More...
 
- Static Public Attributes inherited from kanzi::FlowLayoutConcept
static PropertyType< FlowLayoutConcept::LayoutDirectionPrimaryDirectionProperty
 PrimaryDirection property. More...
 
static PropertyType< FlowLayoutConcept::LayoutDirectionSecondaryDirectionProperty
 SecondaryDirection property. More...
 

Detailed Description

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

Flow layout concept implementation base class.

FlowLayoutConceptImpl provides the functionality to implement a flow layout. FlowLayoutConceptImpl derives from FlowLayoutConcept, which defines the data and property types used by the implementation. Do not use these classes directly. To use a flow layout in your application use FlowLayout3D or FlowLayout2D. To implement a custom flow layout derive from FlowLayoutConceptImpl. The expected inheritance graph is TBaseClass <- FlowLayoutConceptImpl <- YourClass.

Constructor & Destructor Documentation

◆ FlowLayoutConceptImpl()

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

Constructor.

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

Member Function Documentation

◆ makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
static

◆ getPrimaryDirection()

template<typename TBaseClass , typename TDerivedClass >
FlowLayoutConcept::LayoutDirection kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass >::getPrimaryDirection ( ) const

Gets the value of PrimaryDirectionProperty.

See also
setPrimaryDirection()

◆ setPrimaryDirection()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass >::setPrimaryDirection ( LayoutDirection  value)

Sets the value of PrimaryDirectionProperty.

See also
getPrimaryDirection()

◆ getSecondaryDirection()

template<typename TBaseClass , typename TDerivedClass >
FlowLayoutConcept::LayoutDirection kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass >::getSecondaryDirection ( ) const

◆ setSecondaryDirection()

template<typename TBaseClass , typename TDerivedClass >
void kanzi::FlowLayoutConceptImpl< TBaseClass, TDerivedClass >::setSecondaryDirection ( LayoutDirection  value)

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