git.sur5r.net Git - i3/i3/blob - include/ewmh.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * ewmh.c: Get/set certain EWMH properties easily.
   8  *
   9  */
  10 #pragma once
  11
  12 /**
  13  * Updates _NET_CURRENT_DESKTOP with the current desktop number.
  14  *
  15  * EWMH: The index of the current desktop. This is always an integer between 0
  16  * and _NET_NUMBER_OF_DESKTOPS - 1.
  17  *
  18  */
  19 void ewmh_update_current_desktop(void);
  20
  21 /**
  22  * Updates _NET_NUMBER_OF_DESKTOPS which we interpret as the number of
  23  * noninternal workspaces.
  24  */
  25 void ewmh_update_number_of_desktops(void);
  26
  27 /**
  28  * Updates _NET_DESKTOP_NAMES: "The names of all virtual desktops. This is a
  29  * list of NULL-terminated strings in UTF-8 encoding"
  30  */
  31 void ewmh_update_desktop_names(void);
  32
  33 /**
  34  * Updates _NET_DESKTOP_VIEWPORT, which is an array of pairs of cardinals that
  35  * define the top left corner of each desktop's viewport.
  36  */
  37 void ewmh_update_desktop_viewport(void);
  38
  39 /**
  40  * Updates _NET_ACTIVE_WINDOW with the currently focused window.
  41  *
  42  * EWMH: The window ID of the currently active window or None if no window has
  43  * the focus.
  44  *
  45  */
  46 void ewmh_update_active_window(xcb_window_t window);
  47
  48 /**
  49  * Updates _NET_WM_VISIBLE_NAME.
  50  *
  51  */
  52 void ewmh_update_visible_name(xcb_window_t window, const char *name);
  53
  54 /**
  55  * Updates the _NET_CLIENT_LIST hint. Used for window listers.
  56  */
  57 void ewmh_update_client_list(xcb_window_t *list, int num_windows);
  58
  59 /**
  60  * Updates the _NET_CLIENT_LIST_STACKING hint. Necessary to move tabs in
  61  * Chromium correctly.
  62  *
  63  * EWMH: These arrays contain all X Windows managed by the Window Manager.
  64  * _NET_CLIENT_LIST has initial mapping order, starting with the oldest window.
  65  * _NET_CLIENT_LIST_STACKING has bottom-to-top stacking order. These properties
  66  * SHOULD be set and updated by the Window Manager.
  67  *
  68  */
  69 void ewmh_update_client_list_stacking(xcb_window_t *stack, int num_windows);
  70
  71 /**
  72  * Set up the EWMH hints on the root window.
  73  *
  74  */
  75 void ewmh_setup_hints(void);
  76
  77 /**
  78  * i3 currently does not support _NET_WORKAREA, because it does not correspond
  79  * to i3’s concept of workspaces. See also:
  80  * http://bugs.i3wm.org/539
  81  * http://bugs.i3wm.org/301
  82  * http://bugs.i3wm.org/1038
  83  *
  84  * We need to actively delete this property because some display managers (e.g.
  85  * LightDM) set it.
  86  *
  87  * EWMH: Contains a geometry for each desktop. These geometries specify an area
  88  * that is completely contained within the viewport. Work area SHOULD be used by
  89  * desktop applications to place desktop icons appropriately.
  90  *
  91  */
  92 void ewmh_update_workarea(void);