_Edje_External_Type Struct Reference

Information about an external type to be used. More...

Data Fields

unsigned int abi_version
 always use:


Evas_Object *(* add )(void *data, Evas *evas, Evas_Object *parent, const Eina_List *params, const char *part_name)
 creates the object to be used by Edje as the part
Evas_Object *(* content_get )(void *data, const Evas_Object *obj, const char *content)
 dynamically fetch a sub object of this external, called by scripts and user code.
void * data
const char *(* description_get )(void *data)
Evas_Object *(* icon_add )(void *data, Evas *e)
const char *(* label_get )(void *data)
const char * module
const char * module_name
Eina_Bool(* param_get )(void *data, const Evas_Object *obj, Edje_External_Param *param)
 dynamically fetch a parameter of this external, called by scripts and user code.
Eina_Bool(* param_set )(void *data, Evas_Object *obj, const Edje_External_Param *param)
 dynamically change a parameter of this external, called by scripts and user code.
Edje_External_Param_Info * parameters_info
void(* params_free )(void *params)
 free parameters parsed with params_parse()
void *(* params_parse )(void *data, Evas_Object *obj, const Eina_List *params)
 parses the list of parameters, converting into a friendly representation.
Evas_Object *(* preview_add )(void *data, Evas *e)
void(* signal_emit )(void *data, Evas_Object *obj, const char *emission, const char *source)
 Feed a signal emitted with emission originally set as part_name:signal to this object (without the "part_name:" prefix).
void(* state_set )(void *data, Evas_Object *obj, const void *from_params, const void *to_params, float pos)
 called upon state changes, including the initial "default" 0.0 state.
const char *(* translate )(void *data, const char *orig)
 called to translate parameters_info name properties for use in user interfaces that support internationalization (i18n)

Detailed Description

Information about an external type to be used.

This structure provides information on how to display and modify a third party Evas_Object in Edje.

Some function pointers are not really used by Edje, but provide means for Edje users to better interact with such objects. For instance, an editor may use label_get() and icon_get() to list all registered external types.

Note:
The function pointers provided in this structure must check for errors and invalid or out-of-range values as for performance reasons Edje will not enforce hints provided as Edje_External_Param_Info in the member parameters_info.

Field Documentation

unsigned int _Edje_External_Type::abi_version

always use:

Referenced by edje_external_type_array_register(), and edje_external_type_register().

Evas_Object*(* _Edje_External_Type::add)(void *data, Evas *evas, Evas_Object *parent, const Eina_List *params, const char *part_name)

creates the object to be used by Edje as the part

Referenced by _edje_external_type_add().

Evas_Object*(* _Edje_External_Type::content_get)(void *data, const Evas_Object *obj, const char *content)

dynamically fetch a sub object of this external, called by scripts and user code.

Returns Evas_Object * on success. (Must check parameter name and type!)

Referenced by _edje_external_content_get().

void* _Edje_External_Type::data

Referenced by _edje_external_content_get(), _edje_external_param_get(), _edje_external_param_set(), _edje_external_params_parse(), _edje_external_recalc_apply(), _edje_external_signal_emit(), and _edje_external_type_add().

const char*(* _Edje_External_Type::description_get)(void *data)
Evas_Object*(* _Edje_External_Type::icon_add)(void *data, Evas *e)
const char*(* _Edje_External_Type::label_get)(void *data)
const char* _Edje_External_Type::module

Referenced by _edje_external_content_get(), _edje_external_param_get(), and _edje_external_param_set().

const char* _Edje_External_Type::module_name

Referenced by _edje_external_content_get(), _edje_external_param_get(), _edje_external_param_set(), and edje_object_part_external_param_type_get().

Eina_Bool(* _Edje_External_Type::param_get)(void *data, const Evas_Object *obj, Edje_External_Param *param)

dynamically fetch a parameter of this external, called by scripts and user code.

Returns EINA_TRUE on success. (Must check parameter name and type!)

Referenced by _edje_external_param_get().

Eina_Bool(* _Edje_External_Type::param_set)(void *data, Evas_Object *obj, const Edje_External_Param *param)

dynamically change a parameter of this external, called by scripts and user code.

Returns EINA_TRUE on success

Referenced by _edje_external_param_set().

Edje_External_Param_Info* _Edje_External_Type::parameters_info

Referenced by edje_external_param_info_get(), and edje_object_part_external_param_type_get().

void(* _Edje_External_Type::params_free)(void *params)

free parameters parsed with params_parse()

Referenced by _edje_external_parsed_params_free().

void*(* _Edje_External_Type::params_parse)(void *data, Evas_Object *obj, const Eina_List *params)

parses the list of parameters, converting into a friendly representation.

Used with state_set()

Referenced by _edje_external_params_parse().

Evas_Object*(* _Edje_External_Type::preview_add)(void *data, Evas *e)
void(* _Edje_External_Type::signal_emit)(void *data, Evas_Object *obj, const char *emission, const char *source)

Feed a signal emitted with emission originally set as part_name:signal to this object (without the "part_name:" prefix).

Referenced by _edje_external_signal_emit().

void(* _Edje_External_Type::state_set)(void *data, Evas_Object *obj, const void *from_params, const void *to_params, float pos)

called upon state changes, including the initial "default" 0.0 state.

Parameters are the value returned by params_parse()

Referenced by _edje_external_recalc_apply().

const char*(* _Edje_External_Type::translate)(void *data, const char *orig)

called to translate parameters_info name properties for use in user interfaces that support internationalization (i18n)

The documentation for this struct was generated from the following file: