otk/property.hh

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