kzu_ui_toggle_button.h File Reference

User interface toggle button component. 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	kzuUiToggleButtonCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuUiToggleButton **out_toggleButton)
	Creates a toggle button with default settings. More...
kzsError	kzuUiToggleButtonRegisterToFactory (const struct KzuFactory *factory)
	Registers component type to factory. More...
struct KzuUiComponentNode *	kzuUiToggleButtonToUiComponentNode (const struct KzuUiToggleButton *toggleButton)
	Casts to UiComponentNode. More...
struct KzuUiToggleButton *	kzuUiToggleButtonFromUiComponentNode (const struct KzuUiComponentNode *component)
	Casts to UiToggleButton. More...
kzsError	kzuUiToggleButtonSetState (const struct KzuUiToggleButton *toggleButton, kzBool enabled)
	Sets toggle button state. More...
kzBool	kzuUiToggleButtonGetState (const struct KzuUiToggleButton *toggleButton)
	Gets toggle button state. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_UI_TOGGLE_BUTTON
	Object type for toggle button. More...

Detailed Description

User interface toggle button component.

KzuUiToggleButton is a 3D 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_toggle_button_layer.h for the 2D version of this component, kzu_ui_button.h for documentation concerning all Kanzi buttons.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuUiToggleButtonCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuUiToggleButton **	out_toggleButton
	)

Creates a toggle button with default settings.

kzsError kzuUiToggleButtonRegisterToFactory

(

const struct KzuFactory *

factory)

Registers component type to factory.

struct KzuUiComponentNode* kzuUiToggleButtonToUiComponentNode

(

const struct KzuUiToggleButton *

toggleButton)

Casts to UiComponentNode.

struct KzuUiToggleButton* kzuUiToggleButtonFromUiComponentNode

(

const struct KzuUiComponentNode *

component)

Casts to UiToggleButton.

kzsError kzuUiToggleButtonSetState	(	const struct KzuUiToggleButton *	toggleButton,
		kzBool	enabled
	)

Sets toggle button state.

kzBool kzuUiToggleButtonGetState

(

const struct KzuUiToggleButton *

toggleButton)

Gets toggle button state.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_UI_TOGGLE_BUTTON

Object type for toggle button.