Efl canvas object abstract class
Efl_Gfx_Stack *efl_gfx_stack_above_get(const Eo *obj);
anti_alias (get, set)
Whether or not the given Evas object is to be drawn anti-aliased.
Eina_Bool efl_canvas_object_anti_alias_get(const Eo *obj); void efl_canvas_object_anti_alias_set(Eo *obj, Eina_Bool anti_alias);
Efl_Gfx_Stack *efl_gfx_stack_below_get(const Eo *obj);
Eina_Iterator *efl_canvas_object_clipped_objects_get(const Eo *obj);
Returns the number of objects clipped by
unsigned int efl_canvas_object_clipped_objects_count(const Eo *obj);
clipper (get, set)
Clip one object to another.
Efl_Canvas_Object *efl_canvas_object_clipper_get(const Eo *obj); void efl_canvas_object_clipper_set(Eo *obj, Efl_Canvas_Object *clipper);
The general/main color of the given Evas object.
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);
Implement this method to provide optional initialization code for your object.
Efl_Object *efl_constructor(Eo *obj);
Eina_Bool efl_canvas_object_coords_inside_get(const Eo *obj, Eina_Position2D pos);
Build a read-only name for this object used for debugging.
void efl_debug_name_override(Eo *obj, Eina_Strbuf *sb);
Implement this method to provide deinitialization code for your object if you need it.
void efl_destructor(Eo *obj);
Freeze events of this object.
void efl_event_freeze(Eo *obj);
Thaw events of object.
void efl_event_thaw(Eo *obj);
Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.
Efl_Object *efl_finalize(Eo *obj);
Rectangular geometry that combines both position and size.
Eina_Rect efl_gfx_entity_geometry_get(const Eo *obj); void efl_gfx_entity_geometry_set(Eo *obj, Eina_Rect rect);
Returns current canvas's gesture manager
const Efl_Canvas_Gesture_Manager *efl_canvas_object_gesture_manager_get(Eo *obj);
has_fixed_size (get, set)
A hint for an object that its size will not change.
Eina_Bool efl_canvas_object_has_fixed_size_get(const Eo *obj); void efl_canvas_object_has_fixed_size_set(Eo *obj, Eina_Bool enable);
Hints for an object's alignment.
void efl_gfx_hint_align_get(const Eo *obj, double *x, double *y); void efl_gfx_hint_align_set(Eo *obj, double x, double y);
Defines the aspect ratio to respect when scaling this object.
void efl_gfx_hint_aspect_get(const Eo *obj, Efl_Gfx_Hint_Aspect *mode, Eina_Size2D *sz); void efl_gfx_hint_aspect_set(Eo *obj, Efl_Gfx_Hint_Aspect mode, Eina_Size2D sz);
Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.Hint.hint_fill specify whether to fill the space inside the boundaries of a container/manager.
void efl_gfx_hint_fill_get(const Eo *obj, Eina_Bool *x, Eina_Bool *y); void efl_gfx_hint_fill_set(Eo *obj, Eina_Bool x, Eina_Bool y);
Hints for an object's margin or padding space.
void efl_gfx_hint_margin_get(const Eo *obj, int *l, int *r, int *t, int *b); void efl_gfx_hint_margin_set(Eo *obj, int l, int r, int t, int b);
Eina_Size2D efl_gfx_hint_size_combined_max_get(const Eo *obj);
Eina_Size2D efl_gfx_hint_size_combined_min_get(const Eo *obj);
Hints on the object's maximum size.
Eina_Size2D efl_gfx_hint_size_max_get(const Eo *obj); void efl_gfx_hint_size_max_set(Eo *obj, Eina_Size2D sz);
Hints on the object's minimum size.
Eina_Size2D efl_gfx_hint_size_min_get(const Eo *obj); void efl_gfx_hint_size_min_set(Eo *obj, Eina_Size2D sz);
Internal hints for an object's maximum size.
Eina_Size2D efl_gfx_hint_size_restricted_max_get(const Eo *obj); void efl_gfx_hint_size_restricted_max_set(Eo *obj, Eina_Size2D sz);
Internal hints for an object's minimum size.
Eina_Size2D efl_gfx_hint_size_restricted_min_get(const Eo *obj); void efl_gfx_hint_size_restricted_min_set(Eo *obj, Eina_Size2D sz);
Hints for an object's weight.
void efl_gfx_hint_weight_get(const Eo *obj, double *x, double *y); void efl_gfx_hint_weight_set(Eo *obj, double x, double y);
Implement this method to perform special actions when your object loses its parent, if you need to.
void efl_invalidate(Eo *obj);
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);
keynamekey events be directed to
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
keynamekey events by
void efl_canvas_object_key_ungrab(Eo *obj, const char *keyname, Efl_Input_Modifier modifiers, Efl_Input_Modifier not_modifiers);
The layer of its canvas that the given object will be part of.
short efl_gfx_stack_layer_get(const Eo *obj); void efl_gfx_stack_layer_set(Eo *obj, short l);
Efl_Loop *efl_loop_get(const Eo *obj);
objto the bottom of its layer.
void efl_gfx_stack_lower_to_bottom(Eo *obj);
no_render (get, set)
Disables all rendering on the canvas.
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
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)
Whether an Evas object is to pass (ignore) events.
Eina_Bool efl_canvas_object_pass_events_get(const Eo *obj); void efl_canvas_object_pass_events_set(Eo *obj, Eina_Bool pass);
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)
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);
The 2D position of a canvas object.
Eina_Position2D efl_gfx_entity_position_get(const Eo *obj); void efl_gfx_entity_position_set(Eo *obj, Eina_Position2D pos);
precise_is_inside (get, set)
Whether to use precise (usually expensive) point collision detection for a given Evas object.
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)
Whether events on a smart object's member should be propagated up to its parent.
Eina_Bool efl_canvas_object_propagate_events_get(const Eo *obj); void efl_canvas_object_propagate_events_set(Eo *obj, Eina_Bool propagate);
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_Class *klass);
objto the top of its layer.
void efl_gfx_stack_raise_to_top(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)
Whether an Evas object is to repeat events to objects below it.
Eina_Bool efl_canvas_object_repeat_events_get(const Eo *obj); void efl_canvas_object_repeat_events_set(Eo *obj, Eina_Bool repeat);
The scaling factor of an object.
double efl_gfx_entity_scale_get(const Eo *obj); void efl_gfx_entity_scale_set(Eo *obj, double scale);
Whether input events from a given seat are enabled. If the filter list is empty (no seat is disabled) this object will report mouse, keyboard and focus events from any seat, otherwise those events will only be reported if the event comes from a seat that is not in the list.
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);
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);
The 2D size of a canvas object.
Eina_Size2D efl_gfx_entity_size_get(const Eo *obj); void efl_gfx_entity_size_set(Eo *obj, Eina_Size2D size);
void efl_gfx_stack_above(Eo *obj, Efl_Gfx_Stack *above);
void efl_gfx_stack_below(Eo *obj, Efl_Gfx_Stack *below);
The visibility of a canvas object.
Eina_Bool efl_gfx_entity_visible_get(const Eo *obj); void efl_gfx_entity_visible_set(Eo *obj, Eina_Bool v);
Efl_Canvas_Object *efl_canvas_object_render_parent_get(const Eo *obj);
|color_code (get, set)||Hexadecimal color code of given Evas object (#RRGGBBAA).|
|lighting_3d||Apply a lighting effect on the object.|
|lighting_3d_absolute||Apply a lighting effect to the object.|
|mapping_alpha (get, set)||Alpha flag for map rendering.|
|mapping_color (get, set)||Color of a vertex in the map.|
|mapping_coord_absolute (get, set)||A point's absolute coordinate on the canvas.|
|mapping_has||Read-only property indicating whether an object is mapped.|
|mapping_point_count (get, set)||Number of points of a map.|
|mapping_reset||Resets the map transformation to its default state.|
|mapping_smooth (get, set)||Smoothing state for map rendering.|
|mapping_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.|
|future_rejected||Creates a new future that is already rejected to a specified error using the Efl.Loop_Consumer.loop.get.|
|future_resolved||Creates a new future that is already resolved to a value.|
|parent (get, set)||The parent of an object.|
|promise_new||Create a new promise with the scheduler coming from the loop provided by this object.|
|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 children.|
|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_del||Remove an event callback forwarder for a specified event and object.|
|event_callback_forwarder_priority_add|| Add an event callback forwarder that will make this object emit an event whenever another object (
|event_callback_stop||Stop the current callback call.|
| ||event_global_freeze||Globally freeze events for ALL EFL OBJECTS.|
| ||event_global_freeze_count (get)|
| ||event_global_thaw||Globally thaw events for ALL EFL OBJECTS.|
|name (get, set)||The name of the object.|
|name_find||Find a child object with the given name and return it.|
|provider_register||Will register a manager of a specific class to be answered by Efl.Object.provider_find.|
|provider_unregister||Will unregister a manager of a specific class that was previously registered and answered by Efl.Object.provider_find.|
Animator tick synchronized with screen vsync if possible.
|gesture,double_tap||Emitted when a Double-tap gesture has been detected. A Double-tap gesture consists of two taps on the screen (or clicks of the mouse) in quick succession. If the second one is delayed for too long they will be detected as two independent Efl.Gesture.Events.gesture,tap events.|
|gesture,flick||Emitted when a Flick gesture has been detected.|
|gesture,long_tap||Emitted when a Long-tap gesture has been detected. A Long-tap gesture consists of a touch of the screen (or click of the mouse) followed by a release after some time. If the release happens too quickly a Efl.Gesture.Events.gesture,tap event will be emitted instead.|
|gesture,momentum||Emitted when a Momentum gesture has been detected. A Momentum gesture consists of a quick displacement of the finger while touching the screen (or while holding down a mouse button).|
|gesture,tap||Emitted when a Tap gesture has been detected. A Tap gesture consists of a touch of the screen (or click of the mouse) quickly followed by a release. If the release happens too late a Efl.Gesture.Events.gesture,long_tap event will be emitted instead.|
|gesture,triple_tap||Emitted when a Triple-tap gesture has been detected. A Triple-tap gesture consists of three taps on the screen (or clicks of the mouse) in quick succession. If any of them is delayed for too long they will be detected as independent Efl.Gesture.Events.gesture,tap or Efl.Gesture.Events.gesture,double_tap events.|
|gesture,zoom||Emitted when a Zoom gesture has been detected. A Zoom gesture consists of two fingers touching the screen and separating ("zoom in") or getting closer ("zoom out" or "pinch"). This gesture cannot be performed with a mouse as it requires more than one pointer.|
|position,changed||Object was moved, its position during the event is the new one.|
|size,changed||Object was resized, its size during the event is the new one.|
|visibility,changed||Object's visibility state changed, the event value is the new state.|
|hints,changed||Object hints changed.|
|stacking,changed||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.|
|del||Object is being deleted. See Efl.Object.destructor.|
|destruct||Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any reference you keep to the object.|
|invalidate||Object is being invalidated and losing its parent. See Efl.Object.invalidate.|
|noref||Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.|
|ownership,shared||Object has acquired a second reference. It has multiple owners now. Triggered whenever increasing the refcount from one to two, it will not trigger by further increasing the refcount beyond two.|
|ownership,unique||Object has lost a reference and only one is left. It has just one owner now. Triggered whenever the refcount goes from two to one.|