ICCCM related functions.

Functions related to ICCCM. More...

Functions

EAPI void ecore_x_icccm_state_set (Ecore_X_Window window, Ecore_X_Window_State_Hint state)
 Sets the state of a window.
EAPI Ecore_X_Window_State_Hint ecore_x_icccm_state_get (Ecore_X_Window window)
 Gets the state of a window.
EAPI void ecore_x_icccm_delete_window_send (Ecore_X_Window window, Ecore_X_Time time)
 Sends the ClientMessage event with the DeleteWindow property.
EAPI void ecore_x_icccm_take_focus_send (Ecore_X_Window window, Ecore_X_Time time)
 Sends the ClientMessage event with the TakeFocus property.
EAPI void ecore_x_icccm_save_yourself_send (Ecore_X_Window window, Ecore_X_Time time)
 Sends the ClientMessage event with the SaveYourself property.
EAPI void ecore_x_icccm_move_resize_send (Ecore_X_Window window, int x, int y, int width, int height)
 Sends the ConfigureNotify event with the StructureNotify property.
EAPI void ecore_x_icccm_hints_set (Ecore_X_Window window, Eina_Bool accepts_focus, Ecore_X_Window_State_Hint initial_state, Ecore_X_Pixmap icon_pixmap, Ecore_X_Pixmap icon_mask, Ecore_X_Window icon_window, Ecore_X_Window window_group, Eina_Bool is_urgent)
 Sets the hints of a window.
EAPI Eina_Bool ecore_x_icccm_hints_get (Ecore_X_Window window, Eina_Bool *accepts_focus, Ecore_X_Window_State_Hint *initial_state, Ecore_X_Pixmap *icon_pixmap, Ecore_X_Pixmap *icon_mask, Ecore_X_Window *icon_window, Ecore_X_Window *window_group, Eina_Bool *is_urgent)
 Gets the hints of a window.
EAPI void ecore_x_icccm_size_pos_hints_set (Ecore_X_Window window, Eina_Bool request_pos, Ecore_X_Gravity gravity, int min_w, int min_h, int max_w, int max_h, int base_w, int base_h, int step_x, int step_y, double min_aspect, double max_aspect)
 Sets the hints of a window.
EAPI Eina_Bool ecore_x_icccm_size_pos_hints_get (Ecore_X_Window window, Eina_Bool *request_pos, Ecore_X_Gravity *gravity, int *min_w, int *min_h, int *max_w, int *max_h, int *base_w, int *base_h, int *step_x, int *step_y, double *min_aspect, double *max_aspect)
 Gets the hints of a window.
EAPI void ecore_x_icccm_title_set (Ecore_X_Window window, const char *title)
 Set the title of a window.
EAPI char * ecore_x_icccm_title_get (Ecore_X_Window window)
 Gets the title of a window.
EAPI void ecore_x_icccm_protocol_set (Ecore_X_Window window, Ecore_X_WM_Protocol protocol, Eina_Bool on)
 Set or unset a wm protocol property.
EAPI Eina_Bool ecore_x_icccm_protocol_isset (Ecore_X_Window window, 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 window, const char *name, const char *class)
 Set a window name & class.
EAPI void ecore_x_icccm_name_class_get (Ecore_X_Window window, char **name, char **class)
 Get a window name and class.
EAPI char * ecore_x_icccm_client_machine_get (Ecore_X_Window window)
 Get a window client machine string.
EAPI void ecore_x_icccm_command_set (Ecore_X_Window window, int argc, char **argv)
 Sets the WM_COMMAND property for win.
EAPI void ecore_x_icccm_command_get (Ecore_X_Window window, int *argc, char ***argv)
 Get the WM_COMMAND property for a window.
EAPI void ecore_x_icccm_icon_name_set (Ecore_X_Window window, const char *title)
 Set a window icon name.
EAPI char * ecore_x_icccm_icon_name_get (Ecore_X_Window window)
 Get a window icon name.
EAPI void ecore_x_icccm_colormap_window_set (Ecore_X_Window window, Ecore_X_Window sub_window)
 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 window, Ecore_X_Window sub_window)
 Remove a window from the list of colormap windows.
EAPI void ecore_x_icccm_transient_for_set (Ecore_X_Window window, Ecore_X_Window forwindow)
 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 window)
 Remove the transient_for setting from a window.
EAPI Ecore_X_Window ecore_x_icccm_transient_for_get (Ecore_X_Window window)
 Get the window this window is transient for, if any.
EAPI void ecore_x_icccm_window_role_set (Ecore_X_Window window, const char *role)
 Set the window role hint.
EAPI void ecore_x_icccm_window_role_get_prefetch (Ecore_X_Window window)
 Sends the GetProperty request.
EAPI void ecore_x_icccm_window_role_get_fetch (void)
 Gets the reply of the GetProperty request sent by ecore_x_icccm_window_role_get_prefetch().
EAPI char * ecore_x_icccm_window_role_get (Ecore_X_Window window)
 Get the window role.
EAPI void ecore_x_icccm_client_leader_set (Ecore_X_Window window, Ecore_X_Window leader)
 Set the window's client leader.
EAPI void ecore_x_icccm_client_leader_get_prefetch (Ecore_X_Window window)
 Sends the GetProperty request.
EAPI void ecore_x_icccm_client_leader_get_fetch (void)
 Gets the reply of the GetProperty request sent by ecore_x_icccm_client_leader_get_prefetch().
EAPI Ecore_X_Window ecore_x_icccm_client_leader_get (Ecore_X_Window window)
 Get the window's client leader.
EAPI void ecore_x_icccm_iconic_request_send (Ecore_X_Window window, Ecore_X_Window root)
 Send the ClientMessage event with the ChangeState property.

Detailed Description

Functions related to ICCCM.


Function Documentation

EAPI Ecore_X_Window ecore_x_icccm_client_leader_get ( Ecore_X_Window  window)

Get the window's client leader.

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

To use this function, you must call before, and in order, ecore_x_icccm_client_leader_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_client_leader_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_client_leader_get_prefetch ( Ecore_X_Window  window)

Sends the GetProperty request.

Parameters:
windowWindow whose properties are requested.
EAPI void ecore_x_icccm_client_leader_set ( Ecore_X_Window  window,
Ecore_X_Window  leader 
)

Set the window's client leader.

Parameters:
windowThe window
leaderThe 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  window)

Get a window client machine string.

Parameters:
windowThe window
Returns:
The windows client machine string

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

To use this function, you must call before, and in order, ecore_x_icccm_client_machine_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_client_machine_get_fetch(), which gets the reply.

References ecore_x_window_prop_string_get().

EAPI void ecore_x_icccm_colormap_window_set ( Ecore_X_Window  window,
Ecore_X_Window  sub_window 
)

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

Parameters:
windowThe toplevel window
sub_windowThe subwindow to be added to the colormap windows list

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

To use this function, you must call before, and in order, ecore_x_icccm_colormap_window_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_colormap_window_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_colormap_window_unset ( Ecore_X_Window  window,
Ecore_X_Window  sub_window 
)

Remove a window from the list of colormap windows.

Parameters:
windowThe toplevel window
sub_windowThe window to be removed from the colormap window list.

Remove sub_window from the list of colormap windows.

To use this function, you must call before, and in order, ecore_x_icccm_colormap_window_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_colormap_window_get_fetch(), which gets the reply.

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

Get the WM_COMMAND property for a window.

Parameters:
winThe window.
argcNumber of arguments.
argvArguments.

Return the command of window and store it in argv. argc contains the number of arguments. String must be free'd when done with.

To use this function, you must call before, and in order, ecore_x_icccm_command_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_command_get_fetch(), which gets the reply.

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

Sets the WM_COMMAND property for win.

Parameters:
windowThe window.
argcNumber of arguments.
argvArguments.
EAPI void ecore_x_icccm_delete_window_send ( Ecore_X_Window  window,
Ecore_X_Time  time 
)

Sends the ClientMessage event with the DeleteWindow property.

Parameters:
windowThe window.
timeThe time.

References ecore_x_client_message32_send().

EAPI Eina_Bool ecore_x_icccm_hints_get ( Ecore_X_Window  window,
Eina_Bool *  accepts_focus,
Ecore_X_Window_State_Hint *  initial_state,
Ecore_X_Pixmap *  icon_pixmap,
Ecore_X_Pixmap *  icon_mask,
Ecore_X_Window *  icon_window,
Ecore_X_Window *  window_group,
Eina_Bool *  is_urgent 
)

Gets the hints of a window.

Parameters:
windowThe window.
accepts_focusAcceptFocus hint
initial_stateInitial state flags.
icon_pixmapIcon pixmap.
icon_maskIcon mask.
icon_windowIcon window.
window_groupGroup window.
is_urgentIsUrgent flag.
Returns:
1 on success, 0 otherwise.

To use this function, you must call before, and in order, ecore_x_icccm_hints_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_hints_get_fetch(), which gets the reply.

References ECORE_X_WINDOW_STATE_HINT_ICONIC, ECORE_X_WINDOW_STATE_HINT_NORMAL, and ECORE_X_WINDOW_STATE_HINT_WITHDRAWN.

EAPI void ecore_x_icccm_hints_set ( Ecore_X_Window  window,
Eina_Bool  accepts_focus,
Ecore_X_Window_State_Hint  initial_state,
Ecore_X_Pixmap  icon_pixmap,
Ecore_X_Pixmap  icon_mask,
Ecore_X_Window  icon_window,
Ecore_X_Window  window_group,
Eina_Bool  is_urgent 
)

Sets the hints of a window.

Parameters:
windowThe window.
accepts_focusAcceptFocus hint
initial_stateInitial state flags.
icon_pixmapIcon pixmap.
icon_maskIcon mask.
icon_windowIcon window.
window_groupGroup window.
is_urgentIsUrgent flag.

References ECORE_X_WINDOW_STATE_HINT_ICONIC, ECORE_X_WINDOW_STATE_HINT_NORMAL, and ECORE_X_WINDOW_STATE_HINT_WITHDRAWN.

EAPI char* ecore_x_icccm_icon_name_get ( Ecore_X_Window  window)

Get a window icon name.

Parameters:
windowThe window.
Returns:
The windows icon name string.

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

To use this function, you must call before, and in order, ecore_x_icccm_icon_name_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_icon_name_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_icon_name_set ( Ecore_X_Window  window,
const char *  title 
)

Set a window icon name.

Parameters:
windowThe window.
titleThe icon name string.

Set window icon name.

EAPI void ecore_x_icccm_iconic_request_send ( Ecore_X_Window  window,
Ecore_X_Window  root 
)

Send the ClientMessage event with the ChangeState property.

Parameters:
windowThe window.
rootThe root window.
EAPI void ecore_x_icccm_move_resize_send ( Ecore_X_Window  window,
int  x,
int  y,
int  width,
int  height 
)

Sends the ConfigureNotify event with the StructureNotify property.

Parameters:
windowThe window.
xThe X coordinate.
yThe Y coordinate.
widthThe width.
heightThe height.
EAPI void ecore_x_icccm_name_class_get ( Ecore_X_Window  window,
char **  name,
char **  class 
)

Get a window name and class.

Parameters:
windowThe window (Unused).
nameThe name string.
classThe class string.

Store the name and class of window into respectively name and class.

To use this function, you must call before, and in order, ecore_x_icccm_name_class_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_name_class_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_name_class_set ( Ecore_X_Window  window,
const char *  name,
const char *  class 
)

Set a window name & class.

Parameters:
windowThe window
nameThe name string
classThe class string

Set the name and class of window to respectively name and class.

EAPI Eina_Bool ecore_x_icccm_protocol_isset ( Ecore_X_Window  window,
Ecore_X_WM_Protocol  protocol 
)

Determines whether a protocol is set for a window.

Parameters:
windowThe Window (Unused).
protocolThe protocol to query.
Returns:
1 if the protocol is set, else 0.

To use this function, you must call before, and in order, ecore_x_icccm_protocol_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_protocol_get_fetch(), which gets the reply.

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

Set or unset a wm protocol property.

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

To use this function, you must call before, and in order, ecore_x_icccm_protocol_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_protocol_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_save_yourself_send ( Ecore_X_Window  window,
Ecore_X_Time  time 
)

Sends the ClientMessage event with the SaveYourself property.

Parameters:
windowThe window.
timeThe time.

References ecore_x_client_message32_send().

EAPI Eina_Bool ecore_x_icccm_size_pos_hints_get ( Ecore_X_Window  window,
Eina_Bool *  request_pos,
Ecore_X_Gravity *  gravity,
int *  min_w,
int *  min_h,
int *  max_w,
int *  max_h,
int *  base_w,
int *  base_h,
int *  step_x,
int *  step_y,
double *  min_aspect,
double *  max_aspect 
)

Gets the hints of a window.

Parameters:
windowThe window.
request_posRequest position flag.
gravityGravity.
min_wMinimum width.
min_hMinimum height.
max_wMaximum width.
max_hMaximum height.
base_wBase width
base_hBase height
step_xX step coordinate.
step_yY step coordinate.
min_aspectMinimum aspect ratio.
max_aspectM
Returns:
1 on success, 0 otherwise.

To use this function, you must call before, and in order, ecore_x_icccm_size_pos_hints_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_size_pos_hints_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_size_pos_hints_set ( Ecore_X_Window  window,
Eina_Bool  request_pos,
Ecore_X_Gravity  gravity,
int  min_w,
int  min_h,
int  max_w,
int  max_h,
int  base_w,
int  base_h,
int  step_x,
int  step_y,
double  min_aspect,
double  max_aspect 
)

Sets the hints of a window.

Parameters:
windowThe window.
request_posRequest position flag.
gravityGravity.
min_wMinimum width.
min_hMinimum height.
max_wMaximum width.
max_hMaximum height.
base_wBase width
base_hBase height
step_xX step coordinate.
step_yY step coordinate.
min_aspectMinimum aspect ratio.
max_aspectMaximum aspect ratio.

To use this function, you must call before, and in order, ecore_x_icccm_size_pos_hints_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_size_pos_hints_get_fetch(), which gets the reply.

EAPI Ecore_X_Window_State_Hint ecore_x_icccm_state_get ( Ecore_X_Window  window)

Gets the state of a window.

Parameters:
windowThe window.
Returns:
The state of the window

To use this function, you must call before, and in order, ecore_x_icccm_state_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_state_get_fetch(), which gets the reply.

References ECORE_X_WINDOW_STATE_HINT_ICONIC, ECORE_X_WINDOW_STATE_HINT_NONE, ECORE_X_WINDOW_STATE_HINT_NORMAL, and ECORE_X_WINDOW_STATE_HINT_WITHDRAWN.

EAPI void ecore_x_icccm_state_set ( Ecore_X_Window  window,
Ecore_X_Window_State_Hint  state 
)

Sets the state of a window.

Parameters:
windowThe window.
stateThe state.

References ECORE_X_WINDOW_STATE_HINT_ICONIC, ECORE_X_WINDOW_STATE_HINT_NORMAL, and ECORE_X_WINDOW_STATE_HINT_WITHDRAWN.

EAPI void ecore_x_icccm_take_focus_send ( Ecore_X_Window  window,
Ecore_X_Time  time 
)

Sends the ClientMessage event with the TakeFocus property.

Parameters:
windowThe window.
timeThe time.

References ecore_x_client_message32_send().

EAPI char* ecore_x_icccm_title_get ( Ecore_X_Window  window)

Gets the title of a window.

Parameters:
windowThe window (Unused).
Returns:
The title of the window

To use this function, you must call before, and in order, ecore_x_icccm_title_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_title_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_title_set ( Ecore_X_Window  window,
const char *  title 
)

Set the title of a window.

Parameters:
windowThe window.
titleThe title.
EAPI Ecore_X_Window ecore_x_icccm_transient_for_get ( Ecore_X_Window  window)

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

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

To use this function, you must call before, and in order, ecore_x_icccm_transient_for_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_transient_for_get_fetch(), which gets the reply.

EAPI void ecore_x_icccm_transient_for_set ( Ecore_X_Window  window,
Ecore_X_Window  forwindow 
)

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

Parameters:
windowThe transient window
forwindowThe toplevel window
EAPI void ecore_x_icccm_transient_for_unset ( Ecore_X_Window  window)

Remove the transient_for setting from a window.

Parameters:
windowThe window.
EAPI char* ecore_x_icccm_window_role_get ( Ecore_X_Window  window)

Get the window role.

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

To use this function, you must call before, and in order, ecore_x_icccm_window_role_get_prefetch(), which sends the GetProperty request, then ecore_x_icccm_window_role_get_fetch(), which gets the reply.

References ecore_x_window_prop_string_get().

EAPI void ecore_x_icccm_window_role_get_prefetch ( Ecore_X_Window  window)

Sends the GetProperty request.

Parameters:
windowWindow whose properties are requested.
EAPI void ecore_x_icccm_window_role_set ( Ecore_X_Window  window,
const char *  role 
)

Set the window role hint.

Parameters:
windowThe window
roleThe role string.

References ecore_x_window_prop_string_set().