Ecore_X.h File Reference

Ecore functions for dealing with the X Windows System. More...

Enumerations

enum  _Ecore_X_Window_State { ,
  ECORE_X_WINDOW_STATE_ICONIFIED,
  ECORE_X_WINDOW_STATE_MODAL,
  ECORE_X_WINDOW_STATE_STICKY,
  ECORE_X_WINDOW_STATE_MAXIMIZED_VERT,
  ECORE_X_WINDOW_STATE_MAXIMIZED_HORZ,
  ECORE_X_WINDOW_STATE_SHADED,
  ECORE_X_WINDOW_STATE_SKIP_TASKBAR,
  ECORE_X_WINDOW_STATE_SKIP_PAGER,
  ECORE_X_WINDOW_STATE_HIDDEN,
  ECORE_X_WINDOW_STATE_FULLSCREEN
}
enum  _Ecore_X_Window_State_Hint {
  ECORE_X_WINDOW_STATE_HINT_NONE = -1,
  ECORE_X_WINDOW_STATE_HINT_WITHDRAWN,
  ECORE_X_WINDOW_STATE_HINT_NORMAL,
  ECORE_X_WINDOW_STATE_HINT_ICONIC
}

Functions

EAPI int ecore_x_init (const char *name)
 Initialize the X display connection to the given display.
EAPI int ecore_x_shutdown (void)
 Shuts down the Ecore X library.
EAPI int ecore_x_disconnect (void)
 Shuts down the Ecore X library.
EAPI Ecore_X_Display * ecore_x_display_get (void)
 Retrieves the Ecore_X_Display handle used for the current X connection.
EAPI int ecore_x_fd_get (void)
 Retrieves the X display file descriptor.
EAPI Ecore_X_Screen * ecore_x_default_screen_get (void)
 Retrieves the Ecore_X_Screen handle used for the current X connection.
EAPI void ecore_x_screen_size_get (const Ecore_X_Screen *screen, int *w, int *h)
 Retrieves the size of an Ecore_X_Screen.
EAPI int ecore_x_screen_count_get (void)
 Retrieves the number of screens.
EAPI int ecore_x_screen_index_get (const Ecore_X_Screen *screen)
 Retrieves the index number of the given screen.
EAPI Ecore_X_Screen * ecore_x_screen_get (int index)
 Retrieves the screen based on index number.
EAPI void ecore_x_double_click_time_set (double t)
 Sets the timeout for a double and triple clicks to be flagged.
EAPI double ecore_x_double_click_time_get (void)
 Retrieves the double and triple click flag timeout.
EAPI void ecore_x_flush (void)
 Sends all X commands in the X Display buffer.
EAPI void ecore_x_sync (void)
 Flushes the command buffer and waits until all requests have been processed by the server.
EAPI void ecore_x_killall (Ecore_X_Window root)
 Kill all clients with subwindows under a given window.
EAPI void ecore_x_kill (Ecore_X_Window win)
 Kill a specific client.
EAPI int ecore_x_dpi_get (void)
 Return the screen DPI.
EAPI Eina_Bool ecore_x_bell (int percent)
 Invoke the standard system beep to alert users.
EAPI unsigned int ecore_x_visual_id_get (Ecore_X_Visual visual)
 Retrieve the Visual ID from a given Visual.
EAPI Ecore_X_Visual ecore_x_default_visual_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default Visual.
EAPI Ecore_X_Colormap ecore_x_default_colormap_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default Colormap.
EAPI int ecore_x_default_depth_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default depth.
EAPI Ecore_X_Time ecore_x_current_time_get (void)
 Return the last event time.
EAPI void ecore_x_error_handler_set (void(*func)(void *data), const void *data)
 Set the error handler.
EAPI void ecore_x_io_error_handler_set (void(*func)(void *data), const void *data)
 Set the I/O error handler.
EAPI int ecore_x_error_request_get (void)
 Get the request code that caused the error.
EAPI int ecore_x_error_code_get (void)
 Get the error code from the error.
EAPI Ecore_X_ID ecore_x_error_resource_id_get (void)
 Get the resource id that caused the error.
EAPI Eina_Bool ecore_x_selection_primary_set (Ecore_X_Window w, const void *data, int size)
 Claim ownership of the PRIMARY selection and set its data.
EAPI Eina_Bool ecore_x_selection_primary_clear (void)
 Release ownership of the primary selection.
EAPI Eina_Bool ecore_x_selection_secondary_set (Ecore_X_Window w, const void *data, int size)
 Claim ownership of the SECONDARY selection and set its data.
EAPI Eina_Bool ecore_x_selection_secondary_clear (void)
 Release ownership of the secondary selection.
EAPI Eina_Bool ecore_x_selection_xdnd_set (Ecore_X_Window w, const void *data, int size)
 Claim ownership of the XDND selection and set its data.
EAPI Eina_Bool ecore_x_selection_xdnd_clear (void)
 Release ownership of the XDND selection.
EAPI Eina_Bool ecore_x_selection_clipboard_set (Ecore_X_Window w, const void *data, int size)
 Claim ownership of the CLIPBOARD selection and set its data.
EAPI Eina_Bool ecore_x_selection_clipboard_clear (void)
 Release ownership of the clipboard selection.
EAPI void ecore_x_selection_owner_set (Ecore_X_Window win, Ecore_X_Atom atom, Ecore_X_Time tm)
 Change the owner and last-change time for the specified selection.
EAPI Ecore_X_Window ecore_x_selection_owner_get (Ecore_X_Atom atom)
 Return the window that currently owns the specified selection.
EAPI void ecore_x_dnd_callback_pos_update_set (void(*cb)(void *, Ecore_X_Xdnd_Position *data), const void *data)
 The DND position update cb is called Ecore_X sends a DND position to a client.
EAPI Ecore_X_Window ecore_x_window_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a new window.
EAPI Ecore_X_Window ecore_x_window_override_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a window with the override redirect attribute set to True.
EAPI Ecore_X_Window ecore_x_window_manager_argb_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a new window.
EAPI Ecore_X_Window ecore_x_window_argb_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a new window.
EAPI Ecore_X_Window ecore_x_window_override_argb_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a window with the override redirect attribute set to True.
EAPI Ecore_X_Window ecore_x_window_input_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a new input window.
EAPI void ecore_x_window_free (Ecore_X_Window win)
 Deletes the given window.
EAPI void ecore_x_window_ignore_set (Ecore_X_Window win, int ignore)
 Set if a window should be ignored.
EAPI Ecore_X_Window * ecore_x_window_ignore_list (int *num)
 Get the ignore list.
EAPI void ecore_x_window_delete_request_send (Ecore_X_Window win)
 Sends a delete request to the given window.
EAPI void ecore_x_window_show (Ecore_X_Window win)
 Shows a window.
EAPI void ecore_x_window_hide (Ecore_X_Window win)
 Hides a window.
EAPI void ecore_x_window_move (Ecore_X_Window win, int x, int y)
 Moves a window to the position x, y.
EAPI void ecore_x_window_resize (Ecore_X_Window win, int w, int h)
 Resizes a window.
EAPI void ecore_x_window_move_resize (Ecore_X_Window win, int x, int y, int w, int h)
 Moves and resizes a window.
EAPI void ecore_x_window_focus (Ecore_X_Window win)
 Sets the focus to the window win.
EAPI void ecore_x_window_focus_at_time (Ecore_X_Window win, Ecore_X_Time t)
 Sets the focus to the given window at a specific time.
EAPI Ecore_X_Window ecore_x_window_focus_get (void)
 gets the window that has focus.
EAPI void ecore_x_window_raise (Ecore_X_Window win)
 Raises the given window.
EAPI void ecore_x_window_lower (Ecore_X_Window win)
 Lowers the given window.
EAPI void ecore_x_window_reparent (Ecore_X_Window win, Ecore_X_Window new_parent, int x, int y)
 Moves a window to within another window at a given position.
EAPI void ecore_x_window_size_get (Ecore_X_Window win, int *w, int *h)
 Retrieves the size of the given window.
EAPI void ecore_x_window_geometry_get (Ecore_X_Window win, int *x, int *y, int *w, int *h)
 Retrieves the geometry of the given window.
EAPI int ecore_x_window_border_width_get (Ecore_X_Window win)
 Retrieves the width of the border of the given window.
EAPI void ecore_x_window_border_width_set (Ecore_X_Window win, int width)
 Sets the width of the border of the given window.
EAPI int ecore_x_window_depth_get (Ecore_X_Window win)
 Retrieves the depth of the given window.
EAPI void ecore_x_window_cursor_show (Ecore_X_Window win, Eina_Bool show)
 To be documented.
EAPI void ecore_x_window_defaults_set (Ecore_X_Window win)
 Sets the default properties for the given window.
EAPI int ecore_x_window_visible_get (Ecore_X_Window win)
 Finds out whether the given window is currently visible.
EAPI Ecore_X_Window ecore_x_window_shadow_tree_at_xy_with_skip_get (Ecore_X_Window base, int x, int y, Ecore_X_Window *skip, int skip_num)
 Retrieves the top, visible window at the given location, but skips the windows in the list.
EAPI Ecore_X_Window ecore_x_window_shadow_parent_get (Ecore_X_Window root, Ecore_X_Window win)
 Retrieves the parent window a given window has.
EAPI void ecore_x_window_shadow_tree_flush (void)
 Flushes the window shadow tree so nothing is stored.
EAPI Ecore_X_Window ecore_x_window_root_get (Ecore_X_Window win)
 Retrieves the root window a given window is on.
EAPI Ecore_X_Window ecore_x_window_at_xy_get (int x, int y)
 Retrieves the top, visible window at the given location.
EAPI Ecore_X_Window ecore_x_window_at_xy_with_skip_get (int x, int y, Ecore_X_Window *skip, int skip_num)
 Retrieves the top, visible window at the given location, but skips the windows in the list.
EAPI Ecore_X_Window ecore_x_window_parent_get (Ecore_X_Window win)
 Retrieves the parent window of the given window.
EAPI void ecore_x_window_background_color_set (Ecore_X_Window win, unsigned short r, unsigned short g, unsigned short b)
 Sets the background color of the given window.
EAPI Ecore_X_Atom ecore_x_window_prop_any_type (void)
 To be documented.
EAPI void ecore_x_window_prop_property_set (Ecore_X_Window win, Ecore_X_Atom type, Ecore_X_Atom format, int size, void *data, int number)
 To be documented.
EAPI int ecore_x_window_prop_property_get (Ecore_X_Window win, Ecore_X_Atom property, Ecore_X_Atom type, int size, unsigned char **data, int *num)
 To be documented.
EAPI void ecore_x_window_prop_string_set (Ecore_X_Window win, Ecore_X_Atom type, const char *str)
 Set a window string property.
EAPI char * ecore_x_window_prop_string_get (Ecore_X_Window win, Ecore_X_Atom type)
 Get a window string property.
EAPI Ecore_X_WM_Protocol * ecore_x_window_prop_protocol_list_get (Ecore_X_Window win, int *num_ret)
 To be documented.
EAPI void ecore_x_window_shape_mask_set (Ecore_X_Window win, Ecore_X_Pixmap mask)
 Sets the shape of the given window to that given by the pixmap mask.
EAPI void ecore_x_window_shape_input_mask_set (Ecore_X_Window win, Ecore_X_Pixmap mask)
 Sets the input shape of the given window to that given by the pixmap mask.
EAPI Ecore_X_Pixmap ecore_x_pixmap_new (Ecore_X_Window win, int w, int h, int dep)
 Creates a new pixmap.
EAPI void ecore_x_pixmap_free (Ecore_X_Pixmap pmap)
 Deletes the reference to the given pixmap.
EAPI void ecore_x_pixmap_paste (Ecore_X_Pixmap pmap, Ecore_X_Drawable dest, Ecore_X_GC gc, int sx, int sy, int w, int h, int dx, int dy)
 Pastes a rectangular area of the given pixmap onto the given drawable.
EAPI void ecore_x_pixmap_geometry_get (Ecore_X_Pixmap pmap, int *x, int *y, int *w, int *h)
 Retrieves the size of the given pixmap.
EAPI int ecore_x_pixmap_depth_get (Ecore_X_Pixmap pmap)
 Retrieves the depth of the given pixmap.
EAPI Ecore_X_GC ecore_x_gc_new (Ecore_X_Drawable draw, Ecore_X_GC_Value_Mask value_mask, const unsigned int *value_list)
 Creates a new default graphics context associated with the given drawable.
EAPI void ecore_x_gc_free (Ecore_X_GC gc)
 Deletes and frees the given graphics context.
EAPI Eina_Bool ecore_x_client_message32_send (Ecore_X_Window win, Ecore_X_Atom type, Ecore_X_Event_Mask mask, long d0, long d1, long d2, long d3, long d4)
 Send client message with given type and format 32.
EAPI Eina_Bool ecore_x_client_message8_send (Ecore_X_Window win, Ecore_X_Atom type, const void *data, int len)
 Send client message with given type and format 8.
EAPI void ecore_x_drawable_geometry_get (Ecore_X_Drawable d, int *x, int *y, int *w, int *h)
 Retrieves the geometry of the given drawable.
EAPI int ecore_x_drawable_border_width_get (Ecore_X_Drawable d)
 Retrieves the width of the border of the given drawable.
EAPI int ecore_x_drawable_depth_get (Ecore_X_Drawable d)
 Retrieves the depth of the given drawable.
EAPI void ecore_x_drawable_rectangle_fill (Ecore_X_Drawable d, Ecore_X_GC gc, int x, int y, int width, int height)
 Fill the specified rectangle on a drawable.
EAPI Ecore_X_Window * ecore_x_window_root_list (int *num_ret)
 Get a list of all the root windows on the server.
EAPI Ecore_X_Atom ecore_x_atom_get (const char *name)
 Retrieves the atom value associated to a name.
EAPI char * ecore_x_atom_name_get (Ecore_X_Atom atom)
 Retrieves the name of the given atom.
EAPI void ecore_x_icccm_protocol_atoms_set (Ecore_X_Window win, Ecore_X_Atom *protos, int num)
 Set protocol atoms explicitly.
EAPI void ecore_x_icccm_protocol_set (Ecore_X_Window win, Ecore_X_WM_Protocol protocol, Eina_Bool on)
 Set or unset a wm protocol property.
EAPI Eina_Bool ecore_x_icccm_protocol_isset (Ecore_X_Window win, Ecore_X_WM_Protocol protocol)
 Determines whether a protocol is set for a window.
EAPI void ecore_x_icccm_name_class_set (Ecore_X_Window win, const char *n, const char *c)
 Set a window name & class.
EAPI void ecore_x_icccm_name_class_get (Ecore_X_Window win, char **n, char **c)
 Get a window name & class.
EAPI char * ecore_x_icccm_client_machine_get (Ecore_X_Window win)
 Get a window client machine string.
EAPI void ecore_x_icccm_command_set (Ecore_X_Window win, int argc, char **argv)
 Sets the WM_COMMAND property for win.
EAPI void ecore_x_icccm_command_get (Ecore_X_Window win, int *argc, char ***argv)
 Get the WM_COMMAND property for win.
EAPI char * ecore_x_icccm_icon_name_get (Ecore_X_Window win)
 Get a window icon name.
EAPI void ecore_x_icccm_icon_name_set (Ecore_X_Window win, const char *t)
 Set a window icon name.
EAPI void ecore_x_icccm_colormap_window_set (Ecore_X_Window win, Ecore_X_Window subwin)
 Add a subwindow to the list of windows that need a different colormap installed.
EAPI void ecore_x_icccm_colormap_window_unset (Ecore_X_Window win, Ecore_X_Window subwin)
 Remove a window from the list of colormap windows.
EAPI void ecore_x_icccm_transient_for_set (Ecore_X_Window win, Ecore_X_Window forwin)
 Specify that a window is transient for another top-level window and should be handled accordingly.
EAPI void ecore_x_icccm_transient_for_unset (Ecore_X_Window win)
 Remove the transient_for setting from a window.
EAPI Ecore_X_Window ecore_x_icccm_transient_for_get (Ecore_X_Window win)
 Get the window this window is transient for, if any.
EAPI void ecore_x_icccm_window_role_set (Ecore_X_Window win, const char *role)
 Set the window role hint.
EAPI char * ecore_x_icccm_window_role_get (Ecore_X_Window win)
 Get the window role.
EAPI void ecore_x_icccm_client_leader_set (Ecore_X_Window win, Ecore_X_Window l)
 Set the window's client leader.
EAPI Ecore_X_Window ecore_x_icccm_client_leader_get (Ecore_X_Window win)
 Get the window's client leader.
EAPI void ecore_x_mwm_borderless_set (Ecore_X_Window win, Eina_Bool borderless)
 Sets the borderless flag of a window using MWM.
EAPI void ecore_x_randr_events_select (Ecore_X_Window win, Eina_Bool on)
 enable event selection.
EAPI void ecore_x_randr_screen_reset (Ecore_X_Window root)
 removes unused screen space.
EAPI Ecore_X_Randr_Mode ecore_x_randr_crtc_mode_get (Ecore_X_Window root, Ecore_X_Randr_Crtc crtc)
 Get the current set mode of a given CRTC.
EAPI Eina_Bool ecore_x_randr_crtc_mode_set (Ecore_X_Window root, Ecore_X_Randr_Crtc crtc, Ecore_X_Randr_Output *outputs, int noutputs, Ecore_X_Randr_Mode mode)
 sets a mode for a CRTC and the outputs attached to it
EAPI Eina_Bool ecore_x_randr_crtc_settings_set (Ecore_X_Window root, Ecore_X_Randr_Crtc crtc, Ecore_X_Randr_Output *outputs, int noutputs, int x, int y, Ecore_X_Randr_Mode mode, Ecore_X_Randr_Orientation orientation)
 sets the demanded parameters for a given CRTC.
EAPI Eina_Bool ecore_x_randr_crtc_pos_relative_set (Ecore_X_Window root, Ecore_X_Randr_Crtc crtc_r1, Ecore_X_Randr_Crtc crtc_r2, Ecore_X_Randr_Output_Policy policy, Ecore_X_Randr_Relative_Alignment alignment)
 sets a CRTC relative to another one.
EAPI Ecore_X_Randr_Output * ecore_x_randr_output_clones_get (Ecore_X_Window root, Ecore_X_Randr_Output output, int *num)
 gets the the outputs which might be used simultenously on the same CRTC.
EAPI char * ecore_x_randr_output_name_get (Ecore_X_Window root, Ecore_X_Randr_Output output, int *len)
 gets the given output's name as reported by X
EAPI void ecore_x_randr_mode_size_get (Ecore_X_Window root, Ecore_X_Randr_Mode mode, int *w, int *h)
 gets the width and hight of a given mode
EAPI void ecore_x_randr_screen_backlight_level_set (Ecore_X_Window root, double level)
 set up the backlight level to the given level.
EAPI unsigned char * ecore_x_randr_output_edid_get (Ecore_X_Window root, Ecore_X_Randr_Output output, unsigned long *length)
 gets the EDID information of an attached output if available.
EAPI Ecore_X_Region ecore_x_region_new (Ecore_X_Rectangle *rects, int num)
 Create a region from rectangles.
EAPI Ecore_X_Region ecore_x_region_new_from_bitmap (Ecore_X_Pixmap bitmap)
 Create a region from a pixmap.
EAPI Ecore_X_Region ecore_x_region_new_from_window (Ecore_X_Window win, Ecore_X_Region_Type type)
 Create a region from a window.
EAPI Ecore_X_Region ecore_x_region_new_from_gc (Ecore_X_GC gc)
 Create a region from a graphic context.
EAPI Ecore_X_Region ecore_x_region_new_from_picture (Ecore_X_Picture picture)
 Create a region from a picture.
EAPI void ecore_x_region_free (Ecore_X_Region region)
 Destroy a region.
EAPI void ecore_x_region_set (Ecore_X_Region region, Ecore_X_Rectangle *rects, int num)
 Set the content of a region.
EAPI void ecore_x_region_copy (Ecore_X_Region dest, Ecore_X_Region source)
 Copy the content of a region.
EAPI void ecore_x_region_combine (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the union of two regions.
EAPI void ecore_x_region_intersect (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the intersection of two regions.
EAPI void ecore_x_region_subtract (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the subtraction of two regions.
EAPI void ecore_x_region_invert (Ecore_X_Region dest, Ecore_X_Rectangle *bounds, Ecore_X_Region source)
 Make the subtraction of regions by bounds.
EAPI void ecore_x_region_translate (Ecore_X_Region region, int dx, int dy)
 Translate a region.
EAPI void ecore_x_region_extents (Ecore_X_Region dest, Ecore_X_Region source)
 Extent a region.
EAPI Ecore_X_Rectangle * ecore_x_region_fetch (Ecore_X_Region region, int *num, Ecore_X_Rectangle *bounds)
 Return the rectangles that compose a region.
EAPI void ecore_x_region_expand (Ecore_X_Region dest, Ecore_X_Region source, unsigned int left, unsigned int right, unsigned int top, unsigned int bottom)
 Expand a region.
EAPI void ecore_x_region_gc_clip_set (Ecore_X_Region region, Ecore_X_GC gc, int x_origin, int y_origin)
 Change clip-mask in a graphic context to the specified region.
EAPI void ecore_x_region_window_shape_set (Ecore_X_Region region, Ecore_X_Window win, Ecore_X_Shape_Type type, int x_offset, int y_offset)
 Change the shape extension of a window.
EAPI void ecore_x_region_picture_clip_set (Ecore_X_Region region, Ecore_X_Picture picture, int x_origin, int y_origin)
 Change clip-mask in picture to the specified region.
EAPI Eina_Bool ecore_x_fixes_selection_notification_request (Ecore_X_Atom selection)
 xfixes selection notification request.
EAPI Eina_Bool ecore_x_composite_query (void)
 Return whether the Composite Extension is available.
EAPI Ecore_X_Damage ecore_x_damage_new (Ecore_X_Drawable d, Ecore_X_Damage_Report_Level level)
 Create a damage object.
EAPI void ecore_x_damage_free (Ecore_X_Damage damage)
 Destroy a damage object.
EAPI void ecore_x_damage_subtract (Ecore_X_Damage damage, Ecore_X_Region repair, Ecore_X_Region parts)
 Synchronously modifies the region.
EAPI Eina_Bool ecore_x_dpms_query (void)
 Checks if the X DPMS extension is available on the server.
EAPI Eina_Bool ecore_x_dpms_capable_get (void)
 Checks if the X server is capable of DPMS.
EAPI Eina_Bool ecore_x_dpms_enabled_get (void)
 Checks the DPMS state of the display.
EAPI void ecore_x_dpms_enabled_set (int enabled)
 Sets the DPMS state of the display.
EAPI void ecore_x_dpms_timeouts_get (unsigned int *standby, unsigned int *suspend, unsigned int *off)
 Gets the timeouts.
EAPI Eina_Bool ecore_x_dpms_timeouts_set (unsigned int standby, unsigned int suspend, unsigned int off)
 Sets the timeouts.
EAPI unsigned int ecore_x_dpms_timeout_standby_get (void)
 Returns the amount of time of inactivity before standby mode is invoked.
EAPI unsigned int ecore_x_dpms_timeout_suspend_get (void)
 Returns the amount of time of inactivity before the second level of power saving is invoked.
EAPI unsigned int ecore_x_dpms_timeout_off_get (void)
 Returns the amount of time of inactivity before the third and final level of power saving is invoked.
EAPI void ecore_x_dpms_timeout_standby_set (unsigned int new_timeout)
 Sets the standby timeout (in unit of seconds).
EAPI void ecore_x_dpms_timeout_suspend_set (unsigned int new_timeout)
 Sets the suspend timeout (in unit of seconds).
EAPI void ecore_x_dpms_timeout_off_set (unsigned int new_timeout)
 Sets the off timeout (in unit of seconds).
EAPI int ecore_x_keysym_keycode_get (const char *keyname)
 Given a keyname, return the keycode representing that key.

Variables

EAPI int ECORE_X_EVENT_ANY
 low level event dependent on backend in use, if Xlib will be XEvent, if XCB will be xcb_generic_event_t.

Detailed Description

Ecore functions for dealing with the X Windows System.

Ecore_X provides a wrapper and convenience functions for using the X Windows System. Function groups for this part of the library include the following:


Enumeration Type Documentation

Enumerator:
ECORE_X_WINDOW_STATE_ICONIFIED 

The window is iconified.

ECORE_X_WINDOW_STATE_MODAL 

The window is a modal dialog box.

ECORE_X_WINDOW_STATE_STICKY 

The window manager should keep the window's position fixed even if the virtual desktop scrolls.

ECORE_X_WINDOW_STATE_MAXIMIZED_VERT 

The window has the maximum vertical size.

ECORE_X_WINDOW_STATE_MAXIMIZED_HORZ 

The window has the maximum horizontal size.

ECORE_X_WINDOW_STATE_SHADED 

The window is shaded.

ECORE_X_WINDOW_STATE_SKIP_TASKBAR 

The window should not be included in the taskbar.

ECORE_X_WINDOW_STATE_SKIP_PAGER 

The window should not be included in the pager.

ECORE_X_WINDOW_STATE_HIDDEN 

The window is invisible (i.e.

minimized/iconified)

ECORE_X_WINDOW_STATE_FULLSCREEN 

The window should fill the entire screen and have no window border/decorations.

Enumerator:
ECORE_X_WINDOW_STATE_HINT_NONE 

Do not provide any state hint to the window manager.

ECORE_X_WINDOW_STATE_HINT_WITHDRAWN 

The window wants to remain hidden and NOT iconified.

ECORE_X_WINDOW_STATE_HINT_NORMAL 

The window wants to be mapped normally.

ECORE_X_WINDOW_STATE_HINT_ICONIC 

The window wants to start in an iconified state.


Function Documentation

EAPI Eina_Bool ecore_x_bell ( int  percent)

Invoke the standard system beep to alert users.

Parameters:
percentThe volume at which the bell rings. Must be in the range [-100,+100]. If percent >= 0, the final volume will be: base - [(base * percent) / 100] + percent Otherwise, it's calculated as: base + [(base * percent) / 100] where base is the bell's base volume as set by XChangeKeyboardControl(3).
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.

References ecore_x_bell().

Referenced by ecore_x_bell().

EAPI Eina_Bool ecore_x_client_message32_send ( Ecore_X_Window  win,
Ecore_X_Atom  type,
Ecore_X_Event_Mask  mask,
long  d0,
long  d1,
long  d2,
long  d3,
long  d4 
)

Send client message with given type and format 32.

Parameters:
winThe window the message is sent to.
typeThe client message type.
d0The client message data item 1
d1The client message data item 2
d2The client message data item 3
d3The client message data item 4
d4The client message data item 5
Returns:
EINA_TRUE on success EINA_FALSE otherwise.

References ecore_x_client_message32_send().

Referenced by ecore_x_client_message32_send(), and ecore_x_window_delete_request_send().

EAPI Eina_Bool ecore_x_client_message8_send ( Ecore_X_Window  win,
Ecore_X_Atom  type,
const void *  data,
int  len 
)

Send client message with given type and format 8.

Parameters:
winThe window the message is sent to.
typeThe client message type.
dataData to be sent.
lenNumber of data bytes, max 20.
Returns:
EINA_TRUE on success EINA_FALSE otherwise.

References ecore_x_client_message8_send().

Referenced by ecore_x_client_message8_send().

EAPI Ecore_X_Colormap ecore_x_default_colormap_get ( Ecore_X_Display *  disp,
Ecore_X_Screen *  screen 
)

Retrieve the default Colormap.

Parameters:
dispThe Display to get the Default Colormap from
screenThe Screen.
Returns:
The default colormap.
Since:
1.1.0

References ecore_x_default_colormap_get().

Referenced by ecore_x_default_colormap_get().

EAPI int ecore_x_default_depth_get ( Ecore_X_Display *  disp,
Ecore_X_Screen *  screen 
)

Retrieve the default depth.

Parameters:
dispThe Display to get the Default Depth from
screenThe Screen.
Returns:
The default depth.
Since:
1.1.0

References ecore_x_default_depth_get().

Referenced by ecore_x_default_depth_get().

EAPI Ecore_X_Visual ecore_x_default_visual_get ( Ecore_X_Display *  disp,
Ecore_X_Screen *  screen 
)

Retrieve the default Visual.

Parameters:
dispThe Display to get the Default Visual from
screenThe Screen.
Returns:
The default visual.
Since:
1.1.0

References ecore_x_default_visual_get().

Referenced by ecore_x_default_visual_get().

EAPI void ecore_x_dnd_callback_pos_update_set ( void(*)(void *, Ecore_X_Xdnd_Position *data)  cb,
const void *  data 
)

The DND position update cb is called Ecore_X sends a DND position to a client.

It essentially mirrors some of the data sent in the position message. Generally this cb should be set just before position update is called. Please note well you need to look after your own data pointer if someone trashes you position update cb set.

It is considered good form to clear this when the dnd event finishes.

Parameters:
cbCallback to updated each time ecore_x sends a position update.
dataUser data.

References ecore_x_dnd_callback_pos_update_set().

Referenced by ecore_x_dnd_callback_pos_update_set().

EAPI int ecore_x_dpi_get ( void  )

Return the screen DPI.

This is a simplistic call to get DPI. It does not account for differing DPI in the x amd y axes nor does it account for multihead or xinerama and xrander where different parts of the screen may have differen DPI etc.

Returns:
the general screen DPI (dots/pixels per inch).

This is a simplistic call to get DPI. It does not account for differing DPI in the x amd y axes nor does it accoutn for multihead or xinerama and xrander where different parts of the screen may have differen DPI etc.

Returns:
the general screen DPI (dots/pixels per inch).

References ecore_x_dpi_get().

Referenced by ecore_x_dpi_get().

EAPI void ecore_x_drawable_rectangle_fill ( Ecore_X_Drawable  d,
Ecore_X_GC  gc,
int  x,
int  y,
int  width,
int  height 
)

Fill the specified rectangle on a drawable.

Parameters:
dThe given drawable.
gcThe graphic context that controls the fill rules.
xThe X coordinate of the top-left corner of the rectangle.
yThe Y coordinate of the top-left corner of the rectangle.
widthThe width of the rectangle.
heightThe height of the rectangle.

References ecore_x_drawable_rectangle_fill().

Referenced by ecore_x_drawable_rectangle_fill().

EAPI int ecore_x_error_code_get ( void  )

Get the error code from the error.

Returns:
The error code from the X error

Return the error code from the last X error

References ecore_x_error_code_get().

Referenced by ecore_x_error_code_get().

EAPI void ecore_x_error_handler_set ( void(*)(void *data)  func,
const void *  data 
)

Set the error handler.

Parameters:
funcThe error handler function
dataThe data to be passed to the handler function

Set the X error handler function

References ecore_x_error_handler_set().

Referenced by ecore_x_error_handler_set().

EAPI int ecore_x_error_request_get ( void  )

Get the request code that caused the error.

Returns:
The request code causing the X error

Return the X request code that caused the last X error

References ecore_x_error_request_get().

Referenced by ecore_x_error_request_get().

EAPI Ecore_X_ID ecore_x_error_resource_id_get ( void  )

Get the resource id that caused the error.

Returns:
The resource id causing the X error

Return the X resource id that caused the last X error

References ecore_x_error_resource_id_get().

Referenced by ecore_x_error_resource_id_get().

EAPI Eina_Bool ecore_x_fixes_selection_notification_request ( Ecore_X_Atom  selection)

xfixes selection notification request.

This lets you choose which selections you want to get notifications for.

Parameters:
selectionthe selection atom.
Returns:
EINA_TRUE on success, EINA_FALSE otherwise.
Since:
1.1.0

References ecore_x_fixes_selection_notification_request().

Referenced by ecore_x_fixes_selection_notification_request().

EAPI void ecore_x_gc_free ( Ecore_X_GC  gc)

Deletes and frees the given graphics context.

Parameters:
gcThe given graphics context.

References ecore_x_gc_free().

Referenced by ecore_x_gc_free().

EAPI Ecore_X_GC ecore_x_gc_new ( Ecore_X_Drawable  draw,
Ecore_X_GC_Value_Mask  value_mask,
const unsigned int *  value_list 
)

Creates a new default graphics context associated with the given drawable.

Parameters:
drawDrawable to create graphics context with. If 0 is given instead, the default root window is used.
value_maskBitmask values.
value_listList of values. The order of values must be the same than the corresponding bitmaks.
Returns:
The new default graphics context.

References ecore_x_gc_new().

Referenced by ecore_x_gc_new().

EAPI Ecore_X_Window ecore_x_icccm_client_leader_get ( Ecore_X_Window  win)

Get the window's client leader.

Parameters:
winThe window
Returns:
The window's client leader window, or 0 if unset

References ecore_x_icccm_client_leader_get().

Referenced by ecore_x_icccm_client_leader_get().

EAPI void ecore_x_icccm_client_leader_set ( Ecore_X_Window  win,
Ecore_X_Window  l 
)

Set the window's client leader.

Parameters:
winThe window
lThe client leader window

All non-transient top-level windows created by an app other than the main window must have this property set to the app's main window.

References ecore_x_icccm_client_leader_set().

Referenced by ecore_x_icccm_client_leader_set().

EAPI char* ecore_x_icccm_client_machine_get ( Ecore_X_Window  win)

Get a window client machine string.

Parameters:
winThe window
Returns:
The windows client machine string

Return the client machine of a window. String must be free'd when done with.

References ecore_x_icccm_client_machine_get().

Referenced by ecore_x_icccm_client_machine_get().

EAPI void ecore_x_icccm_colormap_window_set ( Ecore_X_Window  win,
Ecore_X_Window  subwin 
)

Add a subwindow to the list of windows that need a different colormap installed.

Parameters:
winThe toplevel window
subwinThe subwindow to be added to the colormap windows list

References ecore_x_icccm_colormap_window_set(), ecore_x_window_prop_property_get(), and ecore_x_window_prop_property_set().

Referenced by ecore_x_icccm_colormap_window_set().

EAPI void ecore_x_icccm_colormap_window_unset ( Ecore_X_Window  win,
Ecore_X_Window  subwin 
)

Remove a window from the list of colormap windows.

Parameters:
winThe toplevel window
subwinThe window to be removed from the colormap window list.

References ecore_x_icccm_colormap_window_unset(), ecore_x_window_prop_property_get(), and ecore_x_window_prop_property_set().

Referenced by ecore_x_icccm_colormap_window_unset().

EAPI void ecore_x_icccm_command_get ( Ecore_X_Window  win,
int *  argc,
char ***  argv 
)

Get the WM_COMMAND property for win.

Return the command of a window. String must be free'd when done with.

Parameters:
winThe window.
argcNumber of arguments.
argvArguments.

References ecore_x_icccm_command_get().

Referenced by ecore_x_icccm_command_get().

EAPI void ecore_x_icccm_command_set ( Ecore_X_Window  win,
int  argc,
char **  argv 
)

Sets the WM_COMMAND property for win.

Parameters:
winThe window.
argcNumber of arguments.
argvArguments.

References ecore_x_icccm_command_set().

Referenced by ecore_x_icccm_command_set(), and ecore_x_window_defaults_set().

EAPI char* ecore_x_icccm_icon_name_get ( Ecore_X_Window  win)

Get a window icon name.

Parameters:
winThe window
Returns:
The windows icon name string

Return the icon name of a window. String must be free'd when done with.

References ecore_x_icccm_icon_name_get().

Referenced by ecore_x_icccm_icon_name_get().

EAPI void ecore_x_icccm_icon_name_set ( Ecore_X_Window  win,
const char *  t 
)

Set a window icon name.

Parameters:
winThe window
tThe icon name string

Set a window icon name

References ecore_x_icccm_icon_name_set().

Referenced by ecore_x_icccm_icon_name_set().

EAPI void ecore_x_icccm_name_class_get ( Ecore_X_Window  win,
char **  n,
char **  c 
)

Get a window name & class.

Parameters:
winThe window
nThe name string
cThe class string

Get a window name * class

References ecore_x_icccm_name_class_get().

Referenced by ecore_x_icccm_name_class_get().

EAPI void ecore_x_icccm_name_class_set ( Ecore_X_Window  win,
const char *  n,
const char *  c 
)

Set a window name & class.

Parameters:
winThe window
nThe name string
cThe class string

Set a window name * class

References ecore_x_icccm_name_class_set().

Referenced by ecore_x_icccm_name_class_set().

EAPI void ecore_x_icccm_protocol_atoms_set ( Ecore_X_Window  win,
Ecore_X_Atom *  protos,
int  num 
)

Set protocol atoms explicitly.

Parameters:
winThe Window
protosAn array of protocol atoms
numthe number of members of the array

References ecore_x_icccm_protocol_atoms_set().

Referenced by ecore_x_icccm_protocol_atoms_set().

EAPI Eina_Bool ecore_x_icccm_protocol_isset ( Ecore_X_Window  win,
Ecore_X_WM_Protocol  protocol 
)

Determines whether a protocol is set for a window.

Parameters:
winThe Window
protocolThe protocol to query
Returns:
1 if the protocol is set, else 0.

References ecore_x_icccm_protocol_isset().

Referenced by ecore_x_icccm_protocol_isset().

EAPI void ecore_x_icccm_protocol_set ( Ecore_X_Window  win,
Ecore_X_WM_Protocol  protocol,
Eina_Bool  on 
)

Set or unset a wm protocol property.

Parameters:
winThe Window
protocolThe protocol to enable/disable
onOn/Off

References ecore_x_icccm_protocol_set().

Referenced by ecore_x_icccm_protocol_set().

EAPI Ecore_X_Window ecore_x_icccm_transient_for_get ( Ecore_X_Window  win)

Get the window this window is transient for, if any.

Parameters:
winThe window to check
Returns:
The window ID of the top-level window, or 0 if the property does not exist.

References ecore_x_icccm_transient_for_get().

Referenced by ecore_x_icccm_transient_for_get().

EAPI void ecore_x_icccm_transient_for_set ( Ecore_X_Window  win,
Ecore_X_Window  forwin 
)

Specify that a window is transient for another top-level window and should be handled accordingly.

Parameters:
winthe transient window
forwinthe toplevel window

References ecore_x_icccm_transient_for_set().

Referenced by ecore_x_icccm_transient_for_set().

EAPI void ecore_x_icccm_transient_for_unset ( Ecore_X_Window  win)

Remove the transient_for setting from a window.

Parameters:
winThe window

References ecore_x_icccm_transient_for_unset().

Referenced by ecore_x_icccm_transient_for_unset().

EAPI char* ecore_x_icccm_window_role_get ( Ecore_X_Window  win)

Get the window role.

Parameters:
winThe window
Returns:
The window's role string.

References ecore_x_icccm_window_role_get(), and ecore_x_window_prop_string_get().

Referenced by ecore_x_icccm_window_role_get().

EAPI void ecore_x_icccm_window_role_set ( Ecore_X_Window  win,
const char *  role 
)

Set the window role hint.

Parameters:
winThe window
roleThe role string

References ecore_x_icccm_window_role_set(), and ecore_x_window_prop_string_set().

Referenced by ecore_x_icccm_window_role_set().

EAPI void ecore_x_io_error_handler_set ( void(*)(void *data)  func,
const void *  data 
)

Set the I/O error handler.

Parameters:
funcThe I/O error handler function
dataThe data to be passed to the handler function

Set the X I/O error handler function

References ecore_x_io_error_handler_set().

Referenced by ecore_x_io_error_handler_set().

EAPI int ecore_x_keysym_keycode_get ( const char *  keyname)

Given a keyname, return the keycode representing that key.

Since:
1.2.0

References ecore_x_keysym_keycode_get().

Referenced by ecore_x_keysym_keycode_get().

EAPI void ecore_x_kill ( Ecore_X_Window  win)

Kill a specific client.

You can kill a specific client owning window win

Parameters:
winWindow of the client to be killed

References ecore_x_kill().

Referenced by ecore_x_kill().

EAPI void ecore_x_killall ( Ecore_X_Window  root)

Kill all clients with subwindows under a given window.

You can kill all clients connected to the X server by using ecore_x_window_root_list to get a list of root windows, and then passing each root window to this function.

Parameters:
rootThe window whose children will be killed.

References ecore_x_killall(), and ecore_x_sync().

Referenced by ecore_x_killall().

EAPI Ecore_X_Randr_Mode ecore_x_randr_crtc_mode_get ( Ecore_X_Window  root,
Ecore_X_Randr_Crtc  crtc 
)

Get the current set mode of a given CRTC.

Parameters:
rootthe window's screen to be queried
crtcthe CRTC which's should be queried
Returns:
currently set mode or - in case parameters are invalid - Ecore_X_Randr_Unset

References ecore_x_randr_crtc_mode_get().

Referenced by ecore_x_randr_crtc_mode_get(), and ecore_x_randr_crtc_pos_relative_set().

EAPI Eina_Bool ecore_x_randr_crtc_mode_set ( Ecore_X_Window  root,
Ecore_X_Randr_Crtc  crtc,
Ecore_X_Randr_Output *  outputs,
int  noutputs,
Ecore_X_Randr_Mode  mode 
)

sets a mode for a CRTC and the outputs attached to it

Parameters:
rootthe window's screen to be queried
crtcthe CRTC which shall be set
outputsarray of outputs which have to be compatible with the mode. If NULL CRTC will be disabled.
noutputsnumber of outputs in array to be used. Use Ecore_X_Randr_Unset (or -1) to use currently used outputs.
modeXID of the mode to be set. If set to 0 the CRTC will be disabled. If set to -1 the call will fail.
Returns:
EINA_TRUE if mode setting was successful. Else EINA_FALSE

References ecore_x_randr_crtc_mode_set(), and ecore_x_randr_crtc_settings_set().

Referenced by ecore_x_randr_crtc_mode_set().

EAPI Eina_Bool ecore_x_randr_crtc_pos_relative_set ( Ecore_X_Window  root,
Ecore_X_Randr_Crtc  crtc_r1,
Ecore_X_Randr_Crtc  crtc_r2,
Ecore_X_Randr_Output_Policy  policy,
Ecore_X_Randr_Relative_Alignment  alignment 
)

sets a CRTC relative to another one.

Parameters:
crtc1the CRTC to be positioned.
crtc2the CRTC the position should be relative to
policythe relation between the crtcs
alignmentin case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's borders
Returns:
EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if repositioning failed or if position of new crtc would be out of given screen's min/max bounds.
Parameters:
crtc_r1the CRTC to be positioned.
crtc_r2the CRTC the position should be relative to
policythe relation between the crtcs
alignmentin case CRTCs size differ, aligns CRTC1 accordingly at CRTC2's borders
Returns:
EINA_TRUE if crtc could be successfully positioned. EINA_FALSE if repositioning failed or if position of new crtc would be out of given screen's min/max bounds.

References ecore_x_randr_crtc_mode_get(), and ecore_x_randr_crtc_pos_relative_set().

Referenced by ecore_x_randr_crtc_pos_relative_set().

EAPI Eina_Bool ecore_x_randr_crtc_settings_set ( Ecore_X_Window  root,
Ecore_X_Randr_Crtc  crtc,
Ecore_X_Randr_Output *  outputs,
int  noutputs,
int  x,
int  y,
Ecore_X_Randr_Mode  mode,
Ecore_X_Randr_Orientation  orientation 
)

sets the demanded parameters for a given CRTC.

Note that the CRTC is auto enabled in it's preferred mode, when it was disabled before.

Parameters:
rootthe root window which's default display will be queried
crtcthe CRTC which's configuration should be altered
outputsan array of outputs, that should display this CRTC's content.
noutputsnumber of outputs in the array of outputs. If set to Ecore_X_Randr_Unset, current outputs and number of outputs will be used. If set to Ecore_X_Randr_None, CRTC will be disabled
xnew x coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current x corrdinate will be assumed.
ynew y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y corrdinate will be assumed.
modethe new mode to be set. If Ecore_X_Randr_None is passed, the CRTC will be disabled. If Ecore_X_Randr_Unset is passed, the current mode is assumed.
orientationthe new orientation to be set. If Ecore_X_Randr_Unset is used, the current mode is assumed.
Returns:
EINA_TRUE if the configuration alteration was successful, else EINA_FALSE

References ecore_x_randr_crtc_settings_set().

Referenced by ecore_x_randr_crtc_mode_set(), and ecore_x_randr_crtc_settings_set().

EAPI void ecore_x_randr_events_select ( Ecore_X_Window  win,
Eina_Bool  on 
)

enable event selection.

This enables basic interaction with output/crtc events and requires RRandR >= 1.2.

Parameters:
winselect this window's properties for RandRR events
onenable/disable selecting

References ecore_x_randr_events_select().

Referenced by ecore_x_randr_events_select().

EAPI void ecore_x_randr_mode_size_get ( Ecore_X_Window  root,
Ecore_X_Randr_Mode  mode,
int *  w,
int *  h 
)

gets the width and hight of a given mode

Parameters:
modethe mode which's size is to be looked up
wwidth of given mode in px
hheight of given mode in px

References ecore_x_randr_mode_size_get().

Referenced by ecore_x_randr_mode_size_get().

EAPI Ecore_X_Randr_Output* ecore_x_randr_output_clones_get ( Ecore_X_Window  root,
Ecore_X_Randr_Output  output,
int *  num 
)

gets the the outputs which might be used simultenously on the same CRTC.

Parameters:
rootwindow that this information should be queried for.
outputthe output which's clones we concern
numnumber of possible clones

References ecore_x_randr_output_clones_get().

Referenced by ecore_x_randr_output_clones_get().

EAPI unsigned char* ecore_x_randr_output_edid_get ( Ecore_X_Window  root,
Ecore_X_Randr_Output  output,
unsigned long *  length 
)

gets the EDID information of an attached output if available.

Note that this information is not to be compared using ordinary string comparison functions, since it includes 0-bytes.

Parameters:
rootwindow this information should be queried from
outputthe XID of the output
lengthlength of the byte-array. If NULL, request will fail.

References ecore_x_atom_get(), and ecore_x_randr_output_edid_get().

Referenced by ecore_x_randr_output_edid_get().

EAPI char* ecore_x_randr_output_name_get ( Ecore_X_Window  root,
Ecore_X_Randr_Output  output,
int *  len 
)

gets the given output's name as reported by X

Parameters:
rootthe window which's screen will be queried
lenlength of returned c-string.
Returns:
name of the output as reported by X

References ecore_x_randr_output_name_get().

Referenced by ecore_x_randr_output_name_get().

EAPI void ecore_x_randr_screen_backlight_level_set ( Ecore_X_Window  root,
double  level 
)

set up the backlight level to the given level.

Parameters:
rootthe window's screen which will be set.
levelof the backlight between 0 and 1

References ecore_x_randr_screen_backlight_level_set().

Referenced by ecore_x_randr_screen_backlight_level_set().

EAPI void ecore_x_randr_screen_reset ( Ecore_X_Window  root)

removes unused screen space.

The most upper left CRTC is set to 0x0 and all other CRTCs dx,dy respectively.

Parameters:
rootthe window's screen which will be reset.

References ecore_x_randr_screen_reset().

Referenced by ecore_x_randr_screen_reset().

EAPI Eina_Bool ecore_x_selection_clipboard_clear ( void  )

Release ownership of the clipboard selection.

Returns:
Returns 1 if the selection was successfully cleared, or 0 if unsuccessful.

References ecore_x_selection_clipboard_clear().

Referenced by ecore_x_selection_clipboard_clear().

EAPI Eina_Bool ecore_x_selection_clipboard_set ( Ecore_X_Window  w,
const void *  data,
int  size 
)

Claim ownership of the CLIPBOARD selection and set its data.

Parameters:
wThe window to which this selection belongs
dataThe data associated with the selection
sizeThe size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

Get the converted data from a previous CLIPBOARD selection request. The buffer must be freed when done with.

References ecore_x_selection_clipboard_set().

Referenced by ecore_x_selection_clipboard_set().

EAPI Ecore_X_Window ecore_x_selection_owner_get ( Ecore_X_Atom  atom)

Return the window that currently owns the specified selection.

Parameters:
atomThe specified selection atom.
Returns:
The window that currently owns the specified selection.
Since:
1.1.0

References ecore_x_selection_owner_get().

Referenced by ecore_x_selection_owner_get().

EAPI void ecore_x_selection_owner_set ( Ecore_X_Window  win,
Ecore_X_Atom  atom,
Ecore_X_Time  tim 
)

Change the owner and last-change time for the specified selection.

Parameters:
winThe owner of the specified atom.
atomThe selection atom
timSpecifies the time
Since:
1.1.0

References ecore_x_selection_owner_set().

Referenced by ecore_x_selection_owner_set().

EAPI Eina_Bool ecore_x_selection_primary_clear ( void  )

Release ownership of the primary selection.

Returns:
Returns 1 if the selection was successfully cleared, or 0 if unsuccessful.

References ecore_x_selection_primary_clear().

Referenced by ecore_x_selection_primary_clear().

EAPI Eina_Bool ecore_x_selection_primary_set ( Ecore_X_Window  w,
const void *  data,
int  size 
)

Claim ownership of the PRIMARY selection and set its data.

Parameters:
wThe window to which this selection belongs
dataThe data associated with the selection
sizeThe size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

References ecore_x_selection_primary_set().

Referenced by ecore_x_selection_primary_set().

EAPI Eina_Bool ecore_x_selection_secondary_clear ( void  )

Release ownership of the secondary selection.

Returns:
Returns 1 if the selection was successfully cleared, or 0 if unsuccessful.

References ecore_x_selection_secondary_clear().

Referenced by ecore_x_selection_secondary_clear().

EAPI Eina_Bool ecore_x_selection_secondary_set ( Ecore_X_Window  w,
const void *  data,
int  size 
)

Claim ownership of the SECONDARY selection and set its data.

Parameters:
wThe window to which this selection belongs
dataThe data associated with the selection
sizeThe size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

References ecore_x_selection_secondary_set().

Referenced by ecore_x_selection_secondary_set().

EAPI Eina_Bool ecore_x_selection_xdnd_clear ( void  )

Release ownership of the XDND selection.

Returns:
Returns 1 if the selection was successfully cleared, or 0 if unsuccessful.

References ecore_x_selection_xdnd_clear().

Referenced by ecore_x_selection_xdnd_clear().

EAPI Eina_Bool ecore_x_selection_xdnd_set ( Ecore_X_Window  w,
const void *  data,
int  size 
)

Claim ownership of the XDND selection and set its data.

Parameters:
wThe window to which this selection belongs
dataThe data associated with the selection
sizeThe size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

References ecore_x_selection_xdnd_set().

Referenced by ecore_x_selection_xdnd_set().

EAPI unsigned int ecore_x_visual_id_get ( Ecore_X_Visual  visual)

Retrieve the Visual ID from a given Visual.

Parameters:
visualThe Visual to get the ID for.
Returns:
The visual id.
Since:
1.1.0

References ecore_x_visual_id_get().

Referenced by ecore_x_visual_id_get().

EAPI void ecore_x_window_background_color_set ( Ecore_X_Window  win,
unsigned short  r,
unsigned short  g,
unsigned short  b 
)

Sets the background color of the given window.

Parameters:
winThe given window
rred value (0...65536, 16 bits)
ggreen value (0...65536, 16 bits)
bblue value (0...65536, 16 bits)

References ecore_x_window_background_color_set().

Referenced by ecore_x_window_background_color_set().

EAPI void ecore_x_window_cursor_show ( Ecore_X_Window  win,
Eina_Bool  show 
)

To be documented.

FIXME: To be fixed.

References ecore_x_window_cursor_show().

Referenced by ecore_x_window_cursor_show().

EAPI int ecore_x_window_depth_get ( Ecore_X_Window  win)

Retrieves the depth of the given window.

Parameters:
winThe given window.
Returns:
Depth of the window.

References ecore_x_drawable_depth_get(), and ecore_x_window_depth_get().

Referenced by ecore_x_window_depth_get().

EAPI void ecore_x_window_hide ( Ecore_X_Window  win)

Hides a window.

Synonymous to "unmapping" a window in X Window System terminology.

Parameters:
winThe window to hide.

References ecore_x_window_hide().

Referenced by ecore_x_window_hide().

EAPI Ecore_X_Window* ecore_x_window_ignore_list ( int *  num)

Get the ignore list.

Parameters:
numnumber of windows in the list
Returns:
list of windows to ignore

References ecore_x_window_ignore_list().

Referenced by ecore_x_window_ignore_list().

EAPI void ecore_x_window_ignore_set ( Ecore_X_Window  win,
int  ignore 
)

Set if a window should be ignored.

Parameters:
winThe given window.
ignoreif to ignore

References ecore_x_window_ignore_set().

Referenced by ecore_x_window_ignore_set().

EAPI Ecore_X_Atom ecore_x_window_prop_any_type ( void  )

To be documented.

FIXME: To be fixed.

References ecore_x_window_prop_any_type().

Referenced by ecore_x_window_prop_any_type().

EAPI int ecore_x_window_prop_property_get ( Ecore_X_Window  win,
Ecore_X_Atom  property,
Ecore_X_Atom  type,
int  size,
unsigned char **  data,
int *  num 
)
EAPI void ecore_x_window_prop_property_set ( Ecore_X_Window  win,
Ecore_X_Atom  property,
Ecore_X_Atom  type,
int  size,
void *  data,
int  number 
)
EAPI Ecore_X_WM_Protocol* ecore_x_window_prop_protocol_list_get ( Ecore_X_Window  win,
int *  num_ret 
)

To be documented.

FIXME: To be fixed.

References ecore_x_window_prop_protocol_list_get().

Referenced by ecore_x_window_prop_protocol_list_get().

EAPI char* ecore_x_window_prop_string_get ( Ecore_X_Window  win,
Ecore_X_Atom  type 
)

Get a window string property.

Parameters:
winThe window
typeThe property

Return window string property of a window. String must be free'd when done.

References ecore_x_window_prop_string_get().

Referenced by ecore_x_icccm_window_role_get(), and ecore_x_window_prop_string_get().

EAPI void ecore_x_window_prop_string_set ( Ecore_X_Window  win,
Ecore_X_Atom  type,
const char *  str 
)

Set a window string property.

Parameters:
winThe window
typeThe property
strThe string

Set a window string property

References ecore_x_window_prop_string_set().

Referenced by ecore_x_icccm_window_role_set(), and ecore_x_window_prop_string_set().

EAPI Ecore_X_Window* ecore_x_window_root_list ( int *  num_ret)

Get a list of all the root windows on the server.

Note:
The returned array will need to be freed after use.
Parameters:
num_retPointer to integer to put number of windows returned in.
Returns:
An array of all the root windows. NULL is returned if memory could not be allocated for the list, or if num_ret is NULL.

References ecore_x_screen_count_get(), and ecore_x_window_root_list().

Referenced by ecore_evas_software_x11_8_new(), and ecore_x_window_root_list().

EAPI void ecore_x_window_show ( Ecore_X_Window  win)

Shows a window.

Synonymous to "mapping" a window in X Window System terminology.

Parameters:
winThe window to show.

References ecore_x_window_show().

Referenced by ecore_x_window_show().


Variable Documentation

low level event dependent on backend in use, if Xlib will be XEvent, if XCB will be xcb_generic_event_t.

Warning:
avoid using it.

Referenced by ecore_x_init().