Kanzi  3.9.4
Kanzi Engine API
kanzi::ContentLayoutConcept Class Reference

Use the Content Layout nodes to present complex content as one element in the UI. More...

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

Inheritance diagram for kanzi::ContentLayoutConcept:
[legend]

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Provides the Kanzi Studio editor metadata for the ContentLayoutConcept. More...
 

Static Public Attributes

Properties
static PropertyType< Vector2HorizontalPaddingProperty
 Sets the padding spaces between the content and the left and right boundaries of a Content Layout node. More...
 
static PropertyType< Vector2VerticalPaddingProperty
 Sets the padding spaces between the content and the top and bottom boundaries of a Content Layout node. More...
 
static PropertyType< Vector2DepthPaddingProperty
 Sets the padding spaces between the content and the front and back boundaries of a Content Layout 3D node. More...
 

Detailed Description

Use the Content Layout nodes to present complex content as one element in the UI.

You can use a Content Layout node to create a control that adapts to the size of its content, or a control where the content adapts to the size of the control.

Content Layout dimensions

By default the size of a Content Layout node is determined by the size of its child nodes.

Arranging the items in a Content Layout node

In the arrange phase, all items in a Content Layout node receive the allocated size that is the actual size of the layout.

To align the items in a Content Layout node, set in those items the Node::HorizontaAlignmentProperty, Node::VerticalAlignmentProperty, and Node::DepthAlignmentProperty.

Setting the content padding

To add space between the content and boundaries of a Content Layout node, use the padding properties:

See also
For a 2D content layout node, see ContentLayout2D.
For a 3D content layout node, see ContentLayout3D.
Since
Kanzi 3.9.0

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ContentLayoutConcept::makeEditorInfo ( )
static

Provides the Kanzi Studio editor metadata for the ContentLayoutConcept.

Returns
Shared pointer to the PropertyTypeEditorInfo instance.

Member Data Documentation

◆ HorizontalPaddingProperty

PropertyType<Vector2> kanzi::ContentLayoutConcept::HorizontalPaddingProperty
static

Sets the padding spaces between the content and the left and right boundaries of a Content Layout node.

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

See also
ContentLayoutConceptImpl::setHorizontalPadding(), ContentLayoutConceptImpl::getHorizontalPadding()

◆ VerticalPaddingProperty

PropertyType<Vector2> kanzi::ContentLayoutConcept::VerticalPaddingProperty
static

Sets the padding spaces between the content and the top and bottom boundaries of a Content Layout node.

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

See also
ContentLayoutConceptImpl::setVerticalPadding(), ContentLayoutConceptImpl::getVerticalPadding()

◆ DepthPaddingProperty

PropertyType<Vector2> kanzi::ContentLayoutConcept::DepthPaddingProperty
static

Sets the padding spaces between the content and the front and back boundaries of a Content Layout 3D node.

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

See also
ContentLayoutConceptImpl::setDepthPadding(), ContentLayoutConceptImpl::getDepthPadding()

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