Efl.Ui.Win_Socket (class)

Description

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.

Inheritance

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

Full hierarchy

Members

finalize [Overridden from Efl.Object]

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


socket_listen

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


Inherited

Efl.Access.Action
protected action_localized_name (get)
Efl.Access.Component
protected accessible_at_point_get Gets top component object occupying space at given coordinates.
protected contains Contains accessible widget
protected screen_position (get, set) Position of accessible widget.
protected z_order (get)
Efl.Access.Object
static access_root (get)
access_type (get, set) Type of accessibility object
attribute_append Add key-value pair identifying object extra attributes
attribute_del delete key-value pair identifying object extra attributes when key is given
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.
translation_domain (get, set) The translation domain of "name" and "description" properties.
static protected event_emit Emit event
static protected event_handler_add Register accessibility event listener
static protected event_handler_del Deregister accessibility event listener
protected index_in_parent (get)
protected localized_role_name (get)
protected reading_info_type (get, set) Reading information of an accessible object.
protected relations_get Gets an all relations between accessible object and other accessible objects.
protected role_name (get)
Efl.Access.Widget.Action
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)
protected actions (get)
Efl.Canvas.Group
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)
Efl.Canvas.Object
above (get)
anti_alias (get, set) Whether or not the given Evas object is to be drawn anti-aliased.
below (get)
clipped_objects (get)
clipped_objects_count Returns the number of objects clipped by obj
coords_inside (get)
event_freeze Freeze events of this object.
event_thaw Thaw events of object.
geometry (get, set) Rectangular geometry that combines both position and size.
gesture_manager_get 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_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_combined_max (get)
hint_size_combined_min (get)
hint_size_min (get, set) Hints on the object's minimum size.
protected set hint_size_restricted_max (get, set) Internal hints for an object's maximum size.
protected set hint_size_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) The layer of its canvas that the given object will be part of.
loop (get)
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.
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.
seat_focus (get)
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)
Efl.Canvas.Scene
seats Iterate over the available input device seats for the canvas.
Efl.Config
config (get, set) A generic configuration value, referred to by name.
Efl.Gfx.Color
color_code (get, set) Hexadecimal color code of given Evas object (#RRGGBBAA).
Efl.Gfx.Mapping
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_clockwise (get)
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.
Efl.Loop_Consumer
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.
Efl.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 (source) emits it. The event is said to be forwarded from source to this object.
event_callback_stop Stop the current callback call.
event_freeze_count (get)
static event_global_freeze Globally freeze events for ALL EFL OBJECTS.
static event_global_freeze_count (get)
static event_global_thaw Globally thaw events for ALL EFL OBJECTS.
finalized (get)
invalidated (get)
invalidating (get)
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.
Efl.Ui.Dnd
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 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.
drop_target_del Delete the dropable status from object
Efl.Ui.Focus.Manager
border_elements (get)
dirty_logic_freeze Disables the cache invalidation when an object is moved.
dirty_logic_unfreeze Enables the cache invalidation when an object is moved.
fetch Fetches the data from a registered node.
logical_end Returns the last logical object.
manager_focus (get, set) The element which is currently focused by this manager.
move Moves the focus in the given direction to the next regular widget.
pop_history_stack Removes the uppermost history element, and focuses the previous one.
redirect (get, set) Add another manager to serve the move requests.
request_move Returns the object in the direction from child.
request_subchild Returns the widget in the direction next.
reset_history Resets the history stack of this manager object. This means the uppermost element will be unfocused, and all other elements will be removed from the remembered list.
root (get, set) Root node for all logical sub-trees.
setup_on_first_touch Called when this manager is set as redirect.
viewport_elements (get)
Efl.Ui.Focus.Object
setup_order 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.
protected child_focus (get, set) Indicates if a child of this object has focus set to true.
protected setup_order_non_recursive 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.
Efl.Ui.Selection
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
Efl.Ui.Widget
access_info (get, set) Accessibility information.
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.
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)
focus_manager (get)
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)
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_remove Removes a member object from a given smart object.
invalidate Implement this method to perform special actions when your object loses its parent, if you need to.
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.
property_bind 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.
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
style (get, set) The widget style to use.
protected access_children (get)
protected attributes (get)
protected focus_grab Focuses accessible widget.
protected focus_highlight_geometry (get)
protected focus_state_apply Apply a new focus state on the widget.
protected interest_region (get)
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 resize_object (set)
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 customizing sub objects being added.
protected widget_sub_object_del Virtual function customizing sub objects being removed.
Efl.Ui.Win
accel_preference (get, set) The hardware acceleration preference for this window.
activate Activate a window object.
alpha (get, set) The alpha channel state of a window.
autohide (get, set) Window's autohide state.
borderless (get, set) The borderless state of a window.
center Center a window on the screen.
constructor Implement this method to provide optional initialization code for your object.
content (get, set) Sub-object currently set as this object's single content.
content_unset Remove the sub-object currently set as content of this object and return it. This object becomes empty.
debug_name_override Build a read-only name for this object used for debugging.
destructor Implement this method to provide deinitialization code for your object if you need it.
device (get) Get a device by name.
static exit_on_all_windows_closed (get, set) Enable quitting the main loop when all windows are closed.
exit_on_close (get, set) Enable quitting the main loop when this window is closed.
protected set focus (get, set) Whether the widget is currently focused or not.
focus_highlight_animate (get, set) Whether focus highlight should animate or not.
focus_highlight_enabled (get, set) Whether focus highlight is enabled or not on this window, regardless of the global setting.
focus_highlight_style (get, set) Control the widget focus highlight style.
fullscreen (get, set) The fullscreen state of a window.
group_objects_calculate Call user-provided calculate group functions and unset the flag signalling that the object needs to get recalculated to all group objects in the canvas.
group_objects_calculating (get)
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_size_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.
i18n_name (get, set) Accessible name of the object.
icon_object (get, set) A window object's icon.
image_max_size (get)
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) The keyboard mode of the window.
l10n_text (get, set) A unique string to be translated.
language (get, set) The (human) language for this object.
lock_enabled (get)
lower_to_bottom This action is ignored by the Window.
maximized (get, set) The maximized state of a window.
minimized (get, set) The minimized state of a window.
modal (get, set) The modal state of a window.
modifier_enabled (get)
move_resize_start Start moving or resizing the window.
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 canvas object stacked at the top of a given rectangular region in a canvas
objects_at_xy_get Retrieve a list of objects at a given position in a canvas.
objects_in_rectangle_get Retrieve a list of objects overlapping a given rectangular region in a canvas.
pointer_inside (get)
pointer_iterate Returns an iterator over the current known pointer positions.
pointer_position (get)
position (get, set) The 2D position of a canvas object.
prop_focus_skip (set)
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise_to_top Places the window at the top of the stack, so that it's not covered by any other window.
screen_constrain (get, set) Constrain the maximum width and height of a window to the width and height of the screen.
screen_dpi (get)
screen_rotation (get)
screen_scale_factor (get)
screen_size_in_pixels (get)
seat (get) Get a seat by id.
seat_default (get) Get the default seat.
size (get, set) The 2D size of a canvas object.
stack_base (get, set) The stack base state of this window
stack_id (get)
stack_master_id (get, set) The window stack ID to use as the master top-level.
stack_pop_to Pop (delete) all windows in the stack above this window.
sticky (get, set) The sticky state of the window.
text (get, set) The text string to be displayed by the given text object.
urgent (get, set) The urgent state of a window.
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_rotation (get, set) The rotation of this 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)
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 part_get Returns Efl.Ui.Widget_Part.
protected state_set (get)
protected theme_apply Virtual function called when the widget needs to re-apply its theme.
protected widget_input_event_handler Virtual function handling input events on the widget.

Events

Inherited

Efl.Access.Object
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
Efl.Access.Window
window,activated Called when window has been activated. (focused)
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 maximized
window,minimized Called when window has been minimized
window,restored Called when window has been restored
Efl.Canvas.Group
member,added Called when a member is added to the group.
member,removed Called when a member is removed from the group.
Efl.Canvas.Object
animator,tick Animator tick synchronized with screen vsync if possible.
Efl.Canvas.Scene
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
scene,focus,in Called when scene got focus
scene,focus,out Called when scene lost focus
Efl.Content
content,changed Sent after the content is set or unset using the current content object.
Efl.Gesture.Events
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.
Efl.Gfx.Entity
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.
Efl.Gfx.Hint
hints,changed Object hints changed.
Efl.Gfx.Stack
stacking,changed Object stacking was changed.
Efl.Input.Interface
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.
Efl.Object
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.
Efl.Ui.Dnd
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
Efl.Ui.Focus.Manager
coords,dirty Cached relationship calculation results have been invalidated.
dirty_logic_freeze,changed Called when this focus manager is frozen or thawed, even_info being true indicates that it is now frozen, false indicates that it is thawed.
flush,pre After this event, the manager object will calculate relations in the graph. Can be used to add / remove children in a lazy fashion.
manager_focus,changed The manager_focus property has changed. The previously focused object is passed as an event argument.
redirect,changed Redirect object has changed, the old manager is passed as an event argument.
Efl.Ui.Focus.Object
child_focus,changed Emitted if child_focus has changed.
focus,changed Emitted if the focus state has changed.
focus_geometry,changed Emitted if focus geometry of this object has changed.
focus_manager,changed Emitted when a new manager is the parent for this object.
focus_parent,changed Emitted when a new logical parent should be used.
Efl.Ui.Property_Bind
properties,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.
property,bound Event dispatched when a property on the object is bound to a model. This is useful to avoid generating too many events.
Efl.Ui.Selection
wm_selection,changed Called when display server's selection has changed
Efl.Ui.View
model,changed Event dispatched when a new model is set.
Efl.Ui.Widget
access,changed Called when accessibility changed
language,changed Called when widget language changed
Efl.Ui.Win
delete,request Called when the window receives a delete request
elm,action,block_menu Called when elementary block menu action occurs
fullscreen,changed Called when window is set to or from fullscreen
indicator,prop,changed Called when indicator is property changed
maximized,changed Called when window is set to or from maximized
minimized Called when window is minimized
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
stick Called when window is set as sticky
theme,changed Called when theme is changed
unstick Called when window is no longer set as sticky
win_rotation,changed Called when window rotation is changed, sends current rotation in degrees
withdrawn Called when window is withdrawn
wm,rotation,changed Called when window manager rotation is changed