Tizen Native API
|
Functions | |
void | evas_object_clip_set (Evas_Object *obj, Evas_Object *clip) |
Clips one object to another. | |
Evas_Object * | evas_object_clip_get (const Evas_Object *obj) |
Gets the object clipping obj (if any). | |
void | evas_object_clip_unset (Evas_Object *obj) |
Disables or ceases clipping on a clipped obj object. | |
const Eina_List * | evas_object_clipees_get (const Evas_Object *obj) |
Gets a list of objects currently clipped by obj. | |
void | evas_object_focus_set (Evas_Object *obj, Eina_Bool focus) |
Sets or unsets a given object as the currently focused one on its canvas. | |
Eina_Bool | evas_object_focus_get (const Evas_Object *obj) |
Checks whether an object has the focus. | |
void | evas_object_layer_set (Evas_Object *obj, short l) |
Sets the layer of its canvas that the given object is part of. | |
short | evas_object_layer_get (const Evas_Object *obj) |
Gets the layer of its canvas that the given object is part of. | |
void | evas_object_name_set (Evas_Object *obj, const char *name) |
Sets the name of the given Evas object to the given name. | |
const char * | evas_object_name_get (const Evas_Object *obj) |
Gets the name of the given Evas object. | |
void | evas_object_ref (Evas_Object *obj) |
Increments object reference count to defer its deletion. | |
void | evas_object_unref (Evas_Object *obj) |
Decrements object reference count. | |
int | evas_object_ref_get (const Evas_Object *obj) |
Gets the object reference count. | |
void | evas_object_del (Evas_Object *obj) |
Marks the given Evas object for deletion (when Evas frees its memory). | |
void | evas_object_move (Evas_Object *obj, Evas_Coord x, Evas_Coord y) |
Moves the given Evas object to the given location inside its canvas' viewport. | |
void | evas_object_resize (Evas_Object *obj, Evas_Coord w, Evas_Coord h) |
Changes the size of the given Evas object. | |
void | evas_object_geometry_get (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) |
Gets the position and (rectangular) size of the given Evas object. | |
void | evas_object_show (Evas_Object *obj) |
Makes the given Evas object visible. | |
void | evas_object_hide (Evas_Object *obj) |
Makes the given Evas object invisible. | |
Eina_Bool | evas_object_visible_get (const Evas_Object *obj) |
Checks whether the given Evas object is visible. | |
void | evas_object_color_set (Evas_Object *obj, int r, int g, int b, int a) |
Sets the general or main color of the given Evas object. | |
void | evas_object_color_get (const Evas_Object *obj, int *r, int *g, int *b, int *a) |
Gets the general or main color of the given Evas object. | |
Evas * | evas_object_evas_get (const Evas_Object *obj) |
Gets the Evas canvas that the given object lives on. | |
const char * | evas_object_type_get (const Evas_Object *obj) |
Gets the type of the given Evas object. | |
void | evas_object_raise (Evas_Object *obj) |
Raises obj to the top of its layer. | |
void | evas_object_lower (Evas_Object *obj) |
Lowers obj to the bottom of its layer. | |
void | evas_object_stack_above (Evas_Object *obj, Evas_Object *above) |
Stacks obj immediately above above. | |
void | evas_object_stack_below (Evas_Object *obj, Evas_Object *below) |
Stacks obj immediately below below. | |
Evas_Object * | evas_object_above_get (const Evas_Object *obj) |
Gets the Evas object stacked right above obj. | |
Evas_Object * | evas_object_below_get (const Evas_Object *obj) |
Gets the Evas object stacked right below obj. |
This group provides functions for basic object manipulation.
Evas_Object* evas_object_above_get | ( | const Evas_Object * | obj | ) |
Gets the Evas object stacked right above obj.
[in] | obj | An Evas_Object |
NULL
if noneEvas_Object* evas_object_below_get | ( | const Evas_Object * | obj | ) |
Gets the Evas object stacked right below obj.
This function traverses layers in its search, if there are objects on layers below the one obj is placed at.
[in] | obj | An Evas_Object |
NULL
if noneEvas_Object* evas_object_clip_get | ( | const Evas_Object * | obj | ) |
Gets the object clipping obj (if any).
This function returns the object clipping obj. If obj is not being clipped at all, NULL
is returned. The object obj must be a valid Evas_Object.
[in] | obj | The object to get the clipper from |
NULL
is returned. void evas_object_clip_set | ( | Evas_Object * | obj, |
Evas_Object * | clip | ||
) |
Clips one object to another.
This function clips the object obj to the area occupied by the object clip. This means the object obj is only visible within the area occupied by the clipping object (clip).
RESULT = (OBJ * CLIP) / (255 * 255)
, per color element (red, green, blue and alpha).NULL
, in which case the effect of this function is the same as calling evas_object_clip_unset() on the obj object.[in] | obj | The object to be clipped |
[in] | clip | The object to clip obj by |
void evas_object_clip_unset | ( | Evas_Object * | obj | ) |
Disables or ceases clipping on a clipped obj object.
This function disables clipping for the object obj, if it is already clipped, i.e., its visibility and color get detached from the previous clipper. If it is not already clipped, this has no effect. The object obj must be a valid Evas_Object.
[in] | obj | The object to cease clipping on |
const Eina_List* evas_object_clipees_get | ( | const Evas_Object * | obj | ) |
Gets a list of objects currently clipped by obj.
This returns the internal list handle that contains all objects clipped by the object obj. If none are clipped by it, the call returns NULL
. This list is only valid until the clip list is changed and should be fetched again with another call to evas_object_clipees_get() if any objects being clipped by this object are unclipped, clipped by a new object, deleted or get the clipper deleted. These operations invalidate the list returned, so it should not be used anymore after that point. Any use of the list after this may have undefined results, possibly leading to crashes. The object obj must be a valid Evas_Object.
extern Evas_Object *obj; Evas_Object *clipper; clipper = evas_object_clip_get(obj); if (clipper) { Eina_List *clippees, *l; Evas_Object *obj_tmp; clippees = evas_object_clipees_get(clipper); printf("Clipper clips %i objects\n", eina_list_count(clippees)); EINA_LIST_FOREACH(clippees, l, obj_tmp) evas_object_show(obj_tmp); }
[in] | obj | The object to get a list of clippees from |
void evas_object_color_get | ( | const Evas_Object * | obj, |
int * | r, | ||
int * | g, | ||
int * | b, | ||
int * | a | ||
) |
Gets the general or main color of the given Evas object.
0
means totally transparent, while 255
means opaque. These color values are premultiplied by the alpha value.255 255 255 255
(opaque white).NULL
pointers on the components you are not interested in: they are ignored by the function.[in] | obj | The given Evas object to retrieve color from |
[out] | r | The pointer to an integer in which to store the red component of the color |
[out] | g | The pointer to an integer in which to store the green component of the color |
[out] | b | The pointer to an integer in which to store the blue component of the color |
[out] | a | The pointer to an integer in which to store the alpha component of the color |
void evas_object_color_set | ( | Evas_Object * | obj, |
int | r, | ||
int | g, | ||
int | b, | ||
int | a | ||
) |
Sets the general or main color of the given Evas object.
[in] | obj | The given Evas object |
[in] | r | The red component of the given color |
[in] | g | The green component of the given color |
[in] | b | The blue component of the given color |
[in] | a | The alpha component of the given color |
void evas_object_del | ( | Evas_Object * | obj | ) |
Marks the given Evas object for deletion (when Evas frees its memory).
This call marks obj for deletion, which takes place whenever it has no more references to it (see evas_object_ref() and evas_object_unref()).
[in] | obj | The given Evas object |
Evas* evas_object_evas_get | ( | const Evas_Object * | obj | ) |
Gets the Evas canvas that the given object lives on.
This function is most useful at code contexts where you need to operate on the canvas but have only the object pointer.
[in] | obj | The given Evas object |
Eina_Bool evas_object_focus_get | ( | const Evas_Object * | obj | ) |
Checks whether an object has the focus.
[in] | obj | The object to retrieve focus information from |
void evas_object_focus_set | ( | Evas_Object * | obj, |
Eina_Bool | focus | ||
) |
Sets or unsets a given object as the currently focused one on its canvas.
[in] | obj | The object to be focused or unfocused |
[in] | focus | EINA_TRUE to set it as focused, otherwise EINA_FALSE to take away the focus from it |
void evas_object_geometry_get | ( | const Evas_Object * | obj, |
Evas_Coord * | x, | ||
Evas_Coord * | y, | ||
Evas_Coord * | w, | ||
Evas_Coord * | h | ||
) |
Gets the position and (rectangular) size of the given Evas object.
NULL
pointers on the geometry components you are not interested in: they are ignored by the function.[in] | obj | The given Evas object |
[out] | x | The pointer to an integer in which to store the X coordinate of the object |
[out] | y | The pointer to an integer in which to store the Y coordinate of the object |
[out] | w | The pointer to an integer in which to store the width of the object |
[out] | h | The pointer to an integer in which to store the height of the object |
void evas_object_hide | ( | Evas_Object * | obj | ) |
Makes the given Evas object invisible.
[in] | obj | The given Evas object |
short evas_object_layer_get | ( | const Evas_Object * | obj | ) |
Gets the layer of its canvas that the given object is part of.
[in] | obj | The given Evas object to query the layer from |
void evas_object_layer_set | ( | Evas_Object * | obj, |
short | l | ||
) |
Sets the layer of its canvas that the given object is part of.
[in] | obj | The given Evas object |
[in] | l | The number of the layer to place the object on This must be between EVAS_LAYER_MIN and EVAS_LAYER_MAX. |
void evas_object_lower | ( | Evas_Object * | obj | ) |
Lowers obj to the bottom of its layer.
[in] | obj | The object to lower |
void evas_object_move | ( | Evas_Object * | obj, |
Evas_Coord | x, | ||
Evas_Coord | y | ||
) |
Moves the given Evas object to the given location inside its canvas' viewport.
0, 0
.[in] | obj | The given Evas object |
[in] | x | The X position to move the object to, in canvas units |
[in] | y | The Y position to move the object to, in canvas units |
const char* evas_object_name_get | ( | const Evas_Object * | obj | ) |
Gets the name of the given Evas object.
[in] | obj | The given object |
NULL
if no name has been given to it void evas_object_name_set | ( | Evas_Object * | obj, |
const char * | name | ||
) |
Sets the name of the given Evas object to the given name.
[in] | obj | The given object |
[in] | name | The given name |
void evas_object_raise | ( | Evas_Object * | obj | ) |
Raises obj to the top of its layer.
[in] | obj | The object to raise |
void evas_object_ref | ( | Evas_Object * | obj | ) |
Increments object reference count to defer its deletion.
0
defers deletion by evas_object_del() until all references are released back (counter back to 0
). References cannot go below 0
and unreferencing past that results in the reference count being limited to 0
. References are limited to 2^32 - 1
for an object. Referencing it more than this results in it being limited to this value.evas_object_ref(obj); // action here... evas_object_smart_callback_call(obj, SIG_SELECTED, NULL); // more action here... evas_object_unref(obj);
[in] | obj | The given Evas object to reference |
int evas_object_ref_get | ( | const Evas_Object * | obj | ) |
Gets the object reference count.
This gets the reference count for an object (normally 0
until it is referenced). Values of 1
or greater mean that someone is holding a reference to this object that needs to be unreffed before it can be deleted.
[in] | obj | The given Evas object to query |
void evas_object_resize | ( | Evas_Object * | obj, |
Evas_Coord | w, | ||
Evas_Coord | h | ||
) |
Changes the size of the given Evas object.
// rescale image to fill exactly its area without tiling: evas_object_resize(img, w, h); evas_object_image_fill_set(img, 0, 0, w, h);
[in] | obj | The given Evas object |
[in] | w | The new width of the Evas object |
[in] | h | The new height of the Evas object |
void evas_object_show | ( | Evas_Object * | obj | ) |
Makes the given Evas object visible.
[in] | obj | The given Evas object |
void evas_object_stack_above | ( | Evas_Object * | obj, |
Evas_Object * | above | ||
) |
Stacks obj immediately above above.
[in] | obj | The object to stack |
[in] | above | The object above which to stack |
void evas_object_stack_below | ( | Evas_Object * | obj, |
Evas_Object * | below | ||
) |
Stacks obj immediately below below.
[in] | obj | The object to stack |
[in] | below | The object below which to stack |
const char* evas_object_type_get | ( | const Evas_Object * | obj | ) |
Gets the type of the given Evas object.
"rectangle"
,"line"
,"polygon"
,"text"
,"textblock"
and"image"
.[in] | obj | The given object |
void evas_object_unref | ( | Evas_Object * | obj | ) |
Decrements object reference count.
This decrements the reference count of an object. If the object has had evas_object_del() called on it while references were more than 0
, it is deleted at the time this function is called and puts the counter back to 0
. See evas_object_ref() for more information.
[in] | obj | The given Evas object to unreference |
Eina_Bool evas_object_visible_get | ( | const Evas_Object * | obj | ) |
Checks whether the given Evas object is visible.
This retrieves an object's visibility as the one enforced by evas_object_show() and evas_object_hide().
[in] | obj | The given Evas object |