kzu_button_layer.h File Reference

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	kzuButtonLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuButtonLayer **out_buttonLayer)
	Creates a button layer. More...
kzsError	kzuButtonLayerRegisterToFactory (const struct KzuFactory *factory)
	Registers button layer to the factory. More...
struct KzuButtonLayer *	kzuButtonLayerFromLayer (const struct KzuLayer *layer)
	Converts a layer into a button layer. More...
struct KzuLayer *	kzuButtonLayerToLayer (const struct KzuButtonLayer *buttonLayer)
	Converts a button layer into a layer. More...
kzFloat	kzuButtonLayerGetLongPressInterval (const struct KzuButtonLayer *buttonLayer)
	Gets the long press interval property of a button layer. More...
kzFloat	kzuButtonLayerGetRepeatInterval (const struct KzuButtonLayer *buttonLayer)
	Gets the repeat interval property of a button layer. More...

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

Detailed Description

Button layer class.

See Also

kzu_ui_button.h for documentation concerning all Kanzi buttons, including KzuButtonLayer.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuButtonLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuButtonLayer **	out_buttonLayer
	)

Creates a button layer.

kzsError kzuButtonLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers button layer to the factory.

struct KzuButtonLayer* kzuButtonLayerFromLayer

(

const struct KzuLayer *

layer)

Converts a layer into a button layer.

struct KzuLayer* kzuButtonLayerToLayer

(

const struct KzuButtonLayer *

buttonLayer)

Converts a button layer into a layer.

kzFloat kzuButtonLayerGetLongPressInterval

(

const struct KzuButtonLayer *

buttonLayer)

Gets the long press interval property of a button layer.

The value is the same as the (default) value of the property KZU_PROPERTY_TYPE_BUTTON_LONG_PRESS_INTERVAL. When the value is greater than zero, the KZU_MESSAGE_BUTTON_LONG_PRESS message is generated.

kzFloat kzuButtonLayerGetRepeatInterval

(

const struct KzuButtonLayer *

buttonLayer)

Gets the repeat interval property of a button layer.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_BUTTON_LAYER

Object type for button layers.