Efl.Canvas.Object (class)


Efl canvas object abstract class


Efl.Object (class)

Full hierarchy


above (get) [Overridden from Efl.Gfx.Stack]

Get the Evas object stacked right above obj
Efl_Gfx_Stack *efl_gfx_stack_above_get(const Eo *obj);

anti_alias (get, set)

Eina_Bool efl_canvas_object_anti_alias_get(const Eo *obj);
void efl_canvas_object_anti_alias_set(Eo *obj, Eina_Bool anti_alias);

below (get) [Overridden from Efl.Gfx.Stack]

Get the Evas object stacked right below obj
Efl_Gfx_Stack *efl_gfx_stack_below_get(const Eo *obj);

clip (get, set)

Efl_Canvas_Object *efl_canvas_object_clip_get(const Eo *obj);
void efl_canvas_object_clip_set(Eo *obj, Efl_Canvas_Object *clip);

clipees (get)

Return a list of objects currently clipped by obj.
Eina_Iterator *efl_canvas_object_clipees_get(const Eo *obj);


Test if any object is clipped by obj.
Eina_Bool efl_canvas_object_clipees_has(const Eo *obj);

color (get, set) [Overridden from Efl.Gfx.Color]

void efl_gfx_color_get(const Eo *obj, int *r, int *g, int *b, int *a);
void efl_gfx_color_set(Eo *obj, int r, int g, int b, int a);

constructor [Overridden from Efl.Object]

Call the object's constructor.
Efl_Object *efl_constructor(Eo *obj);

coords_inside (get)

Returns whether the coords are logically inside the object.
Eina_Bool efl_canvas_object_coords_inside_get(const Eo *obj, Eina_Position2D pos);

debug_name_override [Overridden from Efl.Object]

Build a read-only name for this object used for debugging.
void efl_debug_name_override(Eo *obj, Eina_Strbuf *sb);

del [Overridden from Efl.Object]

Unrefs the object and reparents it to NULL.
void efl_del(const Eo *obj);

destructor [Overridden from Efl.Object]

Call the object's destructor.
void efl_destructor(Eo *obj);

event_animation (get, set)

Set the animation which starts when the given event_name happens to the object.
Efl_Animation *efl_canvas_object_event_animation_get(const Eo *obj, const Efl_Event_Description *event_type);
void efl_canvas_object_event_animation_set(Eo *obj, const Efl_Event_Description *event_type, Efl_Animation *animation);

finalize [Overridden from Efl.Object]

Called at the end of efl_add. Should not be called, just overridden.
Efl_Object *efl_finalize(Eo *obj);

freeze_events (get, set)

Eina_Bool efl_canvas_object_freeze_events_get(const Eo *obj);
void efl_canvas_object_freeze_events_set(Eo *obj, Eina_Bool freeze);

geometry (get, set) [Overridden from Efl.Gfx]

Rectangular geometry that combines both position and size.
Eina_Rect efl_gfx_geometry_get(const Eo *obj);
void efl_gfx_geometry_set(Eo *obj, Eina_Rect rect);

hint_align (get, set) [Overridden from Efl.Gfx.Size.Hint]

Hints for an object's alignment.
void efl_gfx_size_hint_align_get(const Eo *obj, double *x, double *y);
void efl_gfx_size_hint_align_set(Eo *obj, double x, double y);

hint_aspect (get, set) [Overridden from Efl.Gfx.Size.Hint]

Defines the aspect ratio to respect when scaling this object.
void efl_gfx_size_hint_aspect_get(const Eo *obj, Efl_Gfx_Size_Hint_Aspect *mode, Eina_Size2D *sz);
void efl_gfx_size_hint_aspect_set(Eo *obj, Efl_Gfx_Size_Hint_Aspect mode, Eina_Size2D sz);

hint_combined_min (get) [Overridden from Efl.Gfx.Size.Hint]

Read-only minimum size combining both Efl.Gfx.Size.Hint.hint_restricted_min and Efl.Gfx.Size.Hint.hint_min size hints.
Eina_Size2D efl_gfx_size_hint_combined_min_get(const Eo *obj);

hint_margin (get, set) [Overridden from Efl.Gfx.Size.Hint]

Hints for an object's margin or padding space.
void efl_gfx_size_hint_margin_get(const Eo *obj, int *l, int *r, int *t, int *b);
void efl_gfx_size_hint_margin_set(Eo *obj, int l, int r, int t, int b);

hint_max (get, set) [Overridden from Efl.Gfx.Size.Hint]

Hints on the object's maximum size.
Eina_Size2D efl_gfx_size_hint_max_get(const Eo *obj);
void efl_gfx_size_hint_max_set(Eo *obj, Eina_Size2D sz);

hint_min (get, set) [Overridden from Efl.Gfx.Size.Hint]

Hints on the object's minimum size.
Eina_Size2D efl_gfx_size_hint_min_get(const Eo *obj);
void efl_gfx_size_hint_min_set(Eo *obj, Eina_Size2D sz);

hint_restricted_min (get, set) protected set [Overridden from Efl.Gfx.Size.Hint]

Internal hints for an object's minimum size.
Eina_Size2D efl_gfx_size_hint_restricted_min_get(const Eo *obj);
void efl_gfx_size_hint_restricted_min_set(Eo *obj, Eina_Size2D sz);

hint_weight (get, set) [Overridden from Efl.Gfx.Size.Hint]

Hints for an object's weight.
void efl_gfx_size_hint_weight_get(const Eo *obj, double *x, double *y);
void efl_gfx_size_hint_weight_set(Eo *obj, double x, double y);

is_frame_object (get, set)

If true the object belongs to the window border decorations.
Eina_Bool efl_canvas_object_is_frame_object_get(const Eo *obj);
void efl_canvas_object_is_frame_object_set(Eo *obj, Eina_Bool is_frame);

key_focus (get, set)

Indicates that this object is the keyboard event receiver on its canvas.
Eina_Bool efl_canvas_object_key_focus_get(const Eo *obj);
void efl_canvas_object_key_focus_set(Eo *obj, Eina_Bool focus);


Requests keyname key events be directed to obj.
Eina_Bool efl_canvas_object_key_grab(Eo *obj, const char *keyname, Efl_Input_Modifier modifiers, Efl_Input_Modifier not_modifiers, Eina_Bool exclusive);


Removes the grab on keyname key events by obj.
void efl_canvas_object_key_ungrab(Eo *obj, const char *keyname, Efl_Input_Modifier modifiers, Efl_Input_Modifier not_modifiers);

layer (get, set) [Overridden from Efl.Gfx.Stack]

short efl_gfx_stack_layer_get(const Eo *obj);
void efl_gfx_stack_layer_set(Eo *obj, short l);

loop (get) [Overridden from Efl.Loop.Consumer]

The loop to which this object belongs to.
Efl_Loop *efl_loop_get(const Eo *obj);

lower [Overridden from Efl.Gfx.Stack]

Lower obj to the bottom of its layer.
void efl_gfx_stack_lower(Eo *obj);

no_render (get, set)

Eina_Bool efl_canvas_object_no_render_get(const Eo *obj);
void efl_canvas_object_no_render_set(Eo *obj, Eina_Bool enable);

paragraph_direction (get, set)

This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit.
Efl_Text_Bidirectional_Type efl_canvas_object_paragraph_direction_get(const Eo *obj);
void efl_canvas_object_paragraph_direction_set(Eo *obj, Efl_Text_Bidirectional_Type dir);

pass_events (get, set)

Eina_Bool efl_canvas_object_pass_events_get(const Eo *obj);
void efl_canvas_object_pass_events_set(Eo *obj, Eina_Bool pass);

pointer_inside (get) [Overridden from Efl.Canvas.Pointer]

Returns whether the mouse pointer is logically inside the canvas.
Eina_Bool efl_canvas_pointer_inside_get(const Eo *obj, Efl_Input_Device *seat);

pointer_mode (get, set)

Low-level pointer behaviour.
Efl_Input_Object_Pointer_Mode efl_canvas_object_pointer_mode_get(const Eo *obj);
Eina_Bool efl_canvas_object_pointer_mode_set(Eo *obj, Efl_Input_Object_Pointer_Mode pointer_mode);

pointer_mode_by_device (get, set)

Low-level pointer behaviour by device. See Efl.Canvas.Object.pointer_mode.get and Efl.Canvas.Object.pointer_mode.set for more explanation.
Efl_Input_Object_Pointer_Mode efl_canvas_object_pointer_mode_by_device_get(const Eo *obj, Efl_Input_Device *dev);
Eina_Bool efl_canvas_object_pointer_mode_by_device_set(Eo *obj, Efl_Input_Device *dev, Efl_Input_Object_Pointer_Mode pointer_mode);

position (get, set) [Overridden from Efl.Gfx]

The 2D position of a canvas object.
Eina_Position2D efl_gfx_position_get(const Eo *obj);
void efl_gfx_position_set(Eo *obj, Eina_Position2D pos);

precise_is_inside (get, set)

Eina_Bool efl_canvas_object_precise_is_inside_get(const Eo *obj);
void efl_canvas_object_precise_is_inside_set(Eo *obj, Eina_Bool precise);

propagate_events (get, set)

Eina_Bool efl_canvas_object_propagate_events_get(const Eo *obj);
void efl_canvas_object_propagate_events_set(Eo *obj, Eina_Bool propagate);

provider_find [Overridden from Efl.Object]

Searches upwards in the object tree for a provider which knows the given class/interface.
Efl_Object *efl_provider_find(const Eo *obj, const Efl_Object *klass);

raise [Overridden from Efl.Gfx.Stack]

Raise obj to the top of its layer.
void efl_gfx_stack_raise(Eo *obj);

render_op (get, set)

Render mode to be used for compositing the Evas object.
Efl_Gfx_Render_Op efl_canvas_object_render_op_get(const Eo *obj);
void efl_canvas_object_render_op_set(Eo *obj, Efl_Gfx_Render_Op render_op);

repeat_events (get, set)

Eina_Bool efl_canvas_object_repeat_events_get(const Eo *obj);
void efl_canvas_object_repeat_events_set(Eo *obj, Eina_Bool repeat);

scale (get, set) [Overridden from Efl.Gfx]

The scaling factor of an object.
double efl_gfx_scale_get(const Eo *obj);
void efl_gfx_scale_set(Eo *obj, double scale);

seat_event_filter (get, set) [Overridden from Efl.Input.Interface]

Eina_Bool efl_input_seat_event_filter_get(const Eo *obj, Efl_Input_Device *seat);
void efl_input_seat_event_filter_set(Eo *obj, Efl_Input_Device *seat, Eina_Bool enable);

seat_focus (get)

Check if this object is focused.
Eina_Bool efl_canvas_object_seat_focus_get(const Eo *obj);


Add a seat to the focus list.
Eina_Bool efl_canvas_object_seat_focus_add(Eo *obj, Efl_Input_Device *seat);


Check if this object is focused by a given seat
Eina_Bool efl_canvas_object_seat_focus_check(Eo *obj, Efl_Input_Device *seat);


Remove a seat from the focus list.
Eina_Bool efl_canvas_object_seat_focus_del(Eo *obj, Efl_Input_Device *seat);

size (get, set) [Overridden from Efl.Gfx]

The 2D size of a canvas object.
Eina_Size2D efl_gfx_size_get(const Eo *obj);
void efl_gfx_size_set(Eo *obj, Eina_Size2D size);

stack_above [Overridden from Efl.Gfx.Stack]

Stack obj immediately above
void efl_gfx_stack_above(Eo *obj, Efl_Gfx_Stack *above);

stack_below [Overridden from Efl.Gfx.Stack]

Stack obj immediately below
void efl_gfx_stack_below(Eo *obj, Efl_Gfx_Stack *below);

visible (get, set) [Overridden from Efl.Gfx]

The visibility of a canvas object.
Eina_Bool efl_gfx_visible_get(const Eo *obj);
void efl_gfx_visible_set(Eo *obj, Eina_Bool v);

render_parent (get) protected

Gets the parent smart object of a given Evas object, if it has one.
Efl_Canvas_Object *efl_canvas_object_render_parent_get(const Eo *obj);


color_class_code (get, set)
color_code (get, set)
lightning_3d Apply a lighting effect on the object.
lightning_3d_absolute Apply a lighting effect to the object.
map_alpha (get, set) Alpha flag for map rendering.
map_clockwise (get) Clockwise state of a map (read-only).
map_color (get, set) Color of a vertex in the map.
map_coord_absolute (get, set) A point's absolute coordinate on the canvas.
map_has Read-only property indicating whether an object is mapped.
map_point_count (get, set) Number of points of a map.
map_reset Resets the map transformation to its default state.
map_smooth (get, set) Smoothing state for map rendering.
map_uv (get, set) Map point's U and V texture source point.
perspective_3d Apply a perspective transform to the map
perspective_3d_absolute Apply a perspective transform to the map
rotate Apply a rotation to the object.
rotate_3d Rotate the object around 3 axes in 3D.
rotate_3d_absolute Rotate the object around 3 axes in 3D, using absolute coordinates.
rotate_absolute Apply a rotation to the object, using absolute coordinates.
rotate_quat Rotate the object in 3D using a unit quaternion.
rotate_quat_absolute Rotate the object in 3D using a unit quaternion, using absolute coordinates.
translate Apply a translation to the object using map.
zoom Apply a zoom to the object.
zoom_absolute Apply a zoom to the object, using absolute coordinates.
hint_base (get, set) Base size for objects with sizing restrictions.
hint_step (get, set) Step size for objects with sizing restrictions.
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
parent (get, set) The parent of an object.
language (get, set) The (human) language for this object.
mirrored (get, set) Whether this object should be mirrored.
mirrored_automatic (get, set) Whether the property Efl.Ui.Base.mirrored should be set automatically.



animator,tick Animator tick synchronized with screen vsync if possible.
hide Object just became invisible.
move Object was moved, its position during the event is the new one.
resize Object was resized, its size during the event is the new one.
show Object just became visible.
change,size,hints Object size hints changed.
restack Object stacking was changed.
finger,down Finger pressed (finger id is known).
finger,move Finger moved (current and previous positions are known).
finger,up Finger released (finger id is known).
focus,in A focus in event.
focus,out A focus out event.
hold All input events are on hold or resumed.
key,down Keyboard key press.
key,up Keyboard key release.
pointer,axis Pen or other axis event update.
pointer,cancel Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.
pointer,down Main pointer button pressed (button id is known).
pointer,in Pointer entered a window or a widget.
pointer,move Main pointer move (current and previous positions are known).
pointer,out Pointer left a window or a widget.
pointer,up Main pointer button released (button id is known).
pointer,wheel Mouse wheel event.
callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.