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 net_wm_state_add;
 125   Atom net_wm_state_remove;
 126   Atom net_wm_state_toggle;
 127
 128   Atom kde_net_system_tray_windows;
 129   Atom kde_net_wm_system_tray_window_for;
 130   Atom kde_net_wm_window_type_override;
 131
 132   Atom kwm_win_icon;
 133
 134   Atom rootpmapid;
 135   Atom esetrootid;
 136
 137   Atom openbox_premax;
 138   Atom openbox_active_window;
 139   Atom openbox_restack_window;
 140 };
 141
 142
 143 //! Provides easy access to window properties.
 144 class Property {
 145 public:
 146
 147   //! The possible types/encodings of strings
 148   enum StringType {
 149     ascii, //!< Standard 8-bit ascii string
 150     utf8,  //!< Utf8-encoded string
 151 #ifndef DOXYGEN_IGNORE
 152     NUM_STRING_TYPE
 153 #endif
 154   };
 155
 156   //! A list of ustrings
 157   typedef std::vector<ustring> StringVect;
 158
 159   //! The value of all atoms on the X server that exist in the
 160   //! Atoms struct
 161   static Atoms atoms;
 162
 163 private:
 164   //! Sets a property on a window
 165   static void set(Window win, Atom atom, Atom type, unsigned char *data,
 166                   int size, int nelements, bool append);
 167   //! Gets a property's value from a window
 168   static bool get(Window win, Atom atom, Atom type,
 169                   unsigned long *nelements, unsigned char **value,
 170                   int size);
 171
 172 public:
 173   //! Initializes the Property class.
 174   /*!
 175     CAUTION: This function uses otk::Display, so ensure that
 176     otk::Display::initialize has been called before initializing this class!
 177   */
 178   static void initialize();
 179
 180   //! Sets a single-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 The value to set the property to
 188   */
 189   static void set(Window win, Atom atom, Atom type, unsigned long value);
 190   //! Sets an multiple-value property on a window to a new value
 191   /*!
 192     @param win The window id of the window on which to set the property's value
 193     @param atom The Atom value of the property to set. This can be found in the
 194                 struct returned by Property::atoms.
 195     @param type The Atom value of the property type. This can be found in the
 196                 struct returned by Property::atoms.
 197     @param value Any array of values to set the property to. The array must
 198                  contain <i>elements</i> number of elements
 199     @param elements The number of elements in the <i>value</i> array
 200   */
 201   static void set(Window win, Atom atom, Atom type,
 202                   unsigned long value[], int elements);
 203   //! Sets a string property on a window to a new value
 204   /*!
 205     @param win The window id of the window on which to set the property's value
 206     @param atom The Atom value of the property to set. This can be found in the
 207                 struct returned by Property::atoms.
 208     @param type A member of the Property::StringType enum that specifies the
 209                 type of the string the property is being set to
 210     @param value The string to set the property to
 211   */
 212   static void set(Window win, Atom atom, StringType type,
 213                   const ustring &value);
 214   //! Sets a string-array property on a window to a new value
 215   /*!
 216     @param win The window id of the window on which to set the property's value
 217     @param atom The Atom value of the property to set. This can be found in the
 218                 struct returned by Property::atoms.
 219     @param type A member of the Property::StringType enum that specifies the
 220                 type of the string the property is being set to
 221     @param strings A list of strings to set the property to
 222   */
 223   static void set(Window win, Atom atom, StringType type,
 224                   const StringVect &strings);
 225
 226   //! Gets the value of a property on a window
 227   /*!
 228     @param win The window id of the window to get the property value from
 229     @param atom The Atom value of the property to set. This can be found in the
 230                 struct returned by Property::atoms.
 231     @param type The Atom value of the property type. This can be found in the
 232                 struct returned by Property::atoms.
 233     @param nelements When the function returns, if it returns true, this will
 234                      contain the actual number of elements retrieved.<br>
 235     @param value If the function returns true, then this contains an array of
 236                  retrieved values for the property.<br>
 237                  The <i>value</i> is allocated inside the function and
 238                  <b>delete[]</b> value needs to be called when you are done
 239                  with it.<br>
 240                  The <i>value</i> array returned is null terminated, and has
 241                  <i>nelements</i> elements in it plus the terminating null.
 242     @return true if retrieval of the specified property with the specified
 243             type was successful; otherwise, false
 244   */
 245   static bool get(Window win, Atom atom, Atom type,
 246                   unsigned long *nelements, unsigned long **value);
 247   //! Gets a single element from the value of a property on a window
 248   /*!
 249     @param win The window id of the window to get the property value from
 250     @param atom The Atom value of the property to set. This can be found in the
 251                 struct returned by Property::atoms.
 252     @param type The Atom value of the property type. This can be found in the
 253                 struct returned by Property::atoms.
 254     @param value If the function returns true, then this contains the first
 255                  (and possibly only) element in the value of the specified
 256                  property.
 257     @return true if retrieval of the specified property with the specified
 258             type was successful; otherwise, false
 259   */
 260   static bool get(Window win, Atom atom, Atom type, unsigned long *value);
 261   //! Gets a single string from the value of a property on a window
 262   /*!
 263     @param win The window id of the window to get the property value from
 264     @param atom The Atom value of the property to set. This can be found in the
 265                 struct returned by Property::atoms.
 266     @param type A member of the Property::StringType enum that specifies the
 267                 type of the string property to retrieve
 268     @param value If the function returns true, then this contains the first
 269                  (and possibly only) string in the value of the specified
 270                  property.
 271     @return true if retrieval of the specified property with the specified
 272             type was successful; otherwise, false
 273   */
 274   static bool get(Window win, Atom atom, StringType type, ustring *value);
 275   //! Gets strings from the value of a property on a window
 276   /*!
 277     @param win The window id of the window to get the property value from
 278     @param atom The Atom value of the property to set. This can be found in the
 279                 struct returned by Property::atoms.
 280     @param type A member of the Property::StringType enum that specifies the
 281                 type of the string property to retrieve
 282     @param nelements When the function returns, if it returns true, this will
 283                      contain the actual number of strings retrieved.<br>
 284     @param strings If the function returns true, then this contains all of the
 285                    strings retrieved from the property's value.
 286     @return true if retrieval of the specified property with the specified
 287             type was successful; otherwise, false
 288   */
 289   static bool get(Window win, Atom atom, StringType type,
 290                   unsigned long *nelements, StringVect *strings);
 291
 292   //! Removes a property from a window
 293   /*!
 294     @param win The window id of the window to remove the property from
 295     @param atom The Atom value of the property to set. This can be found in the
 296                 struct returned by Property::atoms.
 297   */
 298   static void erase(Window win, Atom atom);
 299 };
 300
 301 }
 302
 303 #endif // __atom_hh