kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

Dock layout concept implementation base class. More...

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

Inheritance diagram for kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >:

Public Member Functions
bool	isLastItemFill () const
	Gets the value of the DockLayoutConcept::LastItemFillProperty. More...
void	setLastItemFill (bool value)
	Sets the value of DockLayoutConcept::LastItemFillProperty. More...

Static Public Member Functions
static DockingSide	getSide (const Node &item)
	Gets the docking side of an item. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
static void	setSide (Node &item, DockingSide value)
	Sets the docking side of an item. More...
Static Public Member Functions inherited from kanzi::DockLayoutConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
	DockLayoutConceptImpl (Domain *domain, string_view name)
	Constructor. More...

Additional Inherited Members
Public Types inherited from kanzi::DockLayoutConcept
enum	DockingSide { DockLeft, DockRight, DockTop, DockBottom }
	Docking side of dock layout item. More...
Static Public Attributes inherited from kanzi::DockLayoutConcept
static PropertyType< bool >	LastItemFillProperty
	LastItemFill property. More...
static PropertyType< DockLayoutConcept::DockingSide >	SideProperty
	Side property. More...

Detailed Description

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

Dock layout concept implementation base class.

DockLayoutConceptImpl provides functionality to implement a dock layout. DockLayoutConceptImpl derives from DockLayoutConcept, which defines the data and property types used by the implementation. Do not use this class directly. To use a dock layout in your application use DockLayout2D or DockLayout3D. To implement a custom dock layout derive from DockLayoutConceptImpl. The expected inheritance graph is TBaseClass <- DockLayoutConceptImpl <- YourClass.

Constructor & Destructor Documentation

DockLayoutConceptImpl()

template<typename TBaseClass , typename TDerivedClass >

kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::DockLayoutConceptImpl ( Domain *  domain, string_view  name  )

explicitprotected

Constructor.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Member Function Documentation

makeEditorInfo()

template<typename TBaseClass , typename TDerivedClass >

PropertyTypeEditorInfoSharedPtr kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )

static

isLastItemFill()

template<typename TBaseClass , typename TDerivedClass >

bool kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::isLastItemFill

(

)

const

Gets the value of the DockLayoutConcept::LastItemFillProperty.

See also

setLastItemFill()

setLastItemFill()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::setLastItemFill

(

bool

value

)

Sets the value of DockLayoutConcept::LastItemFillProperty.

getSide()

template<typename TBaseClass , typename TDerivedClass >

DockLayoutConcept::DockingSide kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::getSide ( const Node &  item )

static

Gets the docking side of an item.

See also

DockLayoutConcept::DockingSide, DockLayoutConceptImpl::setSide()

setSide()

template<typename TBaseClass , typename TDerivedClass >

void kanzi::DockLayoutConceptImpl< TBaseClass, TDerivedClass >::setSide ( Node &  item, DockLayoutConcept::DockingSide  value  )

static

Sets the docking side of an item.

See also

DockLayoutConcept::DockingSide, DockLayoutConceptImpl::getSide()

---

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

• kanzi/ui/node/concept/dock_layout.hpp
• kanzi/ui/node/concept/dock_layout_concept_impl.hpp