kzu_expression_validator.h File Reference

Expression validator. More...

#include <user/ui/binding/kzu_binding_validator_base.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Enumerations
enum	KzuExpressionValidatorArgumentType {   KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE, KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TARGET, KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE_REGISTER_0, KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_CONSTANT_REGISTER_0,   KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TEMPORARY_REGISTER_0 }
	Expression argument type. More...
enum	KzuExpressionValidatorOperation {   KZU_EXPRESSION_VALIDATOR_OPERATION_WRITE, KZU_EXPRESSION_VALIDATOR_OPERATION_ADD, KZU_EXPRESSION_VALIDATOR_OPERATION_SUBTRACT, KZU_EXPRESSION_VALIDATOR_OPERATION_MULTIPLY,   KZU_EXPRESSION_VALIDATOR_OPERATION_DIVIDE, KZU_EXPRESSION_VALIDATOR_OPERATION_MODULO, KZU_EXPRESSION_VALIDATOR_OPERATION_ABS, KZU_EXPRESSION_VALIDATOR_OPERATION_MAX,   KZU_EXPRESSION_VALIDATOR_OPERATION_MIN, KZU_EXPRESSION_VALIDATOR_OPERATION_CEIL, KZU_EXPRESSION_VALIDATOR_OPERATION_FLOOR, KZU_EXPRESSION_VALIDATOR_OPERATION_ROUND,   KZU_EXPRESSION_VALIDATOR_OPERATION_POW, KZU_EXPRESSION_VALIDATOR_OPERATION_SQRT, KZU_EXPRESSION_VALIDATOR_OPERATION_STEP, KZU_EXPRESSION_VALIDATOR_OPERATION_TO_BOOL,   KZU_EXPRESSION_VALIDATOR_OPERATION_TO_INT, KZU_EXPRESSION_VALIDATOR_OPERATION_TO_FLOAT, KZU_EXPRESSION_VALIDATOR_OPERATION_TO_STRING }
	Expression operation. More...

Functions
kzsError	kzuExpressionValidatorCreate (const struct KzcMemoryManager *memoryManager, struct KzuPropertyManager *propertyManager, struct KzuBindingValidator **out_validator)
	Create an expression validator. More...
kzsError	kzuExpressionValidatorCopyClassData_protected (const struct KzuBindingValidator *targetValidator, const struct KzuBindingValidator *sourceValidator)
	This class copy function. More...
struct KzuVariant *	kzuExpressionValidatorGetArgument (const struct KzuBindingRule *rule, enum KzuExpressionValidatorArgumentType argumentType)
	Get expression validator argument. More...

Variables
const KzuBindingValidatorType	KZU_BINDING_VALIDATOR_TYPE_EXPRESSION
	Expression validator type. More...

Detailed Description

Expression validator.

An expression validator can be used to modify a binding rule value before it is written to the binding rule target. See kzu_scroll_layer.h example code for an example.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuExpressionValidatorArgumentType

Expression argument type.

Enumerator
KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE
KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TARGET
KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_SOURCE_REGISTER_0
KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_CONSTANT_REGISTER_0
KZU_EXPRESSION_VALIDATOR_ARGUMENT_TYPE_TEMPORARY_REGISTER_0

enum KzuExpressionValidatorOperation

Expression operation.

Enumerator
KZU_EXPRESSION_VALIDATOR_OPERATION_WRITE
KZU_EXPRESSION_VALIDATOR_OPERATION_ADD
KZU_EXPRESSION_VALIDATOR_OPERATION_SUBTRACT
KZU_EXPRESSION_VALIDATOR_OPERATION_MULTIPLY
KZU_EXPRESSION_VALIDATOR_OPERATION_DIVIDE
KZU_EXPRESSION_VALIDATOR_OPERATION_MODULO
KZU_EXPRESSION_VALIDATOR_OPERATION_ABS
KZU_EXPRESSION_VALIDATOR_OPERATION_MAX
KZU_EXPRESSION_VALIDATOR_OPERATION_MIN
KZU_EXPRESSION_VALIDATOR_OPERATION_CEIL
KZU_EXPRESSION_VALIDATOR_OPERATION_FLOOR
KZU_EXPRESSION_VALIDATOR_OPERATION_ROUND
KZU_EXPRESSION_VALIDATOR_OPERATION_POW
KZU_EXPRESSION_VALIDATOR_OPERATION_SQRT
KZU_EXPRESSION_VALIDATOR_OPERATION_STEP
KZU_EXPRESSION_VALIDATOR_OPERATION_TO_BOOL
KZU_EXPRESSION_VALIDATOR_OPERATION_TO_INT
KZU_EXPRESSION_VALIDATOR_OPERATION_TO_FLOAT
KZU_EXPRESSION_VALIDATOR_OPERATION_TO_STRING

Function Documentation

kzsError kzuExpressionValidatorCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPropertyManager *	propertyManager,
		struct KzuBindingValidator **	out_validator
	)

Create an expression validator.

kzsError kzuExpressionValidatorCopyClassData_protected	(	const struct KzuBindingValidator *	targetValidator,
		const struct KzuBindingValidator *	sourceValidator
	)

This class copy function.

struct KzuVariant* kzuExpressionValidatorGetArgument	(	const struct KzuBindingRule *	rule,
		enum KzuExpressionValidatorArgumentType	argumentType
	)

Get expression validator argument.

Variable Documentation

const KzuBindingValidatorType KZU_BINDING_VALIDATOR_TYPE_EXPRESSION

Expression validator type.