Efl.Ui.Widget (class)


Efl UI widget abstract class


Efl.Canvas.Group (class)Efl.Canvas.Object (class)Efl.Object (class)

Full hierarchy


access_info (get, set)

Accessibility information.
const char *efl_ui_widget_access_info_get(const Eo *obj);
void efl_ui_widget_access_info_set(Eo *obj, const char *txt);

clip (get, set) [Overridden from Efl.Canvas.Object]

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

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);

cursor (get, set) [Overridden from Efl.Ui.Cursor]

The cursor to be shown when mouse is over the object
const char *efl_ui_cursor_get(const Eo *obj);
Eina_Bool efl_ui_cursor_set(Eo *obj, const char *cursor);

cursor_style (get, set) [Overridden from Efl.Ui.Cursor]

A different style for the cursor.
const char *efl_ui_cursor_style_get(const Eo *obj);
Eina_Bool efl_ui_cursor_style_set(Eo *obj, const char *style);

cursor_theme_search_enabled (get, set) [Overridden from Efl.Ui.Cursor]

Whether the cursor may be looked in the theme or not.
Eina_Bool efl_ui_cursor_theme_search_enabled_get(const Eo *obj);
Eina_Bool efl_ui_cursor_theme_search_enabled_set(Eo *obj, Eina_Bool allow);

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);

destructor [Overridden from Efl.Object]

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

disabled (get, set)

Whether the widget is enabled (accepts and reacts to user inputs).
Eina_Bool efl_ui_widget_disabled_get(const Eo *obj);
void efl_ui_widget_disabled_set(Eo *obj, Eina_Bool disabled);

finalize [Overridden from Efl.Object]

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

focus (get, set) protected set [Overridden from Efl.Ui.Focus.Object]

This is called by the manager and should never be called by anyone else.
Eina_Bool efl_ui_focus_object_focus_get(const Eo *obj);
void efl_ui_focus_object_focus_set(Eo *obj, Eina_Bool focus);

focus_allow (get, set)

The ability for a widget to be focused.
Eina_Bool efl_ui_widget_focus_allow_get(const Eo *obj);
void efl_ui_widget_focus_allow_set(Eo *obj, Eina_Bool can_focus);

focus_geometry (get) [Overridden from Efl.Ui.Focus.Object]

The geometry used to calculate relationships between other objects.
Eina_Rect efl_ui_focus_object_focus_geometry_get(const Eo *obj);

focus_highlight_animate (get, set)

Whether focus highlight should animate or not.
Eina_Bool efl_ui_widget_focus_highlight_animate_get(const Eo *obj);
void efl_ui_widget_focus_highlight_animate_set(Eo *obj, Eina_Bool animate);

focus_highlight_enabled (get, set)

Whether focus highlight is enabled or not.
Eina_Bool efl_ui_widget_focus_highlight_enabled_get(const Eo *obj);
void efl_ui_widget_focus_highlight_enabled_set(Eo *obj, Eina_Bool enabled);

focus_highlight_style (get, set)

Control the widget focus highlight style.
const char *efl_ui_widget_focus_highlight_style_get(const Eo *obj);
Eina_Bool efl_ui_widget_focus_highlight_style_set(Eo *obj, const char *style);

focus_manager (get) [Overridden from Efl.Ui.Focus.User]

Describes which manager is used to register.
Efl_Ui_Focus_Manager *efl_ui_focus_user_focus_manager_get(const Eo *obj);

focus_move_policy (get, set)

The widget's focus move policy.
Efl_Ui_Focus_Move_Policy efl_ui_widget_focus_move_policy_get(const Eo *obj);
void efl_ui_widget_focus_move_policy_set(Eo *obj, Efl_Ui_Focus_Move_Policy policy);

focus_move_policy_automatic (get, set)

Control the widget's focus_move_policy mode setting.
Eina_Bool efl_ui_widget_focus_move_policy_automatic_get(const Eo *obj);
void efl_ui_widget_focus_move_policy_automatic_set(Eo *obj, Eina_Bool automatic);

focus_parent (get) [Overridden from Efl.Ui.Focus.User]

Describes which logical parent is used by this object.
Efl_Ui_Focus_Object *efl_ui_focus_user_focus_parent_get(const Eo *obj);

focused_item (get)

Get the focused widget item.
Elm_Widget_Item *efl_ui_widget_focused_item_get(const Eo *obj);

group_calculate [Overridden from Efl.Canvas.Group]

Triggers an immediate recalculation of this object's geometry.
void efl_canvas_group_calculate(Eo *obj);

group_member_add [Overridden from Efl.Canvas.Group]

Set a canvas object as a member of a given group (or smart object).
void efl_canvas_group_member_add(Eo *obj, Efl_Canvas_Object *sub_obj);

group_member_del [Overridden from Efl.Canvas.Group]

Removes a member object from a given smart object.
void efl_canvas_group_member_del(Eo *obj, Efl_Canvas_Object *sub_obj);

interest_region_mode (get, set)

Defines how Efl.Ui.Widget.show_region should be calculated.
Efl_Ui_Interest_Region_Mode efl_ui_widget_interest_region_mode_get(const Eo *obj);
void efl_ui_widget_interest_region_mode_set(Eo *obj, Efl_Ui_Interest_Region_Mode mode);

is_frame_object (get, set) [Overridden from Efl.Canvas.Object]

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);

mirrored (get, set) [Overridden from Efl.Ui.Base]

Whether this object should be mirrored.
Eina_Bool efl_ui_mirrored_get(const Eo *obj);
void efl_ui_mirrored_set(Eo *obj, Eina_Bool rtl);

mirrored_automatic (get, set) [Overridden from Efl.Ui.Base]

Whether the property Efl.Ui.Base.mirrored should be set automatically.
Eina_Bool efl_ui_mirrored_automatic_get(const Eo *obj);
void efl_ui_mirrored_automatic_set(Eo *obj, Eina_Bool automatic);

name (get, set) [Overridden from Efl.Access]

Accessible name of the object.
const char *efl_access_name_get(const Eo *obj);
void efl_access_name_set(Eo *obj, const char *name);

no_render (get, set) [Overridden from Efl.Canvas.Object]

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

orientation_mode_disabled (get, set)

Whether the widget's automatic orientation is disabled or not.
Eina_Bool efl_ui_widget_orientation_mode_disabled_get(const Eo *obj);
void efl_ui_widget_orientation_mode_disabled_set(Eo *obj, Eina_Bool disabled);

parent (get, set) [Overridden from Efl.Access]

Object's accessible parent.
Efl_Access *efl_access_parent_get(const Eo *obj);
void efl_access_parent_set(Eo *obj, Efl_Access *parent);

part [Overridden from Efl.Part]

Efl_Object *efl_part(const Eo *obj, const char *name);

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);

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);

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);


Pop scroller freeze
void efl_ui_widget_scroll_freeze_pop(Eo *obj);


Push scroller freeze
void efl_ui_widget_scroll_freeze_push(Eo *obj);


Pop scroller hold
void efl_ui_widget_scroll_hold_pop(Eo *obj);


Push scroll hold
void efl_ui_widget_scroll_hold_push(Eo *obj);

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);

style (get, set) protected set

The widget style to use.
const char *efl_ui_widget_style_get(const Eo *obj);
Efl_Ui_Theme_Apply efl_ui_widget_style_set(Eo *obj, const char *style);

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);

widget_top (get)

Root widget in the widget hierarchy.
Efl_Ui_Widget *efl_ui_widget_top_get(const Eo *obj);

attributes (get) protected [Overridden from Efl.Access]

Gets key-value pairs indentifying object extra attributes. Must be free by a user.
Eina_List *efl_access_attributes_get(const Eo *obj);

children (get) protected [Overridden from Efl.Access]

Gets object's accessible children.
Eina_List *efl_access_children_get(const Eo *obj);

focus_grab protected [Overridden from Efl.Access.Component]

Focuses accessible widget.
Eina_Bool efl_access_component_focus_grab(Eo *obj);

focus_highlight_geometry (get) protected

The rectangle region to be highlighted on focus.
Eina_Rect efl_ui_widget_focus_highlight_geometry_get(const Eo *obj);

focus_manager_create protected

If the widget needs a focus manager, this function will be called.
Efl_Ui_Focus_Manager *efl_ui_widget_focus_manager_create(Eo *obj, Efl_Ui_Focus_Object *root);

focus_state_apply protected

Register focus with the given configuration.
Eina_Bool efl_ui_widget_focus_state_apply(Eo *obj, Efl_Ui_Widget_Focus_State current_state, Efl_Ui_Widget_Focus_State configured_state, Efl_Ui_Widget *redirect);

interest_region (get) protected

Region of interest inside this widget, that should be given priority to be visible inside a scroller.
Eina_Rect efl_ui_widget_interest_region_get(const Eo *obj);

on_access_activate protected

Hook function called when widget is activated through accessibility.
Eina_Bool efl_ui_widget_on_access_activate(Eo *obj, Efl_Ui_Activate act);

on_access_update protected

Hook function called when accessibility is changed on the widget.
void efl_ui_widget_on_access_update(Eo *obj, Eina_Bool enable);

on_disabled_update protected

Virtual function called when the widget becomes disabled.
Eina_Bool efl_ui_widget_on_disabled_update(Eo *obj, Eina_Bool disabled);

on_focus_update protected

Virtual function handling focus in/out events on the widget
Eina_Bool efl_ui_widget_on_focus_update(Eo *obj, Elm_Widget_Item *item);

on_orientation_update protected

Virtual function handling canvas orientation changes.
void efl_ui_widget_on_orientation_update(Eo *obj, int rotation);

on_show_region_hook (set) protected

Hook function called when the Efl.Ui.Widget.show_region is changed.
void efl_ui_widget_on_show_region_hook_set(Eo *obj, Efl_Ui_Scrollable_On_Show_Region func);

resize_object (set) protected

This is the internal canvas object managed by a widget.
void efl_ui_widget_resize_object_set(Eo *obj, Efl_Canvas_Object *sobj);

show_region (get, set) protected

Region inside the widget to show.
Eina_Rect efl_ui_widget_show_region_get(const Eo *obj);
void efl_ui_widget_show_region_set(Eo *obj, Eina_Rect region, Eina_Bool force);

state_set (get) protected [Overridden from Efl.Access]

Gets set describing object accessible states.
Efl_Access_State_Set efl_access_state_set_get(const Eo *obj);

theme_apply protected

Virtual function called when the widget needs to re-apply its theme.
Efl_Ui_Theme_Apply efl_ui_widget_theme_apply(Eo *obj);

translation_update protected [Overridden from Efl.Ui.Translatable]

This implements the calls to gettext() and text_set().
void efl_ui_translatable_translation_update(Eo *obj);

widget_event protected

Virtual function handling input events on the widget.
Eina_Bool efl_ui_widget_event(Eo *obj, const Efl_Event *eo_event, Efl_Canvas_Object *source);

widget_parent (get, set) protected

The internal parent of this widget.
Efl_Ui_Widget *efl_ui_widget_parent_get(const Eo *obj);
void efl_ui_widget_parent_set(Eo *obj, Efl_Ui_Widget *parent);

widget_sub_object_add protected

Virtual function handling sub objects being added.
Eina_Bool efl_ui_widget_sub_object_add(Eo *obj, Efl_Canvas_Object *sub_obj);

widget_sub_object_del protected

Virtual function handling sub objects being removed.
Eina_Bool efl_ui_widget_sub_object_del(Eo *obj, Efl_Canvas_Object *sub_obj);


attribute_append Add key-value pair identifying object extra attributes
attributes_clear Removes all attributes in accessible object.
description (get, set) Contextual information about object.
relationship_append Defines the relationship between two accessible objects.
relationship_remove Removes the relationship between two accessible objects.
relationships_clear Removes all relationships in accessible object.
role (get, set) The role of the object in accessibility domain.
class root (get) Get root object of accessible object hierarchy
translation_domain (get, set) The translation domain of "name" and "description" properties.
type (get, set) Type of accessibility object
class protected event_emit Emit event
class protected event_handler_add Register accessibility event listener
class protected event_handler_del Deregister accessibility event listener
protected index_in_parent (get) Gets index of the child in parent's children list.
protected localized_role_name (get) Gets an localized string describing accessible object role name.
protected reading_info_type (get, set)
protected relation_set (get) Gets an all relations between accessible object and other accessible objects.
protected role_name (get) Gets human-readable string indentifying object accessibility role.
protected accessible_at_point_get Gets top component object occupying space at given coordinates.
protected alpha (get) Gets alpha of accessible widget.
protected contains Contains accessible widget
protected extents (get, set) Geometry of accessible widget.
protected layer (get) Evas layer of accessible widget.
protected position (get, set) Position of accessible widget.
protected size (get, set) Size of accessible widget.
protected z_order (get) Gets the depth at which the component is shown in relation to other components in the same container.
group_change Marks the object as dirty.
group_member_is Finds out if a given object is a member of this group.
group_members_iterate Returns an iterator over the children of this object, which are canvas objects.
group_need_recalculate (get, set) Indicates that the group's layout needs to be recalculated.
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.
protected group_clipper (get) The internal clipper object used by this group.
above (get) Get the Evas object stacked right above obj
anti_alias (get, set)
below (get) Get the Evas object stacked right below obj
clipees (get) Return a list of objects currently clipped by obj.
clipees_has Test if any object is clipped by obj.
coords_inside (get) Returns whether the coords are logically inside the object.
del Unrefs the object and reparents it to NULL.
event_animation (get, set) Set the animation which starts when the given event_name happens to the object.
freeze_events (get, set)
geometry (get, set) Rectangular geometry that combines both position and size.
hint_align (get, set) Hints for an object's alignment.
hint_aspect (get, set) Defines the aspect ratio to respect when scaling this object.
hint_combined_min (get) Read-only minimum size combining both Efl.Gfx.Size.Hint.hint_restricted_min and Efl.Gfx.Size.Hint.hint_min size hints.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_max (get, set) Hints on the object's maximum size.
hint_min (get, set) Hints on the object's minimum size.
protected set hint_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
key_focus (get, set) Indicates that this object is the keyboard event receiver on its canvas.
key_grab Requests keyname key events be directed to obj.
key_ungrab Removes the grab on keyname key events by obj.
layer (get, set)
loop (get) The loop to which this object belongs to.
lower Lower obj to the bottom of its layer.
pass_events (get, set)
pointer_inside (get) Returns whether the mouse pointer is logically inside the canvas.
pointer_mode (get, set) Low-level pointer behaviour.
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.
precise_is_inside (get, set)
propagate_events (get, set)
raise Raise obj to the top of its layer.
render_op (get, set) Render mode to be used for compositing the Evas object.
repeat_events (get, set)
seat_event_filter (get, set)
seat_focus (get) Check if this object is focused.
seat_focus_add Add a seat to the focus list.
seat_focus_check Check if this object is focused by a given seat
seat_focus_del Remove a seat from the focus list.
stack_above Stack obj immediately above
stack_below Stack obj immediately below
protected render_parent (get) Gets the parent smart object of a given Evas object, if it has one.
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.
has_owner Determine whether the selection data has owner
selection_clear Clear the selection data from the object
selection_get Get the data from the object that has selection
selection_set Set the selection data to the object
language (get, set) The (human) language for this object.
drag_action_set Set the action for the drag
drag_cancel Cancel the on-going drag
drag_start Start a drag and drop process at the drag side. During dragging, there are three events emitted as belows: - EFL_UI_DND_EVENT_DRAG_POS - EFL_UI_DND_EVENT_DRAG_ACCEPT - EFL_UI_DND_EVENT_DRAG_DONE
drop_target_add Make the current object as drop targert. There are four events emitted: - EFL_UI_DND_EVENT_DRAG_ENTER - EFL_UI_DND_EVENT_DRAG_LEAVE - EFL_UI_DND_EVENT_DRAG_POS - EFL_UI_DND_EVENT_DRAG_DROP.
drop_target_del Delete the dropable status from object
prepare_logical Tells the object that its children will be queried soon by the given manager.
translatable_text (get, set) A unique string to be translated.



Called when accessibility changed


Called when widget language changed


Called when widget moved


active,descendant,changed Called when active state of descendant has changed
added Called when item is added
bounds,changed Called when boundaries have changed
children,changed Called when children have changed
property,changed Called when property has changed
removed Called when item is removed
state,changed Called when state has changed
visible,data,changed Called when visibility has changed
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.
selection,changed Called when display server's selection has changed
drag,accept accept drag data
drag,done drag is done (mouse up)
drag,drop called when the drag object dropped on this object
drag,enter called when the drag object enters this object
drag,leave called when the drag object leaves this object
drag,pos called when the drag object changes drag position
focus,changed Emitted if the focus state has changed
logical,changed Emitted when a new logical parent should be used.
manager,changed Emitted when a new manager is the parent for this object.