Ecore_X.h File Reference

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

Data Structures

struct  _Ecore_X_Window_Attributes
 

Typedefs

typedef struct
_Ecore_X_Window_Attributes 
Ecore_X_Window_Attributes
 

Enumerations

enum  _Ecore_X_Window_State { ,
  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,
  ECORE_X_WINDOW_STATE_ABOVE
}
 Defines the different states of the window of Ecore_X. More...
 
enum  _Ecore_X_Error_Code {
  ECORE_X_ERROR_CODE_SUCCESS = 0,
  ECORE_X_ERROR_CODE_BAD_REQUEST = 1,
  ECORE_X_ERROR_CODE_BAD_VALUE = 2,
  ECORE_X_ERROR_CODE_BAD_WINDOW = 3,
  ECORE_X_ERROR_CODE_BAD_PIXMAP = 4,
  ECORE_X_ERROR_CODE_BAD_ATOM = 5,
  ECORE_X_ERROR_CODE_BAD_CURSOR = 6,
  ECORE_X_ERROR_CODE_BAD_FONT = 7,
  ECORE_X_ERROR_CODE_BAD_MATCH = 8,
  ECORE_X_ERROR_CODE_BAD_DRAWABLE = 9,
  ECORE_X_ERROR_CODE_BAD_ACCESS = 10,
  ECORE_X_ERROR_CODE_BAD_ALLOC = 11,
  ECORE_X_ERROR_CODE_BAD_COLOR = 12,
  ECORE_X_ERROR_CODE_BAD_GC = 13,
  ECORE_X_ERROR_CODE_BAD_ID_CHOICE = 14,
  ECORE_X_ERROR_CODE_BAD_NAME = 15,
  ECORE_X_ERROR_CODE_BAD_LENGTH = 16,
  ECORE_X_ERROR_CODE_BAD_IMPLEMENTATION = 17
}
 Defines the error codes of Ecore_X which wraps the X Window Systems protocol's errors. More...
 
enum  _Ecore_X_WM_Protocol {
  ECORE_X_WM_PROTOCOL_DELETE_REQUEST,
  ECORE_X_WM_PROTOCOL_TAKE_FOCUS,
  ECORE_X_NET_WM_PROTOCOL_PING,
  ECORE_X_NET_WM_PROTOCOL_SYNC_REQUEST,
  ECORE_X_WM_PROTOCOL_NUM
}
 
enum  _Ecore_X_Window_Input_Mode {
  ECORE_X_WINDOW_INPUT_MODE_NONE,
  ECORE_X_WINDOW_INPUT_MODE_PASSIVE,
  ECORE_X_WINDOW_INPUT_MODE_ACTIVE_LOCAL,
  ECORE_X_WINDOW_INPUT_MODE_ACTIVE_GLOBAL
}
 
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
}
 Defines the different state hint of the window of Ecore_X. More...
 

Functions

EAPI int ecore_x_init (const char *name)
 Initialize the X display connection to the given display. More...
 
EAPI int ecore_x_shutdown (void)
 Shuts down the Ecore X library. More...
 
EAPI int ecore_x_disconnect (void)
 Shuts down the Ecore X library. More...
 
EAPI Ecore_X_Display * ecore_x_display_get (void)
 Retrieves the Ecore_X_Display handle used for the current X connection. More...
 
EAPI int ecore_x_fd_get (void)
 Retrieves the X display file descriptor. More...
 
EAPI Ecore_X_Screen * ecore_x_default_screen_get (void)
 Retrieves the Ecore_X_Screen handle used for the current X connection. More...
 
EAPI void ecore_x_screen_size_get (const Ecore_X_Screen *screen, int *w, int *h)
 Retrieves the size of an Ecore_X_Screen. More...
 
EAPI int ecore_x_screen_count_get (void)
 Retrieves the number of screens. More...
 
EAPI int ecore_x_screen_index_get (const Ecore_X_Screen *screen)
 Retrieves the index number of the given screen. More...
 
EAPI Ecore_X_Screen * ecore_x_screen_get (int index)
 Retrieves the screen based on index number. More...
 
EAPI void ecore_x_double_click_time_set (double t)
 Sets the timeout for a double and triple clicks to be flagged. More...
 
EAPI double ecore_x_double_click_time_get (void)
 Retrieves the double and triple click flag timeout. More...
 
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. More...
 
EAPI void ecore_x_kill (Ecore_X_Window win)
 Kill a specific client. More...
 
EAPI int ecore_x_dpi_get (void)
 Return the screen DPI. More...
 
EAPI Eina_Bool ecore_x_bell (int percent)
 Invoke the standard system beep to alert users. More...
 
EAPI unsigned int ecore_x_visual_id_get (Ecore_X_Visual visual)
 Retrieve the Visual ID from a given Visual. More...
 
EAPI Ecore_X_Visual ecore_x_default_visual_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default Visual. More...
 
EAPI Ecore_X_Colormap ecore_x_default_colormap_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default Colormap. More...
 
EAPI int ecore_x_default_depth_get (Ecore_X_Display *disp, Ecore_X_Screen *screen)
 Retrieve the default depth. More...
 
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. More...
 
EAPI void ecore_x_io_error_handler_set (void(*func)(void *data), const void *data)
 Set the I/O error handler. More...
 
EAPI int ecore_x_error_request_get (void)
 Get the request code that caused the error. More...
 
EAPI int ecore_x_error_code_get (void)
 Get the error code from the error. More...
 
EAPI Ecore_X_ID ecore_x_error_resource_id_get (void)
 Get the resource id that caused the error. More...
 
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. More...
 
EAPI Eina_Bool ecore_x_selection_primary_clear (void)
 Release ownership of the primary selection. More...
 
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. More...
 
EAPI Eina_Bool ecore_x_selection_secondary_clear (void)
 Release ownership of the secondary selection. More...
 
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. More...
 
EAPI Eina_Bool ecore_x_selection_xdnd_clear (void)
 Release ownership of the XDND selection. More...
 
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. More...
 
EAPI Eina_Bool ecore_x_selection_clipboard_clear (void)
 Release ownership of the clipboard selection. More...
 
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. More...
 
EAPI Ecore_X_Window ecore_x_selection_owner_get (Ecore_X_Atom atom)
 Return the window that currently owns the specified selection. More...
 
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. More...
 
EAPI Ecore_X_Window ecore_x_window_new (Ecore_X_Window parent, int x, int y, int w, int h)
 Creates a new window. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI void ecore_x_window_free (Ecore_X_Window win)
 Deletes the given window. More...
 
EAPI void ecore_x_window_ignore_set (Ecore_X_Window win, int ignore)
 Set if a window should be ignored. More...
 
EAPI Ecore_X_Window * ecore_x_window_ignore_list (int *num)
 Get the ignore list. More...
 
EAPI void ecore_x_window_delete_request_send (Ecore_X_Window win)
 Sends a delete request to the given window. More...
 
EAPI void ecore_x_window_show (Ecore_X_Window win)
 Shows a window. More...
 
EAPI void ecore_x_window_hide (Ecore_X_Window win)
 Hides a window. More...
 
EAPI void ecore_x_window_move (Ecore_X_Window win, int x, int y)
 Moves a window to the position x, y. More...
 
EAPI void ecore_x_window_resize (Ecore_X_Window win, int w, int h)
 Resizes a window. More...
 
EAPI void ecore_x_window_move_resize (Ecore_X_Window win, int x, int y, int w, int h)
 Moves and resizes a window. More...
 
EAPI void ecore_x_window_focus (Ecore_X_Window win)
 Sets the focus to the window win. More...
 
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. More...
 
EAPI Ecore_X_Window ecore_x_window_focus_get (void)
 gets the window that has focus. More...
 
EAPI void ecore_x_window_raise (Ecore_X_Window win)
 Raises the given window. More...
 
EAPI void ecore_x_window_lower (Ecore_X_Window win)
 Lowers the given window. More...
 
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. More...
 
EAPI void ecore_x_window_size_get (Ecore_X_Window win, int *w, int *h)
 Retrieves the size of the given window. More...
 
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. More...
 
EAPI int ecore_x_window_border_width_get (Ecore_X_Window win)
 Retrieves the width of the border of the given window. More...
 
EAPI void ecore_x_window_border_width_set (Ecore_X_Window win, int width)
 Sets the width of the border of the given window. More...
 
EAPI int ecore_x_window_depth_get (Ecore_X_Window win)
 Retrieves the depth of the given window. More...
 
EAPI void ecore_x_window_cursor_show (Ecore_X_Window win, Eina_Bool show)
 Show the cursor on a window of type Ecore_X_Window. More...
 
EAPI void ecore_x_window_defaults_set (Ecore_X_Window win)
 Sets the default properties for the given window. More...
 
EAPI int ecore_x_window_visible_get (Ecore_X_Window win)
 Finds out whether the given window is currently visible. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI Ecore_X_Window ecore_x_window_at_xy_get (int x, int y)
 Retrieves the top, visible window at the given location. More...
 
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. More...
 
EAPI Ecore_X_Window ecore_x_window_parent_get (Ecore_X_Window win)
 Retrieves the parent window of the given window. More...
 
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. More...
 
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)
 Set a property of Ecore_X_Window. More...
 
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)
 Get a property of Ecore_X_Window. More...
 
EAPI void ecore_x_window_prop_string_set (Ecore_X_Window win, Ecore_X_Atom type, const char *str)
 Set a window string property. More...
 
EAPI char * ecore_x_window_prop_string_get (Ecore_X_Window win, Ecore_X_Atom type)
 Get a window string property. More...
 
EAPI Ecore_X_WM_Protocol * ecore_x_window_prop_protocol_list_get (Ecore_X_Window win, int *num_ret)
 Get a array containing the protocols of win. More...
 
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. More...
 
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. More...
 
EAPI Ecore_X_Pixmap ecore_x_pixmap_new (Ecore_X_Window win, int w, int h, int dep)
 Creates a new pixmap. More...
 
EAPI void ecore_x_pixmap_free (Ecore_X_Pixmap pmap)
 Deletes the reference to the given pixmap. More...
 
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. More...
 
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. More...
 
EAPI int ecore_x_pixmap_depth_get (Ecore_X_Pixmap pmap)
 Retrieves the depth of the given pixmap. More...
 
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. More...
 
EAPI void ecore_x_gc_free (Ecore_X_GC gc)
 Deletes and frees the given graphics context. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI int ecore_x_drawable_border_width_get (Ecore_X_Drawable d)
 Retrieves the width of the border of the given drawable. More...
 
EAPI int ecore_x_drawable_depth_get (Ecore_X_Drawable d)
 Retrieves the depth of the given drawable. More...
 
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. More...
 
EAPI Ecore_X_Window * ecore_x_window_root_list (int *num_ret)
 Get a list of all the root windows on the server. More...
 
EAPI Ecore_X_Atom ecore_x_atom_get (const char *name)
 Retrieves the atom value associated to a name. More...
 
EAPI char * ecore_x_atom_name_get (Ecore_X_Atom atom)
 Retrieves the name of the given atom. More...
 
EAPI void ecore_x_icccm_protocol_atoms_set (Ecore_X_Window win, Ecore_X_Atom *protos, int num)
 Set protocol atoms explicitly. More...
 
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. More...
 
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. More...
 
EAPI void ecore_x_icccm_name_class_set (Ecore_X_Window win, const char *n, const char *c)
 Set a window name & class. More...
 
EAPI void ecore_x_icccm_name_class_get (Ecore_X_Window win, char **n, char **c)
 Get a window name & class. More...
 
EAPI char * ecore_x_icccm_client_machine_get (Ecore_X_Window win)
 Get a window client machine string. More...
 
EAPI void ecore_x_icccm_command_set (Ecore_X_Window win, int argc, char **argv)
 Sets the WM_COMMAND property for win. More...
 
EAPI void ecore_x_icccm_command_get (Ecore_X_Window win, int *argc, char ***argv)
 Get the WM_COMMAND property for win. More...
 
EAPI char * ecore_x_icccm_icon_name_get (Ecore_X_Window win)
 Get a window icon name. More...
 
EAPI void ecore_x_icccm_icon_name_set (Ecore_X_Window win, const char *t)
 Set a window icon name. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI void ecore_x_icccm_transient_for_unset (Ecore_X_Window win)
 Remove the transient_for setting from a window. More...
 
EAPI Ecore_X_Window ecore_x_icccm_transient_for_get (Ecore_X_Window win)
 Get the window this window is transient for, if any. More...
 
EAPI void ecore_x_icccm_window_role_set (Ecore_X_Window win, const char *role)
 Set the window role hint. More...
 
EAPI char * ecore_x_icccm_window_role_get (Ecore_X_Window win)
 Get the window role. More...
 
EAPI void ecore_x_icccm_client_leader_set (Ecore_X_Window win, Ecore_X_Window l)
 Set the window's client leader. More...
 
EAPI Ecore_X_Window ecore_x_icccm_client_leader_get (Ecore_X_Window win)
 Get the window's client leader. More...
 
EAPI void ecore_x_mwm_borderless_set (Ecore_X_Window win, Eina_Bool borderless)
 Sets the borderless flag of a window using MWM. More...
 
EAPI Eina_Bool ecore_x_screensaver_custom_blanking_disable (void)
 
EAPI void ecore_x_randr_screen_primary_output_current_size_get (Ecore_X_Window root, int *w, int *h, int *w_mm, int *h_mm, int *size_index)
 get the current set size of a given screen's primary output More...
 
EAPI void ecore_x_randr_events_select (Ecore_X_Window win, Eina_Bool on)
 enable event selection. More...
 
EAPI void ecore_x_randr_screen_reset (Ecore_X_Window root)
 removes unused screen space. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI Ecore_X_Randr_Output * ecore_x_randr_output_clones_get (Ecore_X_Window root, Ecore_X_Randr_Output output, int *num)
 Gets the outputs which might be used simultaneously on the same CRTC. More...
 
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 More...
 
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. More...
 
EAPI Eina_Bool ecore_x_randr_edid_has_valid_header (unsigned char *edid, unsigned long edid_length)
 Validates the header from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_info_has_valid_checksum (unsigned char *edid, unsigned long edid_length)
 Checks whether a display's EDID has a valid checksum. More...
 
EAPI int ecore_x_randr_edid_version_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded version from raw EDID data. More...
 
EAPI char * ecore_x_randr_edid_manufacturer_name_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded manufacturer from raw EDID data. More...
 
EAPI char * ecore_x_randr_edid_display_name_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded name from raw EDID data. More...
 
EAPI char * ecore_x_randr_edid_display_ascii_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded ASCII from raw EDID data. More...
 
EAPI char * ecore_x_randr_edid_display_serial_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded serial identifier from raw EDID data. More...
 
EAPI int ecore_x_randr_edid_model_get (unsigned char *edid, unsigned long edid_length)
 Get the encoded model number from raw EDID data. More...
 
EAPI int ecore_x_randr_edid_manufacturer_serial_number_get (unsigned char *edid, unsigned long edid_length)
 Get the manufacturer serial number from raw EDID data. More...
 
EAPI int ecore_x_randr_edid_manufacturer_model_get (unsigned char *edid, unsigned long edid_length)
 Get the manufacturer model number from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_dpms_available_get (unsigned char *edid, unsigned long edid_length)
 Looks up the DPMS support from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_dpms_standby_available_get (unsigned char *edid, unsigned long edid_length)
 Looks up the DPMS Standby support from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_dpms_suspend_available_get (unsigned char *edid, unsigned long edid_length)
 Looks up the DPMS Suspend support from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_dpms_off_available_get (unsigned char *edid, unsigned long edid_length)
 Looks up the DPMS Off support from raw EDID data. More...
 
EAPI
Ecore_X_Randr_Edid_Aspect_Ratio 
ecore_x_randr_edid_display_aspect_ratio_preferred_get (unsigned char *edid, unsigned long edid_length)
 Get the preferred aspect ratio from raw EDID data. More...
 
EAPI
Ecore_X_Randr_Edid_Aspect_Ratio 
ecore_x_randr_edid_display_aspect_ratios_get (unsigned char *edid, unsigned long edid_length)
 Get the supported aspect ratios from raw EDID data. More...
 
EAPI
Ecore_X_Randr_Edid_Display_Colorscheme 
ecore_x_randr_edid_display_colorscheme_get (unsigned char *edid, unsigned long edid_length)
 Get the supported colorschemes from raw EDID data. More...
 
EAPI Eina_Bool ecore_x_randr_edid_display_type_digital_get (unsigned char *edid, unsigned long edid_length)
 Get the display type from raw EDID data. More...
 
EAPI
Ecore_X_Randr_Edid_Display_Interface_Type 
ecore_x_randr_edid_display_interface_type_get (unsigned char *edid, unsigned long edid_length)
 Get the display interface type from raw EDID data. More...
 
EAPI void ecore_x_randr_screen_backlight_level_set (Ecore_X_Window root, double level)
 Set up the backlight level to the given level. More...
 
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. More...
 
EAPI Ecore_X_Region ecore_x_region_new (Ecore_X_Rectangle *rects, int num)
 Create a region from rectangles. More...
 
EAPI Ecore_X_Region ecore_x_region_new_from_bitmap (Ecore_X_Pixmap bitmap)
 Create a region from a pixmap. More...
 
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. More...
 
EAPI Ecore_X_Region ecore_x_region_new_from_gc (Ecore_X_GC gc)
 Create a region from a graphic context. More...
 
EAPI Ecore_X_Region ecore_x_region_new_from_picture (Ecore_X_Picture picture)
 Create a region from a picture. More...
 
EAPI void ecore_x_region_free (Ecore_X_Region region)
 Destroy a region. More...
 
EAPI void ecore_x_region_set (Ecore_X_Region region, Ecore_X_Rectangle *rects, int num)
 Set the content of a region. More...
 
EAPI void ecore_x_region_copy (Ecore_X_Region dest, Ecore_X_Region source)
 Copy the content of a region. More...
 
EAPI void ecore_x_region_combine (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the union of two regions. More...
 
EAPI void ecore_x_region_intersect (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the intersection of two regions. More...
 
EAPI void ecore_x_region_subtract (Ecore_X_Region dest, Ecore_X_Region source1, Ecore_X_Region source2)
 Make the subtraction of two regions. More...
 
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. More...
 
EAPI void ecore_x_region_translate (Ecore_X_Region region, int dx, int dy)
 Translate a region. More...
 
EAPI void ecore_x_region_extents (Ecore_X_Region dest, Ecore_X_Region source)
 Extent a region. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
EAPI Eina_Bool ecore_x_fixes_selection_notification_request (Ecore_X_Atom selection)
 xfixes selection notification request. More...
 
EAPI Eina_Bool ecore_x_composite_query (void)
 Return whether the Composite Extension is available. More...
 
EAPI Eina_Bool ecore_x_damage_query (void)
 
EAPI Ecore_X_Damage ecore_x_damage_new (Ecore_X_Drawable d, Ecore_X_Damage_Report_Level level)
 Create a damage object. More...
 
EAPI void ecore_x_damage_free (Ecore_X_Damage damage)
 Destroy a damage object. More...
 
EAPI void ecore_x_damage_subtract (Ecore_X_Damage damage, Ecore_X_Region repair, Ecore_X_Region parts)
 Synchronously modifies the region. More...
 
EAPI Eina_Bool ecore_x_dpms_query (void)
 Checks if the X DPMS extension is available on the server. More...
 
EAPI Eina_Bool ecore_x_dpms_capable_get (void)
 Checks if the X server is capable of DPMS. More...
 
EAPI Eina_Bool ecore_x_dpms_enabled_get (void)
 Checks the DPMS state of the display. More...
 
EAPI void ecore_x_dpms_enabled_set (int enabled)
 Sets the DPMS state of the display. More...
 
EAPI void ecore_x_dpms_timeouts_get (unsigned int *standby, unsigned int *suspend, unsigned int *off)
 Gets the timeouts. More...
 
EAPI Eina_Bool ecore_x_dpms_timeouts_set (unsigned int standby, unsigned int suspend, unsigned int off)
 Sets the timeouts. More...
 
EAPI unsigned int ecore_x_dpms_timeout_standby_get (void)
 Returns the amount of time of inactivity before standby mode is invoked. More...
 
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. More...
 
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. More...
 
EAPI void ecore_x_dpms_timeout_standby_set (unsigned int new_timeout)
 Sets the standby timeout (in unit of seconds). More...
 
EAPI void ecore_x_dpms_timeout_suspend_set (unsigned int new_timeout)
 Sets the suspend timeout (in unit of seconds). More...
 
EAPI void ecore_x_dpms_timeout_off_set (unsigned int new_timeout)
 Sets the off timeout (in unit of seconds). More...
 
EAPI int ecore_x_keysym_keycode_get (const char *keyname)
 Given a keyname, return the keycode representing that key. More...
 

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. More...
 
EAPI int ECORE_X_EVENT_XKB_NEWKBD_NOTIFY
 
EAPI int ECORE_X_EVENT_GENERIC
 
EAPI int ECORE_X_MODIFIER_SHIFT
 
EAPI int ECORE_X_MODIFIER_CTRL
 
EAPI int ECORE_X_MODIFIER_ALT
 
EAPI int ECORE_X_MODIFIER_WIN
 
EAPI int ECORE_X_MODIFIER_ALTGR
 

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:

Typedef Documentation

Enumeration Type Documentation

Defines the error codes of Ecore_X which wraps the X Window Systems protocol's errors.

Since
1.7.0
Enumerator
ECORE_X_ERROR_CODE_SUCCESS 

Everything is okay.

ECORE_X_ERROR_CODE_BAD_REQUEST 

Bad request code.

ECORE_X_ERROR_CODE_BAD_VALUE 

Int parameter out of range.

ECORE_X_ERROR_CODE_BAD_WINDOW 

Parameter not a Window.

ECORE_X_ERROR_CODE_BAD_PIXMAP 

Parameter not a Pixmap.

ECORE_X_ERROR_CODE_BAD_ATOM 

Parameter not an Atom.

ECORE_X_ERROR_CODE_BAD_CURSOR 

Parameter not a Cursor.

ECORE_X_ERROR_CODE_BAD_FONT 

Parameter not a Font.

ECORE_X_ERROR_CODE_BAD_MATCH 

Parameter mismatch.

ECORE_X_ERROR_CODE_BAD_DRAWABLE 

Parameter not a Pixmap or Window.

ECORE_X_ERROR_CODE_BAD_ACCESS 

Bad access.

ECORE_X_ERROR_CODE_BAD_ALLOC 

Insufficient resources.

ECORE_X_ERROR_CODE_BAD_COLOR 

No such colormap.

ECORE_X_ERROR_CODE_BAD_GC 

Parameter not a GC.

ECORE_X_ERROR_CODE_BAD_ID_CHOICE 

Choice not in range or already used.

ECORE_X_ERROR_CODE_BAD_NAME 

Font or color name doesn't exist.

ECORE_X_ERROR_CODE_BAD_LENGTH 

Request length incorrect.

ECORE_X_ERROR_CODE_BAD_IMPLEMENTATION 

Server is defective.

Enumerator
ECORE_X_WINDOW_INPUT_MODE_NONE 

The window can never be focused.

ECORE_X_WINDOW_INPUT_MODE_PASSIVE 

The window can be focused by the WM but doesn't focus itself.

ECORE_X_WINDOW_INPUT_MODE_ACTIVE_LOCAL 

The window sets the focus itself if one of its sub-windows already is focused.

ECORE_X_WINDOW_INPUT_MODE_ACTIVE_GLOBAL 

The window sets the focus itself even if another window is currently focused.

Defines the different states of the window of Ecore_X.

Enumerator
ECORE_X_WINDOW_STATE_MODAL 

The window is iconified.

ECORE_X_WINDOW_STATE_STICKY 

The window is a modal dialog box.

ECORE_X_WINDOW_STATE_MAXIMIZED_VERT 

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

ECORE_X_WINDOW_STATE_MAXIMIZED_HORZ 

The window has the maximum vertical size.

ECORE_X_WINDOW_STATE_SHADED 

The window has the maximum horizontal size.

ECORE_X_WINDOW_STATE_SKIP_TASKBAR 

The window is shaded.

ECORE_X_WINDOW_STATE_SKIP_PAGER 

The window should not be included in the taskbar.

ECORE_X_WINDOW_STATE_HIDDEN 

The window should not be included in the pager.

ECORE_X_WINDOW_STATE_FULLSCREEN 

The window is invisible (i.e.

minimized/iconified)

ECORE_X_WINDOW_STATE_ABOVE 

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

Defines the different state hint of the window of Ecore_X.

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.

Enumerator
ECORE_X_WM_PROTOCOL_DELETE_REQUEST 

If enabled the window manager will be asked to send a delete message instead of just closing (destroying) the window.

ECORE_X_WM_PROTOCOL_TAKE_FOCUS 

If enabled the window manager will be told that the window explicitly sets input focus.

ECORE_X_NET_WM_PROTOCOL_PING 

If enabled the window manager can ping the window to check if it is alive.

ECORE_X_NET_WM_PROTOCOL_SYNC_REQUEST 

If enabled the window manager can sync updating with the window (?)

ECORE_X_WM_PROTOCOL_NUM 

Number of defined items.

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.
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.
maskThe mask of the message to be sent.
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.
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 Eina_Bool ecore_x_damage_query ( void  )
Since
1.7

References ecore_x_damage_query().

Referenced by ecore_x_damage_query().

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 account for multihead or xinerama and xrander where different parts of the screen may have different 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(), and ECORE_X_WM_PROTOCOL_NUM.

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(), and ECORE_X_WM_PROTOCOL_NUM.

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.

Parameters
keynameThe key from which to get the keycode.
Returns
The keycode of the 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, EINA_FALSE otherwise.
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, EINA_FALSE otherwise.

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
rootThe window on which CRTC's position will be set.
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.
Parameters
rootThe root window which's default display will be set.
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 coordinate will be assumed.
yNew y coordinate. If <0 (e.g. Ecore_X_Randr_Unset) the current y coordinate 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, EINA_FALSE otherwise.

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, EINA_FALSE otherwise.

References ecore_x_randr_crtc_settings_set().

Referenced by ecore_x_randr_crtc_mode_set(), and ecore_x_randr_crtc_settings_set().

EAPI char* ecore_x_randr_edid_display_ascii_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the encoded ASCII from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded ASCII display identifier.

References ecore_x_randr_edid_display_ascii_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_ascii_get().

EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect_ratio_preferred_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the preferred aspect ratio from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The preferred aspect ratio.

References ecore_x_randr_edid_display_aspect_ratio_preferred_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_aspect_ratio_preferred_get().

EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect_ratios_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the supported aspect ratios from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The supported aspect ratios.

References ecore_x_randr_edid_display_aspect_ratios_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_aspect_ratios_get().

EAPI Ecore_X_Randr_Edid_Display_Colorscheme ecore_x_randr_edid_display_colorscheme_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the supported colorschemes from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The supported colorschemes.

References ecore_x_randr_edid_display_colorscheme_get(), ecore_x_randr_edid_display_type_digital_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_colorscheme_get().

EAPI Ecore_X_Randr_Edid_Display_Interface_Type ecore_x_randr_edid_display_interface_type_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the display interface type from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The interface type.

References ecore_x_randr_edid_display_interface_type_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_interface_type_get().

EAPI char* ecore_x_randr_edid_display_name_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the encoded name from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded manufacturer identifier.

References ecore_x_randr_edid_display_name_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_name_get().

EAPI char* ecore_x_randr_edid_display_serial_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the encoded serial identifier from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded serial identifier.

References ecore_x_randr_edid_display_serial_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_serial_get().

EAPI Eina_Bool ecore_x_randr_edid_display_type_digital_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the display type from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if the display is a digital one, EINA_FALSE otherwise.

References ecore_x_randr_edid_display_type_digital_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_display_colorscheme_get(), and ecore_x_randr_edid_display_type_digital_get().

EAPI Eina_Bool ecore_x_randr_edid_dpms_available_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Looks up the DPMS support from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if DPMS is supported in some way, EINA_FALSE otherwise.

References ecore_x_randr_edid_dpms_available_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_dpms_available_get().

EAPI Eina_Bool ecore_x_randr_edid_dpms_off_available_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Looks up the DPMS Off support from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if DPMS Off is supported, EINA_FALSE otherwise.

References ecore_x_randr_edid_dpms_off_available_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_dpms_off_available_get().

EAPI Eina_Bool ecore_x_randr_edid_dpms_standby_available_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Looks up the DPMS Standby support from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if DPMS Standby is supported, EINA_FALSE otherwise.

References ecore_x_randr_edid_dpms_standby_available_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_dpms_standby_available_get().

EAPI Eina_Bool ecore_x_randr_edid_dpms_suspend_available_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Looks up the DPMS Suspend support from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if DPMS Suspend is supported, EINA_FALSE otherwise.

References ecore_x_randr_edid_dpms_suspend_available_get(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_dpms_suspend_available_get().

EAPI Eina_Bool ecore_x_randr_edid_has_valid_header ( unsigned char *  edid,
unsigned long  edid_length 
)

Validates the header from raw EDID data.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if the header is valid, EINA_FALSE otherwise.

References ecore_x_randr_edid_has_valid_header().

Referenced by ecore_x_randr_edid_has_valid_header(), ecore_x_randr_edid_manufacturer_model_get(), ecore_x_randr_edid_manufacturer_name_get(), ecore_x_randr_edid_manufacturer_serial_number_get(), and ecore_x_randr_edid_version_get().

EAPI Eina_Bool ecore_x_randr_edid_info_has_valid_checksum ( unsigned char *  edid,
unsigned long  edid_length 
)

Checks whether a display's EDID has a valid checksum.

Parameters
edidThe edid structure.
edid_lengthLength of the edid structure.
Returns
EINA_TRUE, if the checksum is valid, EINA_FALSE otherwise.

References ecore_x_randr_edid_info_has_valid_checksum(), and ecore_x_randr_edid_version_get().

Referenced by ecore_x_randr_edid_info_has_valid_checksum().

EAPI int ecore_x_randr_edid_manufacturer_model_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the manufacturer model number from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The manufacturer's model number.

References ecore_x_randr_edid_has_valid_header(), and ecore_x_randr_edid_manufacturer_model_get().

Referenced by ecore_x_randr_edid_manufacturer_model_get().

EAPI char* ecore_x_randr_edid_manufacturer_name_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the encoded manufacturer from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded manufacturer identifier.

References ecore_x_randr_edid_has_valid_header(), and ecore_x_randr_edid_manufacturer_name_get().

Referenced by ecore_x_randr_edid_manufacturer_name_get().

EAPI int ecore_x_randr_edid_manufacturer_serial_number_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the manufacturer serial number from raw EDID data.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded serial manufacturer serial number.

References ecore_x_randr_edid_has_valid_header(), and ecore_x_randr_edid_manufacturer_serial_number_get().

Referenced by ecore_x_randr_edid_manufacturer_serial_number_get().

EAPI int ecore_x_randr_edid_model_get ( unsigned char *  edid,
unsigned long  edid_length 
)

Get the encoded model number from raw EDID data.

The manufacturer ID table is necessary for a useful description.

Parameters
edidthe edid structure
edid_lengthlength of the edid structure
Returns
The encoded model number.
EAPI int ecore_x_randr_edid_version_get ( unsigned char *  edid,
unsigned long  edid_length 
)
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

enable event selection.

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

Parameters
winSelect this window's properties for RandR 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
rootWindow which's screen's ressources are queried.
modeThe mode which's size is to be looked up.
wWidth of given mode in px.
hHeight of given mode in px.

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 outputs which might be used simultaneously on the same CRTC.

Parameters
rootWindow that this information should be queried for.
outputThe output which's clones we concern.
numNumber of possible clones.
Returns
The existing outputs, NULL otherwise.

Gets the outputs which might be used simultaneously 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.
Returns
EDID information of the output.

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
outputThe output name given to be reported.
lenlength of returned c-string.
Returns
name of the output as reported by X
Parameters
rootthe window which's screen will be queried
outputThe output for which the name will be reported.
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_primary_output_current_size_get ( Ecore_X_Window  root,
int *  w,
int *  h,
int *  w_mm,
int *  h_mm,
int *  size_index 
)

get the current set size of a given screen's primary output

Parameters
rootwindow which's primary output will be queried
wthe current size's width
hthe current size's height
w_mmthe current size's width in mm
h_mmthe current size's height in mm
size_indexof current set size to be used with ecore_x_randr_primary_output_size_set()

References ecore_x_randr_screen_primary_output_current_size_get().

Referenced by ecore_x_randr_screen_primary_output_current_size_get().

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_screensaver_custom_blanking_disable ( void  )
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 
)

Show the cursor on a window of type Ecore_X_Window.

Parameters
winThe window for which the cursor will be showed.
showEnables the show of the cursor on the window if equals EINA_TRUE, disables if equals EINA_FALSE.

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

Get a property of Ecore_X_Window.

Note
If there aren't any data to be got the function return NULL. If the function can't allocate the memory then 0 is returned.
Parameters
winThe window for which the property will be got.
propertyThe property of the window that will be gotten.
typeThe type of the property that will be gotten.
sizeThis parameter isn't in use.
dataThe data of the property that will be gotten.
numThe size of property.
Returns
size_ret The size of array that contains the property.

References ecore_x_window_prop_property_get().

Referenced by ecore_x_icccm_colormap_window_set(), ecore_x_icccm_colormap_window_unset(), and ecore_x_window_prop_property_get().

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 
)

Set a property of Ecore_X_Window.

Parameters
winThe window for which the property will be set.
propertyThe property of the window to be set.
typeThe type of the property that will be set.
sizeThe size of the property that will be set.
dataThe data of the property that will be set.
numberThe size of data.

References ecore_x_window_prop_property_set().

Referenced by ecore_x_icccm_colormap_window_set(), ecore_x_icccm_colormap_window_unset(), ecore_x_mwm_borderless_set(), and ecore_x_window_prop_property_set().

EAPI Ecore_X_WM_Protocol* ecore_x_window_prop_protocol_list_get ( Ecore_X_Window  win,
int *  num_ret 
)

Get a array containing the protocols of win.

Note
If there aren't any properties to be counted or any protocols to get then the function returns NULL.
Parameters
winThe window for which protocol list will be got.
num_retContains the number of elements of the array to be returned.
Returns
The array that contains the protocols.

References ecore_x_window_prop_protocol_list_get(), and ECORE_X_WM_PROTOCOL_NUM.

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
Returns
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

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.

Warning
avoid using it.

Referenced by ecore_x_init().

EAPI int ECORE_X_EVENT_GENERIC
Since
1.7

Referenced by ecore_x_init().

EAPI int ECORE_X_EVENT_XKB_NEWKBD_NOTIFY
Since
1.7

Referenced by ecore_x_init().

EAPI int ECORE_X_MODIFIER_ALT
Since
1.7
EAPI int ECORE_X_MODIFIER_ALTGR
Since
1.7
EAPI int ECORE_X_MODIFIER_CTRL
Since
1.7
EAPI int ECORE_X_MODIFIER_SHIFT
Since
1.7
EAPI int ECORE_X_MODIFIER_WIN
Since
1.7