kzu_ui_stack_layout.h File Reference

User interface stack layout component. More...

#include <user/scene_graph/kzu_object_common.h>
#include <user/ui/kzu_layout.h>

Functions
kzsError	kzuUiStackLayoutCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuUiStackLayout **out_stackLayout)
	Creates a stack layout with default settings. More...
kzsError	kzuUiStackLayoutRegisterToFactory (const struct KzuFactory *factory)
	Registers component type to factory. More...
struct KzuUiComponentNode *	kzuUiStackLayoutToUiComponentNode (const struct KzuUiStackLayout *stackLayout)
	Casts to UiComponentNode. More...
struct KzuUiStackLayout *	kzuUiStackLayoutFromUiComponentNode (const struct KzuUiComponentNode *component)
	Casts to UiStackLayout. More...
enum KzuStackLayoutDirection	kzuUiStackLayoutGetDirection (const struct KzuUiStackLayout *stackLayout)
	Get the direction of the stack layout. More...
kzBool	kzuUiStackLayoutIsReversed (const struct KzuUiStackLayout *stackLayout)
	Get the reversed property of the stack layout. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_UI_STACK_LAYOUT
	Object type for stack layout. More...

Detailed Description

User interface stack layout component.

KzuUiStackLayout lays out its children along a user-specified axis in order.

Stack Layout Messages

KzuUiStackLayout does not send or receive any messages.

Stack Layout Properties

KZU_PROPERTY_TYPE_STACK_LAYOUT_DIRECTION integer property specifies the stack layout axis. The stack layout size cannot be restricted along the layout axis (KzuUiFlowLayout can be used for that). The value should be one of KzuStackLayoutDirection values. The default value is KZU_STACK_LAYOUT_DIRECTION_X.

KZU_PROPERTY_TYPE_STACK_LAYOUT_REVERSED Boolean property can be set to reverse the layout direction along the layout axis. The default value is KZ_FALSE.

See Also

kzu_stack_layer.h for the 2D version of this component, kzu_ui_flow_layout.h.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuUiStackLayoutCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuUiStackLayout **	out_stackLayout
	)

Creates a stack layout with default settings.

kzsError kzuUiStackLayoutRegisterToFactory

(

const struct KzuFactory *

factory)

Registers component type to factory.

struct KzuUiComponentNode* kzuUiStackLayoutToUiComponentNode

(

const struct KzuUiStackLayout *

stackLayout)

Casts to UiComponentNode.

struct KzuUiStackLayout* kzuUiStackLayoutFromUiComponentNode

(

const struct KzuUiComponentNode *

component)

Casts to UiStackLayout.

enum KzuStackLayoutDirection kzuUiStackLayoutGetDirection

(

const struct KzuUiStackLayout *

stackLayout)

Get the direction of the stack layout.

kzBool kzuUiStackLayoutIsReversed

(

const struct KzuUiStackLayout *

stackLayout)

Get the reversed property of the stack layout.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_UI_STACK_LAYOUT

Object type for stack layout.