Efl.Ui.Win_Socket (class)


An off-screen window to be displayed in a remote process.

The window is rendered onto an image buffer to be displayed in another process' plug image object. No actual window is created for this type. The window contents can then be sent over a socket so that another process displays it inside a plug image.


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

Full hierarchy


finalize [Overridden from Efl.Object]

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


Create a socket to provide the service for Plug widget.
Eina_Bool efl_ui_win_socket_listen(Eo *obj, const char *svcname, int svcnum, Eina_Bool svcsys);


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 action_localized_name (get) Gets localized action name for given id
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 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.
protected action_description (get, set) Action description for given id
protected action_do Performs action on given widget.
protected action_keybinding_get Gets configured keybinding for specific action and widget.
protected action_name (get) Gets action name for given id
protected actions (get) Get list of available widget actions
seats Iterate over the input device seats.
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_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_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.
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.
pass_events (get, set)
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)
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.
config (get, set) A generic configuration value, refered to by name.
profile (get, set) The profile for the running application.
profile_dir_get Returns the directory where a profile is stored.
profile_exists Returns whether a profile exists or not.
profile_iterate Returns the list of available profiles.
protected profile_derived_add Add a new profile of the given name to be derived from the current profile.
protected profile_derived_del Deletes a profile that is derived from the current one.
protected save Saves Elementary configuration to disk.
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.
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
border_elements (get) The list of elements which are at the border of the graph.
fetch This will fetch the data from a registered node.
logical_end Return the last logical object.
manager_focus (get, set) The element which is currently focused by this manager
move Move the focus into the given direction.
pop_history_stack Removes the most upper history element, and gives the focus to the next one below
redirect (get, set) Add a another manager to serve the move requests.
request_move Returns the object which would be the next object to focus in the given direction.
request_subchild Returns a widget that can receive focus
reset_history Reset the history stack of this manager object. This means the most upper element will be unfocused, all other elements will be removed from the remembered before.
root (get, set) Root node for all logical subtrees.
setup_on_first_touch Called when this manager is set as redirect
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.
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.
disabled (get, set) Whether the widget is enabled (accepts and reacts to user inputs).
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_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_calculate Triggers an immediate recalculation of this object's geometry.
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.
no_render (get, set)
orientation_mode_disabled (get, set) Whether the widget's automatic orientation is disabled or not.
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
protected set style (get, set) The widget style to use.
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_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_disabled_update Virtual function called when the widget becomes disabled.
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 translation_update This implements the calls to gettext() and text_set().
protected widget_parent (get, set) The internal parent of this widget.
protected widget_sub_object_add Virtual function handling sub objects being added.
protected widget_sub_object_del Virtual function handling sub objects being removed.
accel_preference (get, set) The hardware acceleration preference for this window.
activate Activate a window object.
alpha (get, set)
autohide (get, set) Window's autohide state.
borderless (get, set)
center Center a window on the screen.
constructor Call the object's constructor.
content (get, set) Swallowed sub-object contained in this object.
content_unset Unswallow the object in the current container and return it.
debug_name_override Build a read-only name for this object used for debugging.
destructor Call the object's destructor.
device (get) An input device attached to this canvas, found by name.
protected set focus (get, set) This is called by the manager and should never be called by anyone else.
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.
fullscreen (get, set)
hint_aspect (get, set) Defines the aspect ratio to respect when scaling this object.
hint_base (get, set) Base size for objects with sizing restrictions.
hint_max (get, set) Hints on the object's maximum size.
hint_step (get, set) Step size for objects with sizing restrictions.
hint_weight (get, set) Hints for an object's weight.
icon_object (get, set)
iconified (get, set)
image_max_size (get) Get the maximum image size evas can possibly handle.
indicator_mode (get, set) In some environments you may have an indicator that shows battery status, reception, time etc. This is the indicator.
keyboard_mode (get, set)
keygrab_set Set keygrab value of the window
keygrab_unset Unset keygrab value of the window
lock_enabled (get) Indicates whether a key lock is on, such as NumLock, CapsLock, ...
lower This action is ignored by the Window.
maximized (get, set)
modal (get, set)
modifier_enabled (get) Indicates whether a key modifier is on, such as Ctrl, Shift, ...
move_resize_start Start moving or resizing the window.
name (get, set) Accessible name of the object.
noblank (get, set)
object_top_at_xy_get Retrieve the object stacked at the top of a given position in a canvas.
object_top_in_rectangle_get Retrieve the Evas object stacked at the top of a given rectangular region in a canvas
objects_at_xy_get Retrieve a list of objects lying over a given position in a canvas.
objects_in_rectangle_get Retrieve a list of objects lying over a given rectangular region in a canvas.
parent (get, set) Object's accessible parent.
part Returns Efl.Ui.Widget.Part.
pointer_inside (get) Returns whether the mouse pointer is logically inside the canvas.
pointer_iterate Returns an iterator over the current known pointer positions.
pointer_position (get) This function returns the current known pointer coordinates
position (get, set) The 2D position of a canvas object.
prop_focus_skip (set) Set the window to be skipped by keyboard focus.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise Places the window at the top of the stack, so that it's not covered by any other window.
screen_constrain (get, set)
screen_dpi (get) Get screen dpi for the screen that a window is on.
screen_rotation (get) Get the rotation of the screen.
screen_size (get) Get screen geometry details for the screen that a window is on.
seat (get) A seat attached to this canvas, found by id.
size (get, set) The 2D size of a canvas object.
smart_objects_calculate Call user-provided calculate smart functions and unset the flag signalling that the object needs to get recalculated to all smart objects in the canvas.
stack_base (get, set) The stack base state of this window
stack_id (get) Get the stack ID string of the window as an opaque string.
stack_master_id (get, set)
stack_pop_to Pop (delete) all windows in the stack above this window.
sticky (get, set)
text (get, set)
urgent (get, set)
visible (get, set) The visibility of a canvas object.
win_name (get, set) The window name.
win_role (get, set) The role of the window.
win_type (get, set) The type of the window.
wm_available_profiles (get, set) Available profiles on a window.
wm_available_rotations (get, set) Defines which rotations this window supports.
protected elm_actions (get) Elementary actions
protected extents (get, set) Geometry of accessible widget.
protected focus_manager_create If the widget needs a focus manager, this function will be called.
protected on_focus_update Virtual function handling focus in/out events on the widget
protected state_set (get) Gets set describing object accessible states.
protected theme_apply Virtual function called when the widget needs to re-apply its theme.
protected widget_event Virtual function handling input events on the 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
window,activated Called when window has been activated. (unfocused)
window,created Called when new window has been created.
window,deactivated Called when window has been deactivated (unfocused).
window,destroyed Called when window has been destroyed.
window,maximized Called when window has been maximmized
window,minimized Called when window has been minimized
window,restored Called when window has been restored
animator,tick Animator tick synchronized with screen vsync if possible.
device,added Called when input device was added
device,changed Called when input device changed
device,removed Called when input device was removed
object,focus,in Called when object got focus
object,focus,out Called when object lost focus
render,post Called when post render happens
render,pre Called when pre render happens
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
coords,dirty Emitted once the graph is dirty, this means there are potential changes in border_elements you want to know about
flush,pre Emitted once the graph calculationg will be performed
focused Emitted if the manager has focused an object, the passed focus object is the last focused object
redirect,changed Emitted when the redirect object has changed, the old manager is passed as event info
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.
access,changed Called when accessibility changed
language,changed Called when widget language changed
moved Called when widget moved
delete,request Called when the window receives a delete request
elm,action,block_menu Called when elementary block menu action occurs
fullscreen Called when window is set to fullscreen
iconified Called when window is iconified
indicator,prop,changed Called when indicator is property changed
ioerr Called on input output error
maximized Called when window is set to maximized
normal Called when window is set to normal state
pause Called when the window is not going be displayed for some time
profile,changed Called when profile is changed
resume Called before a window is rendered after a pause event
rotation,changed Called when window rotation is changed
stick Called when window is set as sticky
theme,changed Called when theme is changed
unfullscreen Called when window is no longer set to fullscreen
unmaximized Called when window is no longer set to maximized
unstick Called when window is no longer set as sticky
withdrawn Called when window is withdrawn
wm,rotation,changed Called when window manager rotation is changed