Efl.Ui.Frame (class)


Frame widget

The Frame widget allows for collapsing and expanding the content widget by clicking on the frame label. the label and content can be set using text_set and content_set api.


Efl.Ui.Layout (class)Efl.Ui.Widget (class)Efl.Canvas.Group (class)Efl.Canvas.Object (class)Efl.Object (class)

Full hierarchy


autocollapse (get, set)

Eina_Bool efl_ui_frame_autocollapse_get(const Eo *obj);
void efl_ui_frame_autocollapse_set(Eo *obj, Eina_Bool autocollapse);

collapse (get, set)

Eina_Bool efl_ui_frame_collapse_get(const Eo *obj);
void efl_ui_frame_collapse_set(Eo *obj, Eina_Bool collapse);


Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations.
void efl_ui_frame_collapse_go(Eo *obj, Eina_Bool collapse);

constructor [Overridden from Efl.Object]

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

content (get, set) [Overridden from Efl.Content]

Swallowed sub-object contained in this object.
Efl_Gfx *efl_content_get(const Eo *obj);
Eina_Bool efl_content_set(Eo *obj, Efl_Gfx *content);

content_unset [Overridden from Efl.Content]

Unswallow the object in the current container and return it.
Efl_Gfx *efl_content_unset(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);

markup (get, set) [Overridden from Efl.Text.Markup]

Markup property
const char *efl_text_markup_get(const Eo *obj);
void efl_text_markup_set(Eo *obj, const char *markup);

text (get, set) [Overridden from Efl.Text]

const char *efl_text_get(const Eo *obj);
void efl_text_set(Eo *obj, const char *text);

translatable_text (get, set) [Overridden from Efl.Ui.Translatable]

A unique string to be translated.
const char *efl_ui_translatable_text_get(const Eo *obj, const char **domain);
void efl_ui_translatable_text_set(Eo *obj, const char *label, const char *domain);


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.
load_error (get) Gets the (last) file loading error for a given object.
save Save the given image object's contents to an (image) file.
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.
calc_auto_update_hints (get, set) Whether this object updates its size hints automatically.
calc_parts_extends Calculates the geometry of the region, relative to a given layout object's area, occupied by all parts in the object.
calc_size_min Calculates the minimum required size for a given layout object.
protected calc_force Forces a Size/Geometry calculation.
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
cursor (get) The object's main cursor.
cursor_char_delete Deletes a single character from position pointed by given cursor.
cursor_char_next Advances to the next character
cursor_char_prev Advances to the previous character
cursor_compare Compare two cursors
cursor_content (get) The content of the cursor (the character under the cursor)
cursor_coord_set Set cursor coordinates
cursor_copy Copy existing cursor
cursor_equal Check if two cursors are equal
cursor_free Free existing cursor
cursor_geometry (get) Returns the geometry of two cursors ("split cursor"), if logical cursor is between LTR/RTL text, also considering paragraph direction. Upper cursor is shown for the text of the same direction as paragraph, lower cursor - for opposite.
cursor_line_char_first Advance to current line first character
cursor_line_char_last Advance to current line last character
cursor_line_jump_by Jump the cursor by the given number of lines
cursor_new Create new cursor
cursor_paragraph_char_first Advances to the first character in this paragraph
cursor_paragraph_char_last Advances to the last character in this paragraph
cursor_paragraph_first Advance to current paragraph first character
cursor_paragraph_last Advance to current paragraph last character
cursor_paragraph_next Advances to the start of the next text node
cursor_paragraph_prev Advances to the end of the previous text node
cursor_position (get, set) Cursor position
cursor_text_insert Adds text to the current cursor position and set the cursor to *after* the start of the text just added.
cursor_word_end Advance to current word end
cursor_word_start Advance to current word start
cursor_markup_insert Inserts a markup text to the text object in a given cursor position
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.
calc_freeze Freezes the layout object.
calc_thaw Thaws the layout object.
connect Connect factory
connect Connect property
content_count Returns the number of UI elements packed in this container.
content_iterate Begin iterating over this object's contents.
content_remove Unswallow an object from this container.
file (get, set)
finalize Called at the end of efl_add. Should not be called, just overridden.
group_data (get) Retrives an EDC data field's value from a given Edje object's group.
group_size_max (get) Gets the maximum size specified -- as an EDC property -- for a given Edje object
group_size_min (get) Gets the minimum size specified -- as an EDC property -- for a given Edje object
message_send Sends an (Edje) message to a given Edje object
mmap (get, set)
model (get, set) Model that is/will be
part Returns Efl.Ui.Widget.Part.
signal_callback_add Adds a callback for an arriving Edje signal, emitted by a given Edje object.
signal_callback_del Removes a signal-triggered callback from an object.
signal_emit Sends/emits an Edje signal to this layout.
signal_process Processes an object's messages and signals queue.
theme (set) The theme of this widget, defines which edje group will be used.
protected on_disabled_update Virtual function called when the widget becomes disabled.
protected on_focus_update Virtual function handling focus in/out events on the widget
protected theme_apply Virtual function called when the widget needs to re-apply its theme.
protected widget_sub_object_add Virtual function handling sub objects being added.
protected widget_sub_object_del Virtual function handling sub objects being removed.
access_info (get, set) Accessibility information.
clip (get, set)
color (get, set)
cursor (get, set) The cursor to be shown when mouse is over the object
cursor_style (get, set) A different style for the cursor.
cursor_theme_search_enabled (get, set) Whether the cursor may be looked in the theme or not.
debug_name_override Build a read-only name for this object used for debugging.
destructor Call the object's destructor.
disabled (get, set) Whether the widget is enabled (accepts and reacts to user inputs).
protected set focus (get, set) This is called by the manager and should never be called by anyone else.
focus_allow (get, set) The ability for a widget to be focused.
focus_geometry (get) The geometry used to calculate relationships between other objects.
focus_highlight_animate (get, set) Whether focus highlight should animate or not.
focus_highlight_enabled (get, set) Whether focus highlight is enabled or not.
focus_highlight_style (get, set) Control the widget focus highlight style.
focus_manager (get) Describes which manager is used to register.
focus_move_policy (get, set) The widget's focus move policy.
focus_move_policy_automatic (get, set) Control the widget's focus_move_policy mode setting.
focus_parent (get) Describes which logical parent is used by this object.
focused_item (get) Get the focused widget item.
group_member_add Set a canvas object as a member of a given group (or smart object).
group_member_del Removes a member object from a given smart object.
interest_region_mode (get, set) Defines how Efl.Ui.Widget.show_region should be calculated.
is_frame_object (get, set) If true the object belongs to the window border decorations.
mirrored (get, set) Whether this object should be mirrored.
mirrored_automatic (get, set) Whether the property Efl.Ui.Base.mirrored should be set automatically.
name (get, set) Accessible name of the object.
no_render (get, set)
orientation_mode_disabled (get, set) Whether the widget's automatic orientation is disabled or not.
parent (get, set) Object's accessible parent.
position (get, set) The 2D position of a canvas object.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
scale (get, set) The scaling factor of an object.
scroll_freeze_pop Pop scroller freeze
scroll_freeze_push Push scroller freeze
scroll_hold_pop Pop scroller hold
scroll_hold_push Push scroll hold
size (get, set) The 2D size of a canvas object.
protected set style (get, set) The widget style to use.
visible (get, set) The visibility of a canvas object.
widget_top (get) Root widget in the widget hierarchy.
protected attributes (get) Gets key-value pairs indentifying object extra attributes. Must be free by a user.
protected children (get) Gets object's accessible children.
protected focus_grab Focuses accessible widget.
protected focus_highlight_geometry (get) The rectangle region to be highlighted on focus.
protected focus_manager_create If the widget needs a focus manager, this function will be called.
protected focus_state_apply Register focus with the given configuration.
protected interest_region (get) Region of interest inside this widget, that should be given priority to be visible inside a scroller.
protected on_access_activate Hook function called when widget is activated through accessibility.
protected on_access_update Hook function called when accessibility is changed on the widget.
protected on_orientation_update Virtual function handling canvas orientation changes.
protected on_show_region_hook (set) Hook function called when the Efl.Ui.Widget.show_region is changed.
protected resize_object (set) This is the internal canvas object managed by a widget.
protected show_region (get, set) Region inside the widget to show.
protected state_set (get) Gets set describing object accessible states.
protected translation_update This implements the calls to gettext() and text_set().
protected widget_event Virtual function handling input events on the widget.
protected widget_parent (get, set) The internal parent of this widget.



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.
content,added Sent after a new item was added.
content,removed Sent after an item was removed, before unref.
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.
circular,dependency A circular dependency between parts of the object was found.
recalc The layout was recalculated.
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
clicked Called when object iss clicked
clicked,double Called when object receives a double click
clicked,right Called when object receives a right click
clicked,triple Called when object receives a triple click
longpressed Called when the object receives a long press
pressed Called when the object is pressed
repeated Called when the object receives repeated presses/clicks
unpressed Called when the object is no longer pressed
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.
theme,changed Called when theme changed
access,changed Called when accessibility changed
language,changed Called when widget language changed
moved Called when widget moved