Functions to manipulate parts of type EXTERNAL. More...
Functions | |
Evas_Object * | edje_object_part_external_object_get (const Evas_Object *obj, const char *part) |
Get the object created by this external part. More... | |
Eina_Bool | edje_object_part_external_param_set (Evas_Object *obj, const char *part, const Edje_External_Param *param) |
Set the parameter for the external part. More... | |
Eina_Bool | edje_object_part_external_param_get (const Evas_Object *obj, const char *part, Edje_External_Param *param) |
Get the parameter for the external part. More... | |
Evas_Object * | edje_object_part_external_content_get (const Evas_Object *obj, const char *part, const char *content) |
Get an object contained in an part of type EXTERNAL. More... | |
Edje_External_Param_Type | edje_object_part_external_param_type_get (const Evas_Object *obj, const char *part, const char *param) |
Facility to query the type of the given parameter of the given part. More... | |
Functions to manipulate parts of type EXTERNAL.
Edje supports parts of type EXTERNAL, which will call plugins defined by the user to create and manipulate the object that's allocated in that part.
Parts of type external may carry extra properties that have meanings defined by the external plugin. For instance, it may be a string that defines a button label and setting this property will change that label on the fly.
Evas_Object* edje_object_part_external_object_get | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Get the object created by this external part.
Parts of type external creates the part object using information provided by external plugins. It's somehow like "swallow" (edje_object_part_swallow()), but it's all set automatically.
This function returns the part created by such external plugins and being currently managed by this Edje.
obj | A valid Evas_Object handle |
part | The part name |
References EAPI, edje_obj_part_external_object_get, and EINA_UNUSED.
Eina_Bool edje_object_part_external_param_set | ( | Evas_Object * | obj, |
const char * | part, | ||
const Edje_External_Param * | param | ||
) |
Set the parameter for the external part.
Parts of type external may carry extra properties that have meanings defined by the external plugin. For instance, it may be a string that defines a button label and setting this property will change that label on the fly.
obj | A valid Evas_Object handle |
part | The part name |
param | the parameter details, including its name, type and actual value. This pointer should be valid, and the parameter must exist in Edje_External_Type::parameters_info, with the exact type, otherwise the operation will fail and EINA_FALSE will be returned. |
EINA_TRUE
if everything went fine, EINA_FALSE
on errors. References EAPI, edje_obj_part_external_param_set, EINA_FALSE, EINA_TRUE, and _Edje_External_Param::name.
Referenced by edje_edit_state_external_param_set().
Eina_Bool edje_object_part_external_param_get | ( | const Evas_Object * | obj, |
const char * | part, | ||
Edje_External_Param * | param | ||
) |
Get the parameter for the external part.
Parts of type external may carry extra properties that have meanings defined by the external plugin. For instance, it may be a string that defines a button label. This property can be modified by state parameters, by explicit calls to edje_object_part_external_param_set() or getting the actual object with edje_object_part_external_object_get() and calling native functions.
This function asks the external plugin what is the current value, independent on how it was set.
obj | A valid Evas_Object handle |
part | The part name |
param | the parameter details. It is used as both input and output variable. This pointer should be valid, and the parameter must exist in Edje_External_Type::parameters_info, with the exact type, otherwise the operation will fail and EINA_FALSE will be returned. |
EINA_TRUE
if everything went fine and param
members are filled with information, EINA_FALSE
on errors and param
member values are not set or valid. References EAPI, edje_obj_part_external_param_get, EINA_FALSE, and _Edje_External_Param::name.
Evas_Object* edje_object_part_external_content_get | ( | const Evas_Object * | obj, |
const char * | part, | ||
const char * | content | ||
) |
Get an object contained in an part of type EXTERNAL.
The content
string must not be NULL. Its actual value depends on the code providing the EXTERNAL.
obj | The Edje object |
part | The name of the part holding the EXTERNAL |
content | A string identifying which content from the EXTERNAL to get |
References EAPI, edje_obj_part_external_content_get, and EINA_UNUSED.
Edje_External_Param_Type edje_object_part_external_param_type_get | ( | const Evas_Object * | obj, |
const char * | part, | ||
const char * | param | ||
) |
Facility to query the type of the given parameter of the given part.
obj | A valid Evas_Object handle |
part | The part name |
param | the parameter name to use. |
EDJE_EXTERNAL_PARAM_TYPE_MAX
on errors, or another value from Edje_External_Param_Type on success. References EAPI, EDJE_EXTERNAL_PARAM_TYPE_MAX, edje_obj_part_external_param_type_get, evas_object_data_get(), _Edje_External_Type::module_name, _Edje_External_Param_Info::name, _Edje_External_Type::parameters_info, and _Edje_External_Param_Info::type.