kzu_toggle_button_layer.h File Reference

Toggle Button layer class. More...

#include <user/scene_graph/kzu_object_common.h>
#include <user/scene_graph/kzu_object.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuToggleButtonLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuToggleButtonLayer **out_buttonLayer)
	Creates a toggle button layer. More...
kzsError	kzuToggleButtonLayerRegisterToFactory (const struct KzuFactory *factory)
	Registers toggle button layer to the factory. More...
struct KzuToggleButtonLayer *	kzuToggleButtonLayerFromLayer (const struct KzuLayer *layer)
	Converts a layer into a toggle button layer. More...
struct KzuLayer *	kzuToggleButtonLayerToLayer (const struct KzuToggleButtonLayer *buttonLayer)
	Converts a toggle button layer into a layer. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_TOGGLE_BUTTON_LAYER
	Object type for button layers. More...

Detailed Description

Toggle Button layer class.

KzuToggleButtonLayer is a 2D button layout that has KZU_PROPERTY_TYPE_BUTTON_TOGGLE_STATE_COUNT set to 2 by default. The documentation in kzu_ui_button.h is valid for this component also.

See Also

kzu_ui_toggle_button.h for the 3D version of this layer, kzu_ui_button.h for documentation concerning all Kanzi buttons.

Copyright 2013-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuToggleButtonLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuToggleButtonLayer **	out_buttonLayer
	)

Creates a toggle button layer.

kzsError kzuToggleButtonLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers toggle button layer to the factory.

struct KzuToggleButtonLayer* kzuToggleButtonLayerFromLayer

(

const struct KzuLayer *

layer)

Converts a layer into a toggle button layer.

struct KzuLayer* kzuToggleButtonLayerToLayer

(

const struct KzuToggleButtonLayer *

buttonLayer)

Converts a toggle button layer into a layer.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_TOGGLE_BUTTON_LAYER

Object type for button layers.