otk/property.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 #ifndef   __atom_hh
   3 #define   __atom_hh
   4
   5 /*! @file property.hh
   6   @brief Provides access to window properties
   7 */
   8
   9 #include "ustring.hh"
  10 #include "screeninfo.hh"
  11
  12 extern "C" {
  13 #include <X11/Xlib.h>
  14 }
  15
  16 #include <vector>
  17 #include <cassert>
  18
  19 namespace otk {
  20
  21 //! The atoms on the X server which this class will cache
  22 struct Atoms {
  23   // types
  24   Atom cardinal; //!< The atom which represents the Cardinal data type
  25   Atom window;   //!< The atom which represents window ids
  26   Atom pixmap;   //!< The atom which represents pixmap ids
  27   Atom atom;     //!< The atom which represents atom values
  28   Atom string;   //!< The atom which represents ascii strings
  29   Atom utf8;     //!< The atom which represents utf8-encoded strings
  30
  31   Atom openbox_pid;
  32
  33   // window hints
  34   Atom wm_colormap_windows;
  35   Atom wm_protocols;
  36   Atom wm_state;
  37   Atom wm_delete_window;
  38   Atom wm_take_focus;
  39   Atom wm_change_state;
  40   Atom wm_name;
  41   Atom wm_icon_name;
  42   Atom wm_class;
  43   Atom wm_window_role;
  44   Atom motif_wm_hints;
  45
  46   Atom openbox_show_root_menu;
  47   Atom openbox_show_workspace_menu;
  48
  49   // NETWM atoms
  50   // root window properties
  51   Atom net_supported;
  52   Atom net_client_list;
  53   Atom net_client_list_stacking;
  54   Atom net_number_of_desktops;
  55   Atom net_desktop_geometry;
  56   Atom net_desktop_viewport;
  57   Atom net_current_desktop;
  58   Atom net_desktop_names;
  59   Atom net_active_window;
  60   Atom net_workarea;
  61   Atom net_supporting_wm_check;
  62 //  Atom net_virtual_roots;
  63   Atom net_desktop_layout;
  64   Atom net_showing_desktop;
  65   // root window messages
  66   Atom net_close_window;
  67   Atom net_wm_moveresize;
  68   // application window properties
  69 //  Atom net_properties;
  70   Atom net_wm_name;
  71   Atom net_wm_visible_name;
  72   Atom net_wm_icon_name;
  73   Atom net_wm_visible_icon_name;
  74   Atom net_wm_desktop;
  75   Atom net_wm_window_type;
  76   Atom net_wm_state;
  77   Atom net_wm_strut;
  78 //  Atom net_wm_icon_geometry;
  79   Atom net_wm_icon;
  80 //  Atom net_wm_pid;
  81 //  Atom net_wm_handled_icons;
  82   Atom net_wm_allowed_actions;
  83   // application protocols
  84 //  Atom   Atom net_wm_ping;
  85
  86   Atom net_wm_window_type_desktop;
  87   Atom net_wm_window_type_dock;
  88   Atom net_wm_window_type_toolbar;
  89   Atom net_wm_window_type_menu;
  90   Atom net_wm_window_type_utility;
  91   Atom net_wm_window_type_splash;
  92   Atom net_wm_window_type_dialog;
  93   Atom net_wm_window_type_normal;
  94
  95   Atom net_wm_moveresize_size_topleft;
  96   Atom net_wm_moveresize_size_topright;
  97   Atom net_wm_moveresize_size_bottomleft;
  98   Atom net_wm_moveresize_size_bottomright;
  99   Atom net_wm_moveresize_move;
 100
 101   Atom net_wm_action_move;
 102   Atom net_wm_action_resize;
 103   Atom net_wm_action_minimize;
 104   Atom net_wm_action_shade;
 105   Atom net_wm_action_stick;
 106   Atom net_wm_action_maximize_horz;
 107   Atom net_wm_action_maximize_vert;
 108   Atom net_wm_action_fullscreen;
 109   Atom net_wm_action_change_desktop;
 110   Atom net_wm_action_close;
 111
 112   Atom net_wm_state_modal;
 113   Atom net_wm_state_sticky;
 114   Atom net_wm_state_maximized_vert;
 115   Atom net_wm_state_maximized_horz;
 116   Atom net_wm_state_shaded;
 117   Atom net_wm_state_skip_taskbar;
 118   Atom net_wm_state_skip_pager;
 119   Atom net_wm_state_hidden;
 120   Atom net_wm_state_fullscreen;
 121   Atom net_wm_state_above;
 122   Atom net_wm_state_below;
 123
 124   Atom kde_net_system_tray_windows;
 125   Atom kde_net_wm_system_tray_window_for;
 126   Atom kde_net_wm_window_type_override;
 127
 128   Atom openbox_premax;
 129   Atom openbox_active_window;
 130 };
 131
 132
 133 //! Provides easy access to window properties.
 134 class Property {
 135 public:
 136
 137   //! The possible types/encodings of strings
 138   enum StringType {
 139     ascii, //!< Standard 8-bit ascii string
 140     utf8,  //!< Utf8-encoded string
 141 #ifndef DOXYGEN_IGNORE
 142     NUM_STRING_TYPE
 143 #endif
 144   };
 145
 146   //! A list of ustrings
 147   typedef std::vector<ustring> StringVect;
 148
 149   //! The value of all atoms on the X server that exist in the
 150   //! Atoms struct
 151   static Atoms atoms;
 152
 153 private:
 154   //! Sets a property on a window
 155   static void set(Window win, Atom atom, Atom type, unsigned char *data,
 156                   int size, int nelements, bool append);
 157   //! Gets a property's value from a window
 158   static bool get(Window win, Atom atom, Atom type,
 159                   unsigned long *nelements, unsigned char **value,
 160                   int size);
 161
 162 public:
 163   //! Initializes the Property class.
 164   /*!
 165     CAUTION: This function uses otk::Display, so ensure that
 166     otk::Display::initialize has been called before initializing this class!
 167   */
 168   static void initialize();
 169
 170   //! Sets a single-value property on a window to a new value
 171   /*!
 172     @param win The window id of the window on which to set the property's value
 173     @param atom The Atom value of the property to set. This can be found in the
 174                 struct returned by Property::atoms.
 175     @param type The Atom value of the property type. This can be found in the
 176                 struct returned by Property::atoms.
 177     @param value The value to set the property to
 178   */
 179   static void set(Window win, Atom atom, Atom type, unsigned long value);
 180   //! Sets an multiple-value property on a window to a new value
 181   /*!
 182     @param win The window id of the window on which to set the property's value
 183     @param atom The Atom value of the property to set. This can be found in the
 184                 struct returned by Property::atoms.
 185     @param type The Atom value of the property type. This can be found in the
 186                 struct returned by Property::atoms.
 187     @param value Any array of values to set the property to. The array must
 188                  contain <i>elements</i> number of elements
 189     @param elements The number of elements in the <i>value</i> array
 190   */
 191   static void set(Window win, Atom atom, Atom type,
 192                   unsigned long value[], int elements);
 193   //! Sets a string property on a window to a new value
 194   /*!
 195     @param win The window id of the window on which to set the property's value
 196     @param atom The Atom value of the property to set. This can be found in the
 197                 struct returned by Property::atoms.
 198     @param type A member of the Property::StringType enum that specifies the
 199                 type of the string the property is being set to
 200     @param value The string to set the property to
 201   */
 202   static void set(Window win, Atom atom, StringType type,
 203                   const ustring &value);
 204   //! Sets a string-array property on a window to a new value
 205   /*!
 206     @param win The window id of the window on which to set the property's value
 207     @param atom The Atom value of the property to set. This can be found in the
 208                 struct returned by Property::atoms.
 209     @param type A member of the Property::StringType enum that specifies the
 210                 type of the string the property is being set to
 211     @param strings A list of strings to set the property to
 212   */
 213   static void set(Window win, Atom atom, StringType type,
 214                   const StringVect &strings);
 215
 216   //! Gets the value of a property on a window
 217   /*!
 218     @param win The window id of the window to get the property value from
 219     @param atom The Atom value of the property to set. This can be found in the
 220                 struct returned by Property::atoms.
 221     @param type The Atom value of the property type. This can be found in the
 222                 struct returned by Property::atoms.
 223     @param nelements The maximum number of elements to retrieve from the
 224                      property (assuming it has more than 1 value in it). To
 225                      retrieve all possible elements, use "(unsigned) -1".<br>
 226                      When the function returns, if it returns true, this will
 227                      contain the actual number of elements retrieved.<br>
 228     @param value If the function returns true, then this contains an array of
 229                  retrieved values for the property.<br>
 230                  The <i>value</i> is allocated inside the function and
 231                  <b>delete[]</b> value needs to be called when you are done
 232                  with it.<br>
 233                  The <i>value</i> array returned is null terminated, and has
 234                  <i>nelements</i> elements in it plus the terminating null.
 235     @return true if retrieval of the specified property with the specified
 236             type was successful; otherwise, false
 237   */
 238   static bool get(Window win, Atom atom, Atom type,
 239                   unsigned long *nelements, unsigned long **value);
 240   //! Gets a single element from the value of a property on a window
 241   /*!
 242     @param win The window id of the window to get the property value from
 243     @param atom The Atom value of the property to set. This can be found in the
 244                 struct returned by Property::atoms.
 245     @param type The Atom value of the property type. This can be found in the
 246                 struct returned by Property::atoms.
 247     @param value If the function returns true, then this contains the first
 248                  (and possibly only) element in the value of the specified
 249                  property.
 250     @return true if retrieval of the specified property with the specified
 251             type was successful; otherwise, false
 252   */
 253   static bool get(Window win, Atom atom, Atom type, unsigned long *value);
 254   //! Gets a single string from the value of a property on a window
 255   /*!
 256     @param win The window id of the window to get the property value from
 257     @param atom The Atom value of the property to set. This can be found in the
 258                 struct returned by Property::atoms.
 259     @param type A member of the Property::StringType enum that specifies the
 260                 type of the string property to retrieve
 261     @param value If the function returns true, then this contains the first
 262                  (and possibly only) string in the value of the specified
 263                  property.
 264     @return true if retrieval of the specified property with the specified
 265             type was successful; otherwise, false
 266   */
 267   static bool get(Window win, Atom atom, StringType type, ustring *value);
 268   //! Gets strings from the value of a property on a window
 269   /*!
 270     @param win The window id of the window to get the property value from
 271     @param atom The Atom value of the property to set. This can be found in the
 272                 struct returned by Property::atoms.
 273     @param type A member of the Property::StringType enum that specifies the
 274                 type of the string property to retrieve
 275     @param nelements The maximum number of strings to retrieve from the
 276                      property (assuming it has more than 1 string in it). To
 277                      retrieve all possible strings, use "(unsigned) -1".<br>
 278                      When the function returns, if it returns true, this will
 279                      contain the actual number of strings retrieved.<br>
 280     @param strings If the function returns true, then this contains all of the
 281                    strings retrieved from the property's value.
 282     @return true if retrieval of the specified property with the specified
 283             type was successful; otherwise, false
 284   */
 285   static bool get(Window win, Atom atom, StringType type,
 286                   unsigned long *nelements, StringVect *strings);
 287
 288   //! Removes a property from a window
 289   /*!
 290     @param win The window id of the window to remove the property from
 291     @param atom The Atom value of the property to set. This can be found in the
 292                 struct returned by Property::atoms.
 293   */
 294   static void erase(Window win, Atom atom);
 295 };
 296
 297 }
 298
 299 #endif // __atom_hh