Tizen Native API  5.0
Functions | Typedefs | Defines
Edje External
Edje

This group discusses functions of the external section of Edje.

The programmer can create new types for parts, that will be called generically EXTERNALS as they are not native of Edje. The developer must also create plugins that will define the meaning of each extra properties carried by these parts of type EXTERNAL.

As long as there are new types properly registered with the plugins created, the user can use the parts of type EXTERNAL as all the parts of native types.

Functions

const char * edje_external_param_type_str (Edje_External_Param_Type type)
 Converts type identifier to string nicer representation.

Typedefs

typedef enum
_Edje_External_Param_Flags 		Edje_External_Param_Flags
typedef struct _Edje_External_Param Edje_External_Param
typedef struct
_Edje_External_Param_Info 		Edje_External_Param_Info

Defines

#define EDJE_EXTERNAL_INT_UNSET   INT_MAX
#define EDJE_EXTERNAL_DOUBLE_UNSET   DBL_MAX

Define Documentation

#define EDJE_EXTERNAL_DOUBLE_UNSET   DBL_MAX

Helper macro to indicate an EXTERNAL's double parameter is undefined.

#define EDJE_EXTERNAL_INT_UNSET   INT_MAX

Helper macro to indicate an EXTERNAL's integer parameter is undefined.

Typedef Documentation

typedef struct _Edje_External_Param Edje_External_Param

Struct that holds parameters for parts of type EXTERNAL.

typedef enum _Edje_External_Param_Flags Edje_External_Param_Flags

Flags that determine how a parameter may be accessed in different circumstances.

typedef struct _Edje_External_Param_Info Edje_External_Param_Info

Struct holding information about an EXTERNAL part's parameters.

When creating types to use with EXTERNAL parts, an array of this type is used to describe the different parameters the object uses.

This struct holds the name, type and flags that define how and when the parameter is used, as well as information specific to each type, like the maximum or minimum value, that can be used by editors to restrict the range of values to set for each parameter.

Enumeration Type Documentation

enum _Edje_External_Param_Flags

Flags that determine how a parameter may be accessed in different circumstances.

Enumerator:
EDJE_EXTERNAL_PARAM_FLAGS_NONE 

Property is incapable of operations, this is used to catch bogus flags.

EDJE_EXTERNAL_PARAM_FLAGS_GET 

Property can be read/get.

EDJE_EXTERNAL_PARAM_FLAGS_SET 

Property can be written/set. This only enables edje_object_part_external_param_set() and Embryo scripts. To enable the parameter being set from state description whenever it changes state, use EDJE_EXTERNAL_PARAM_FLAGS_STATE.

EDJE_EXTERNAL_PARAM_FLAGS_STATE 

Property can be set from state description.

EDJE_EXTERNAL_PARAM_FLAGS_CONSTRUCTOR 

This property is only set once when the object is constructed using its value from "default" 0.0 state description. Setting this overrides EDJE_EXTERNAL_PARAM_FLAGS_STATE.

EDJE_EXTERNAL_PARAM_FLAGS_REGULAR 

Convenience flag that sets property as GET, SET and STATE.

enum Edje_External_Param_Type

The possible types the parameters of an EXTERNAL part can be.

Enumerator:
EDJE_EXTERNAL_PARAM_TYPE_INT 

Parameter value is an integer.

EDJE_EXTERNAL_PARAM_TYPE_DOUBLE 

Parameter value is a double.

EDJE_EXTERNAL_PARAM_TYPE_STRING 

Parameter value is a string.

EDJE_EXTERNAL_PARAM_TYPE_BOOL 

Parameter value is boolean.

EDJE_EXTERNAL_PARAM_TYPE_CHOICE 

Parameter value is one of a set of predefined string choices.

EDJE_EXTERNAL_PARAM_TYPE_MAX 

Sentinel value to indicate last enum field during iteration

Function Documentation

const char* edje_external_param_type_str ( Edje_External_Param_Type  type)

Converts type identifier to string nicer representation.

This may be used to debug or other informational purposes.

Parameters:
typethe identifier to convert.
Returns:
the string with the string representation, or "(unknown)".
Since :
3.0