kzu_stack_layer.h File Reference

2D user interface stack layout component. More...

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

Functions
kzsError	kzuStackLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuStackLayer **out_stackLayer)
	Creates an stack layer. More...
kzsError	kzuStackLayerRegisterToFactory (const struct KzuFactory *factory)
	Registers stack layer to the factory. More...
struct KzuStackLayer *	kzuStackLayerFromLayer (const struct KzuLayer *layer)
	Converts layer to stack layer. More...
struct KzuLayer *	kzuStackLayerToLayer (const struct KzuStackLayer *stackLayer)
	Converts stack layer to layer. More...
enum KzuStackLayoutDirection	kzuStackLayerGetDirection (const struct KzuStackLayer *stackLayer)
	Get the direction of the stack layout. More...
kzBool	kzuStackLayerIsReversed (const struct KzuStackLayer *stackLayer)
	Get the reversed property of the stack layout. More...

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

Detailed Description

2D user interface stack layout component.

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

Stack Layer Messages

KzuStackLayer does not send or receive any messages.

Stack Layer Properties

KZU_PROPERTY_TYPE_STACK_LAYOUT_DIRECTION integer property specifies the stack layer axis. The stack layer size cannot be restricted along the layout axis (::KzuFlowLayer can be used for that). The value should either KZU_STACK_LAYOUT_DIRECTION_X or KZU_STACK_LAYOUT_DIRECTION_Y. 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_ui_stack_layout.h for the 3D version of this layout, kzu_flow_layer.h.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuStackLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuStackLayer **	out_stackLayer
	)

Creates an stack layer.

kzsError kzuStackLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers stack layer to the factory.

struct KzuStackLayer* kzuStackLayerFromLayer

(

const struct KzuLayer *

layer)

Converts layer to stack layer.

struct KzuLayer* kzuStackLayerToLayer

(

const struct KzuStackLayer *

stackLayer)

Converts stack layer to layer.

enum KzuStackLayoutDirection kzuStackLayerGetDirection

(

const struct KzuStackLayer *

stackLayer)

Get the direction of the stack layout.

kzBool kzuStackLayerIsReversed

(

const struct KzuStackLayer *

stackLayer)

Get the reversed property of the stack layout.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_STACK_LAYER

Object type for stack layout.