EFL layout widget class.
When loading layouts from a file, use the Efl.File.key property to specify the group that the data belongs to, in case it's an EET file (including Edje files).
By default, layouts do not apply the finger_size global configuration value when calculating their geometries.
Implement this method to provide optional initialization code for your object.
Efl_Object *efl_constructor(Eo *obj);
The file path from where an object will fetch the data.
const char *efl_file_get(const Eo *obj); Eina_Error efl_file_set(Eo *obj, const char *file);
Triggers an immediate recalculation of this object's geometry.
void efl_canvas_group_calculate(Eo *obj);
The key which corresponds to the target data within a file.
const char *efl_file_key_get(const Eo *obj); void efl_file_key_set(Eo *obj, const char *key);
Eina_Error efl_file_load(Eo *obj);
The mmaped file from where an object will fetch the real data (it must be an Eina.File).
const Eina_File efl_file_mmap_get(const Eo *obj); Eina_Error efl_file_mmap_set(Eo *obj, const Eina_File f);
Perform all necessary operations to unload file data from the object.
void efl_file_unload(Eo *obj);
|Gets top component object occupying space at given coordinates.
|Contains accessible widget
|extents (get, set)
|Geometry of accessible widget.
|screen_position (get, set)
|Position of accessible widget.
|access_type (get, set)
|Type of accessibility object
|Add key-value pair identifying object extra attributes
|delete key-value pair identifying object extra attributes when key is given
|Removes all attributes in accessible object.
|description (get, set)
|Contextual information about object.
|Defines the relationship between two accessible objects.
|Removes the relationship between two accessible objects.
|Removes all relationships in accessible object.
|role (get, set)
|The role of the object in accessibility domain.
|translation_domain (get, set)
|The translation domain of "name" and "description" properties.
|Register accessibility event listener
|Deregister accessibility event listener
|reading_info_type (get, set)
|Reading information of an accessible object.
|Gets an all relations between accessible object and other accessible objects.
|Marks the object as dirty.
|Finds out if a given object is a member of this group.
|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
|anti_alias (get, set)
|Whether or not the given Evas object is to be drawn anti-aliased.
| Returns the number of objects clipped by
|Freeze events of this object.
|Thaw events of object.
|geometry (get, set)
|Rectangular geometry that combines both position and size.
|Returns current canvas's gesture manager
|has_fixed_size (get, set)
|A hint for an object that its size will not change.
|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_fill (get, set)
|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.
|hint_margin (get, set)
|Hints for an object's margin or padding space.
|hint_size_max (get, set)
|Hints on the object's maximum size.
|hint_size_min (get, set)
|Hints on the object's minimum size.
|hint_size_restricted_max (get, set)
|Internal hints for an object's maximum size.
|hint_size_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.
keyname key events be directed to
| Removes the grab on
keyname key events by
|layer (get, set)
|The layer of its canvas that the given object will be part of.
obj to the bottom of its layer.
|pass_events (get, set)
|Whether an Evas object is to pass (ignore) events.
|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)
|Whether to use precise (usually expensive) point collision detection for a given Evas object.
|propagate_events (get, set)
|Whether events on a smart object's member should be propagated up to its parent.
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)
|Whether an Evas object is to repeat events to objects below it.
|seat_event_filter (get, set)
|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.
|Add a seat to the focus list.
|Check if this object is focused by a given seat
|Remove a seat from the focus list.
|color_code (get, set)
|Hexadecimal color code of given Evas object (#RRGGBBAA).
|Apply a lighting effect on the object.
|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.
|Read-only property indicating whether an object is mapped.
|mapping_point_count (get, set)
|Number of points of a map.
|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.
|Apply a perspective transform to the map
|Apply a perspective transform to the map
|Apply a rotation to the object.
|Rotate the object around 3 axes in 3D.
|Rotate the object around 3 axes in 3D, using absolute coordinates.
|Apply a rotation to the object, using absolute coordinates.
|Rotate the object in 3D using a unit quaternion.
|Rotate the object in 3D using a unit quaternion, using absolute coordinates.
|Apply a translation to the object using map.
|Apply a zoom to the object.
|Apply a zoom to the object, using absolute coordinates.
|Creates a new future that is already rejected to a specified error using the Efl.Loop_Consumer.loop.get.
|Creates a new future that is already resolved to a value.
|parent (get, set)
|The parent of an object.
|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.
|Get an iterator on all children.
|comment (get, set)
|A human readable comment for the object.
|Make an object a composite object of another.
|Detach a composite object from another object.
|Check if an object is part of a composite object.
|Remove an event callback forwarder for a specified event and object.
| Add an event callback forwarder that will make this object emit an event whenever another object (
source) emits it. The event is said to be forwarded from
source to this object.
|Stop the current callback call.
|Globally freeze events for ALL EFL OBJECTS.
|Globally thaw events for ALL EFL OBJECTS.
|name (get, set)
|The name of the object.
|Find a child object with the given name and return it.
|Will register a manager of a specific class to be answered by Efl.Object.provider_find.
|Will unregister a manager of a specific class that was previously registered and answered by Efl.Object.provider_find.
|Set the action for the drag
|Cancel the on-going drag
|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
|Make the current object as drop target. 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.
|Delete the dropable status from object
|Tells the object that its children will be queried soon by the focus manager. Overwrite this to have a chance to update the order of the children. Deleting items in this call will result in undefined behaviour and may cause your system to crash.
|child_focus (get, set)
|Indicates if a child of this object has focus set to true.
|This is called when Efl.Ui.Focus.Object.setup_order is called, but only on the first call, additional recursive calls to Efl.Ui.Focus.Object.setup_order will not call this function again.
|automatic_theme_rotation (get, set)
|This flag tells if this object will automatically mirror the rotation changes of the window to this object.
|calc_auto_update_hints (get, set)
|Whether this object updates its size hints automatically.
|Freezes the layout object.
|Calculates the geometry of the region, relative to a given layout object's area, occupied by all parts in the object.
|Calculates the minimum required size for a given layout object.
|Thaws the layout object.
|Returns the number of contained sub-objects.
|Begin iterating over this object's contents.
|disabled (get, set)
|Whether the widget is enabled (accepts and reacts to user inputs).
|bind the factory with the given key string. when the data is ready or changed, factory create the object and bind the data to the key action and process promised work. Note: the input Efl.Ui.Factory need to be Efl.Ui.Property_Bind.property_bind at least once.
|Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.
|finger_size_multiplier (get, set)
|Set a multiplier for applying finger size to the layout.
|Implement this method to perform special actions when your object loses its parent, if you need to.
|l10n_text (get, set)
|A unique string to be translated.
|language (get, set)
|The (human) language for this object.
|Sends an (Edje) message to a given Edje object
|bind property data with the given key string. when the data is ready or changed, bind the data to the key action and process promised work.
|Adds a callback for an arriving Edje signal, emitted by a given Edje object.
|Removes a signal-triggered callback from an object.
|Sends/emits an Edje signal to this layout.
|Processes an object's messages and signals queue.
|theme (get, set)
|The theme of this widget, defines which edje group will be used.
|Apply a new rotation value to this object.
|Forces a Size/Geometry calculation.
|Virtual function handling focus in/out events on the widget.
|Virtual function called when the widget needs to re-apply its theme.
|Virtual function customizing sub objects being added.
|Virtual function customizing sub objects being removed.
|Determine whether the selection data has owner
|Clear the selection data from the object
|Get the data from the object that has selection
|Set the selection data to the object
|access_info (get, set)
|clipper (get, set)
|Clip one object to another.
|color (get, set)
|This will set the color on every object in the sub-tree including those that are not Efl.Ui.Widget (like simple Efl.Canvas.Object objects that are added via Efl.Canvas.Group.group_member_add).
|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.
|Build a read-only name for this object used for debugging.
|Implement this method to provide deinitialization code for your object if you need it.
|focus (get, set)
|Whether the widget is currently focused or not.
|focus_allow (get, set)
|The ability for a widget to be focused.
|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.
|Set a canvas object as a member of a given group (or smart object).
|Removes a member object from a given smart object.
|i18n_name (get, set)
|Accessible name of the object.
|mirrored (get, set)
|Whether this object should be mirrored.
|mirrored_automatic (get, set)
|Whether the property Efl.Ui.I18n.mirrored should be set automatically.
|model (get, set)
|Model that is/will be
|no_render (get, set)
|Disables all rendering on the canvas.
|position (get, set)
|The 2D position of a canvas object.
|Searches upwards in the object tree for a provider which knows the given class/interface.
|scale (get, set)
|The scaling factor of an object.
|Pop scroller freeze
|Push scroller freeze
|Pop scroller hold
|Push scroll hold
|size (get, set)
|The 2D size of a canvas object.
|style (get, set)
|The widget style to use.
|visible (get, set)
|The visibility of a canvas object.
|Focuses accessible widget.
|Apply a new focus state on the widget.
|Hook function called when widget is activated through accessibility.
|Hook function called when accessibility is changed on the widget.
| This implements the calls to
|Virtual function handling input events on the widget.
|widget_parent (get, set)
|The internal parent of this widget.
|Called when active state of descendant has changed
|Called when item is added
|Called when boundaries have changed
|Called when children have changed
|Called when property has changed
|Called when item is removed
|Called when state has changed
|Called when visibility has changed
|Called when a member is added to the group.
|Called when a member is removed from the group.
|Animator tick synchronized with screen vsync if possible.
|Sent after a new sub-object was added.
|Sent after a sub-object was removed, before unref.
|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.
|Emitted when a Flick gesture has been detected.
|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.
|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).
|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.
|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.
|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.
|Object was moved, its position during the event is the new one.
|Object was resized, its size during the event is the new one.
|Object's visibility state changed, the event value is the new state.
|Object hints changed.
|Object stacking was changed.
|Finger pressed (finger id is known).
|Finger moved (current and previous positions are known).
|Finger released (finger id is known).
|A focus in event.
|A focus out event.
|All input events are on hold or resumed.
|Keyboard key press.
|Keyboard key release.
|Pen or other axis event update.
|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.
|Main pointer button pressed (button id is known).
|Pointer entered a window or a widget.
|Main pointer move (current and previous positions are known).
|Pointer left a window or a widget.
|Main pointer button released (button id is known).
|Mouse wheel event.
|A circular dependency between parts of the object was found.
|The layout was recalculated.
|Object is being deleted. See Efl.Object.destructor.
|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.
|Object is being invalidated and losing its parent. See Efl.Object.invalidate.
|Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.
|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.
|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.
|accept drag data
|drag is done (mouse up)
|called when the drag object dropped on this object
|called when the drag object enters this object
|called when the drag object leaves this object
|called when the drag object changes drag position
|Emitted if child_focus has changed.
|Emitted if the focus state has changed.
|Emitted if focus geometry of this object has changed.
|Emitted when a new manager is the parent for this object.
|Emitted when a new logical parent should be used.
|Called when theme changed
|Event dispatched when a property on the object has changed due to a user interaction on the object that a model could be interested in.
|Event dispatched when a property on the object is bound to a model. This is useful to avoid generating too many events.
|Called when display server's selection has changed
|Event dispatched when a new model is set.
|Called when accessibility changed
|Called when widget language changed