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_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
}
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
}

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 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 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 int 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 int ecore_x_selection_primary_clear (void)
 Release ownership of the primary selection.
EAPI int 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 int ecore_x_selection_secondary_clear (void)
 Release ownership of the secondary selection.
EAPI int 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 int ecore_x_selection_xdnd_clear (void)
 Release ownership of the XDND selection.
EAPI int 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 int ecore_x_selection_clipboard_clear (void)
 Release ownership of the clipboard selection.
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_del (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 focus to the window win.
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, int 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_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 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_del (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)
 Creates a new default graphics context associated with the given drawable.
EAPI void ecore_x_gc_del (Ecore_X_GC gc)
 Deletes and frees the given graphics context.
EAPI int 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 int 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 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 with the given name.
EAPI void ecore_x_icccm_protocol_set (Ecore_X_Window win, Ecore_X_WM_Protocol protocol, int on)
 Set or unset a wm protocol property.
EAPI int 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 int ecore_x_dpms_query (void)
 Checks if the X DPMS extension is available on the server.
EAPI int ecore_x_dpms_capable_get (void)
 Checks if the X server is capable of DPMS.
EAPI int 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 int 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 ()
 Returns the amount of time of inactivity before standby mode is invoked.
EAPI unsigned int ecore_x_dpms_timeout_suspend_get ()
 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 ()
 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).


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

enum _Ecore_X_Window_Input_Mode

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.

enum _Ecore_X_Window_State

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.

enum _Ecore_X_Window_State_Hint

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.

enum _Ecore_X_WM_Protocol

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 (?).


Function Documentation

EAPI Ecore_X_Atom ecore_x_atom_get ( const char *  name  ) 

Retrieves the atom value associated with the given name.

Parameters:
name The given name.
Returns:
Associated atom value.

EAPI int 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:
win The window the message is sent to.
type The client message type.
d0 The client message data item 1
d1 The client message data item 2
d2 The client message data item 3
d3 The client message data item 4
d4 The client message data item 5
Returns:
!0 on success.

EAPI int 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:
win The window the message is sent to.
type The client message type.
data Data to be sent.
len Number of data bytes, max 20.
Returns:
!0 on success.

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

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

Set the error handler.

Parameters:
func The error handler function
data The data to be passed to the handler function
Set the X error handler function

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

EAPI void ecore_x_gc_del ( Ecore_X_GC  gc  ) 

Deletes and frees the given graphics context.

Parameters:
gc The given graphics context.

EAPI Ecore_X_GC ecore_x_gc_new ( Ecore_X_Drawable  draw  ) 

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

Parameters:
draw Drawable to create graphics context with. If 0 is given instead, the default root window is used.
Returns:
The new default graphics context.

EAPI Ecore_X_Window ecore_x_icccm_client_leader_get ( Ecore_X_Window  win  ) 

Get the window's client leader.

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

EAPI void ecore_x_icccm_client_leader_set ( Ecore_X_Window  win,
Ecore_X_Window  l 
)

Set the window's client leader.

Parameters:
win The window
l The 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.

EAPI char* ecore_x_icccm_client_machine_get ( Ecore_X_Window  win  ) 

Get a window client machine string.

Parameters:
win The window
Returns:
The windows client machine string
Return the client machine of a window. String must be free'd when done with.

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:
win The toplevel window
subwin The subwindow to be added to the colormap windows list

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:
win The toplevel window
subwin The window to be removed from the colormap window list.

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:
win The window.
argc Number of arguments.
argv Arguments.

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

Sets the WM_COMMAND property for win.

Parameters:
win The window.
argc Number of arguments.
argv Arguments.

EAPI char* ecore_x_icccm_icon_name_get ( Ecore_X_Window  win  ) 

Get a window icon name.

Parameters:
win The window
Returns:
The windows icon name string
Return the icon name of a window. String must be free'd when done with.

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

Set a window icon name.

Parameters:
win The window
t The icon name string
Set a window icon name

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

Get a window name & class.

Parameters:
win The window
n The name string
c The class string
Get a window name * class

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

Set a window name & class.

Parameters:
win The window
n The name string
c The class string
Set a window name * class

EAPI int ecore_x_icccm_protocol_isset ( Ecore_X_Window  win,
Ecore_X_WM_Protocol  protocol 
)

Determines whether a protocol is set for a window.

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

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

Set or unset a wm protocol property.

Parameters:
win The Window
protocol The protocol to enable/disable
on On/Off

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:
win The window to check
Returns:
The window ID of the top-level window, or 0 if the property does not exist.

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:
win the transient window
forwin the toplevel window

EAPI void ecore_x_icccm_transient_for_unset ( Ecore_X_Window  win  ) 

Remove the transient_for setting from a window.

Parameters:
The window

EAPI char* ecore_x_icccm_window_role_get ( Ecore_X_Window  win  ) 

Get the window role.

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

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

Set the window role hint.

Parameters:
win The window
role The role string

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

Set the I/O error handler.

Parameters:
func The I/O error handler function
data The data to be passed to the handler function
Set the X I/O error handler function

EAPI void ecore_x_kill ( Ecore_X_Window  win  ) 

Kill a specific client.

You can kill a specific client woning window win

Parameters:
win Window of the client to be killed

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:
root The window whose children will be killed.

EAPI int 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.

EAPI int 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:
w The window to which this selection belongs
data The data associated with the selection
size The 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.

EAPI int 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.

EAPI int 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:
w The window to which this selection belongs
data The data associated with the selection
size The size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

EAPI int 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.

EAPI int 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:
w The window to which this selection belongs
data The data associated with the selection
size The size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

EAPI int 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.

EAPI int 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:
w The window to which this selection belongs
data The data associated with the selection
size The size of the data buffer in bytes
Returns:
Returns 1 if the ownership of the selection was successfully claimed, or 0 if unsuccessful.

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:
win The given window
color The color to set to (i.e. 0xff0000)

EAPI void ecore_x_window_cursor_show ( Ecore_X_Window  win,
int  show 
)

To be documented.

FIXME: To be fixed.

EAPI void ecore_x_window_defaults_set ( Ecore_X_Window  win  ) 

Sets the default properties for the given window.

The default properties set for the window are WM_CLIENT_MACHINE and _NET_WM_PID.

Parameters:
win The given window.

EAPI int ecore_x_window_depth_get ( Ecore_X_Window  win  ) 

Retrieves the depth of the given window.

Parameters:
win The given window.
Returns:
Depth of the window.

EAPI void ecore_x_window_hide ( Ecore_X_Window  win  ) 

Hides a window.

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

Parameters:
win The window to hide.

EAPI Ecore_X_Window* ecore_x_window_ignore_list ( int *  num  ) 

Get the ignore list.

Parameters:
num number of windows in the list
Returns:
list of windows to ignore

EAPI void ecore_x_window_ignore_set ( Ecore_X_Window  win,
int  ignore 
)

Set if a window should be ignored.

Parameters:
win The given window.
ignore if to ignore

EAPI Ecore_X_Atom ecore_x_window_prop_any_type ( void   ) 

To be documented.

FIXME: To be fixed.

EAPI int ecore_x_window_prop_property_get ( Ecore_X_Window  win,
Ecore_X_Atom  property,
Ecore_X_Atom  type,
int size  __UNUSED__,
unsigned char **  data,
int *  num 
)

To be documented.

FIXME: To be fixed.

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 
)

To be documented.

FIXME: To be fixed.

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.

EAPI char* ecore_x_window_prop_string_get ( Ecore_X_Window  win,
Ecore_X_Atom  type 
)

Get a window string property.

Parameters:
win The window
type The property
Return window string property of a window. String must be free'd when done.

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:
win The window
type The property
str The string
Set a window string property

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_ret Pointer 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.

EAPI void ecore_x_window_show ( Ecore_X_Window  win  ) 

Shows a window.

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

Parameters:
win The window to show.

EAPI int ecore_x_window_visible_get ( Ecore_X_Window  win  ) 

Finds out whether the given window is currently visible.

Parameters:
win The given window.
Returns:
1 if the window is visible, otherwise 0.