--- /dev/null
+// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
+
+#ifdef HAVE_CONFIG_H
+# include "../config.h"
+#endif // HAVE_CONFIG_H
+
+extern "C" {
+#include <assert.h>
+}
+
+#include "property.hh"
+#include "display.hh"
+
+namespace otk {
+
+OBProperty::OBProperty()
+{
+ assert(OBDisplay::display);
+
+ // make sure asserts fire if there is a problem
+ memset(_atoms, 0, sizeof(_atoms));
+
+ _atoms[Atom_Cardinal] = XA_CARDINAL;
+ _atoms[Atom_Window] = XA_WINDOW;
+ _atoms[Atom_Pixmap] = XA_PIXMAP;
+ _atoms[Atom_Atom] = XA_ATOM;
+ _atoms[Atom_String] = XA_STRING;
+ _atoms[Atom_Utf8] = create("UTF8_STRING");
+
+#ifdef HAVE_GETPID
+ _atoms[blackbox_pid] = create("_BLACKBOX_PID");
+#endif // HAVE_GETPID
+
+ _atoms[wm_colormap_windows] = create("WM_COLORMAP_WINDOWS");
+ _atoms[wm_protocols] = create("WM_PROTOCOLS");
+ _atoms[wm_state] = create("WM_STATE");
+ _atoms[wm_change_state] = create("WM_CHANGE_STATE");
+ _atoms[wm_delete_window] = create("WM_DELETE_WINDOW");
+ _atoms[wm_take_focus] = create("WM_TAKE_FOCUS");
+ _atoms[wm_name] = create("WM_NAME");
+ _atoms[wm_icon_name] = create("WM_ICON_NAME");
+ _atoms[wm_class] = create("WM_CLASS");
+ _atoms[motif_wm_hints] = create("_MOTIF_WM_HINTS");
+ _atoms[blackbox_hints] = create("_BLACKBOX_HINTS");
+ _atoms[blackbox_attributes] = create("_BLACKBOX_ATTRIBUTES");
+ _atoms[blackbox_change_attributes] = create("_BLACKBOX_CHANGE_ATTRIBUTES");
+ _atoms[blackbox_structure_messages] = create("_BLACKBOX_STRUCTURE_MESSAGES");
+ _atoms[blackbox_notify_startup] = create("_BLACKBOX_NOTIFY_STARTUP");
+ _atoms[blackbox_notify_window_add] = create("_BLACKBOX_NOTIFY_WINDOW_ADD");
+ _atoms[blackbox_notify_window_del] = create("_BLACKBOX_NOTIFY_WINDOW_DEL");
+ _atoms[blackbox_notify_current_workspace] =
+ create("_BLACKBOX_NOTIFY_CURRENT_WORKSPACE");
+ _atoms[blackbox_notify_workspace_count] =
+ create("_BLACKBOX_NOTIFY_WORKSPACE_COUNT");
+ _atoms[blackbox_notify_window_focus] =
+ create("_BLACKBOX_NOTIFY_WINDOW_FOCUS");
+ _atoms[blackbox_notify_window_raise] =
+ create("_BLACKBOX_NOTIFY_WINDOW_RAISE");
+ _atoms[blackbox_notify_window_lower] =
+ create("_BLACKBOX_NOTIFY_WINDOW_LOWER");
+
+ _atoms[blackbox_change_workspace] = create("_BLACKBOX_CHANGE_WORKSPACE");
+ _atoms[blackbox_change_window_focus] =
+ create("_BLACKBOX_CHANGE_WINDOW_FOCUS");
+ _atoms[blackbox_cycle_window_focus] = create("_BLACKBOX_CYCLE_WINDOW_FOCUS");
+
+ _atoms[openbox_show_root_menu] = create("_OPENBOX_SHOW_ROOT_MENU");
+ _atoms[openbox_show_workspace_menu] = create("_OPENBOX_SHOW_WORKSPACE_MENU");
+
+ _atoms[net_supported] = create("_NET_SUPPORTED");
+ _atoms[net_client_list] = create("_NET_CLIENT_LIST");
+ _atoms[net_client_list_stacking] = create("_NET_CLIENT_LIST_STACKING");
+ _atoms[net_number_of_desktops] = create("_NET_NUMBER_OF_DESKTOPS");
+ _atoms[net_desktop_geometry] = create("_NET_DESKTOP_GEOMETRY");
+ _atoms[net_desktop_viewport] = create("_NET_DESKTOP_VIEWPORT");
+ _atoms[net_current_desktop] = create("_NET_CURRENT_DESKTOP");
+ _atoms[net_desktop_names] = create("_NET_DESKTOP_NAMES");
+ _atoms[net_active_window] = create("_NET_ACTIVE_WINDOW");
+ _atoms[net_workarea] = create("_NET_WORKAREA");
+ _atoms[net_supporting_wm_check] = create("_NET_SUPPORTING_WM_CHECK");
+// _atoms[net_virtual_roots] = create("_NET_VIRTUAL_ROOTS");
+
+ _atoms[net_close_window] = create("_NET_CLOSE_WINDOW");
+ _atoms[net_wm_moveresize] = create("_NET_WM_MOVERESIZE");
+
+// _atoms[net_properties] = create("_NET_PROPERTIES");
+ _atoms[net_wm_name] = create("_NET_WM_NAME");
+ _atoms[net_wm_visible_name] = create("_NET_WM_VISIBLE_NAME");
+ _atoms[net_wm_icon_name] = create("_NET_WM_ICON_NAME");
+ _atoms[net_wm_visible_icon_name] = create("_NET_WM_VISIBLE_ICON_NAME");
+ _atoms[net_wm_desktop] = create("_NET_WM_DESKTOP");
+ _atoms[net_wm_window_type] = create("_NET_WM_WINDOW_TYPE");
+ _atoms[net_wm_state] = create("_NET_WM_STATE");
+ _atoms[net_wm_strut] = create("_NET_WM_STRUT");
+// _atoms[net_wm_icon_geometry] = create("_NET_WM_ICON_GEOMETRY");
+// _atoms[net_wm_icon] = create("_NET_WM_ICON");
+// _atoms[net_wm_pid] = create("_NET_WM_PID");
+// _atoms[net_wm_handled_icons] = create("_NET_WM_HANDLED_ICONS");
+ _atoms[net_wm_allowed_actions] = create("_NET_WM_ALLOWED_ACTIONS");
+
+// _atoms[net_wm_ping] = create("_NET_WM_PING");
+
+ _atoms[net_wm_window_type_desktop] = create("_NET_WM_WINDOW_TYPE_DESKTOP");
+ _atoms[net_wm_window_type_dock] = create("_NET_WM_WINDOW_TYPE_DOCK");
+ _atoms[net_wm_window_type_toolbar] = create("_NET_WM_WINDOW_TYPE_TOOLBAR");
+ _atoms[net_wm_window_type_menu] = create("_NET_WM_WINDOW_TYPE_MENU");
+ _atoms[net_wm_window_type_utility] = create("_NET_WM_WINDOW_TYPE_UTILITY");
+ _atoms[net_wm_window_type_splash] = create("_NET_WM_WINDOW_TYPE_SPLASH");
+ _atoms[net_wm_window_type_dialog] = create("_NET_WM_WINDOW_TYPE_DIALOG");
+ _atoms[net_wm_window_type_normal] = create("_NET_WM_WINDOW_TYPE_NORMAL");
+
+ _atoms[net_wm_moveresize_size_topleft] =
+ create("_NET_WM_MOVERESIZE_SIZE_TOPLEFT");
+ _atoms[net_wm_moveresize_size_topright] =
+ create("_NET_WM_MOVERESIZE_SIZE_TOPRIGHT");
+ _atoms[net_wm_moveresize_size_bottomleft] =
+ create("_NET_WM_MOVERESIZE_SIZE_BOTTOMLEFT");
+ _atoms[net_wm_moveresize_size_bottomright] =
+ create("_NET_WM_MOVERESIZE_SIZE_BOTTOMRIGHT");
+ _atoms[net_wm_moveresize_move] =
+ create("_NET_WM_MOVERESIZE_MOVE");
+
+ _atoms[net_wm_action_move] = create("_NET_WM_ACTION_MOVE");
+ _atoms[net_wm_action_resize] = create("_NET_WM_ACTION_RESIZE");
+ _atoms[net_wm_action_shade] = create("_NET_WM_ACTION_SHADE");
+ _atoms[net_wm_action_maximize_horz] = create("_NET_WM_ACTION_MAXIMIZE_HORZ");
+ _atoms[net_wm_action_maximize_vert] = create("_NET_WM_ACTION_MAXIMIZE_VERT");
+ _atoms[net_wm_action_change_desktop] =
+ create("_NET_WM_ACTION_CHANGE_DESKTOP");
+ _atoms[net_wm_action_close] = create("_NET_WM_ACTION_CLOSE");
+
+ _atoms[net_wm_state_modal] = create("_NET_WM_STATE_MODAL");
+ _atoms[net_wm_state_maximized_vert] = create("_NET_WM_STATE_MAXIMIZED_VERT");
+ _atoms[net_wm_state_maximized_horz] = create("_NET_WM_STATE_MAXIMIZED_HORZ");
+ _atoms[net_wm_state_shaded] = create("_NET_WM_STATE_SHADED");
+ _atoms[net_wm_state_skip_taskbar] = create("_NET_WM_STATE_SKIP_TASKBAR");
+ _atoms[net_wm_state_skip_pager] = create("_NET_WM_STATE_SKIP_PAGER");
+ _atoms[net_wm_state_hidden] = create("_NET_WM_STATE_HIDDEN");
+ _atoms[net_wm_state_fullscreen] = create("_NET_WM_STATE_FULLSCREEN");
+
+ _atoms[kde_net_system_tray_windows] = create("_KDE_NET_SYSTEM_TRAY_WINDOWS");
+ _atoms[kde_net_wm_system_tray_window_for] =
+ create("_KDE_NET_WM_SYSTEM_TRAY_WINDOW_FOR");
+ _atoms[kde_net_wm_window_type_override] =
+ create("_KDE_NET_WM_WINDOW_TYPE_OVERRIDE");
+}
+
+
+/*
+ * clean up the class' members
+ */
+OBProperty::~OBProperty()
+{
+}
+
+
+/*
+ * Returns an atom from the Xserver, creating it if necessary.
+ */
+Atom OBProperty::create(const char *name) const
+{
+ return XInternAtom(OBDisplay::display, name, False);
+}
+
+
+/*
+ * Internal set.
+ * Sets a window property on a window, optionally appending to the existing
+ * value.
+ */
+void OBProperty::set(Window win, Atom atom, Atom type,
+ unsigned char* data, int size, int nelements,
+ bool append) const
+{
+ assert(win != None); assert(atom != None); assert(type != None);
+ assert(nelements == 0 || (nelements > 0 && data != (unsigned char *) 0));
+ assert(size == 8 || size == 16 || size == 32);
+ XChangeProperty(OBDisplay::display, win, atom, type, size,
+ (append ? PropModeAppend : PropModeReplace),
+ data, nelements);
+}
+
+
+/*
+ * Set a 32-bit property value on a window.
+ */
+void OBProperty::set(Window win, Atoms atom, Atoms type,
+ unsigned long value) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_ATOMS);
+ set(win, _atoms[atom], _atoms[type],
+ reinterpret_cast<unsigned char*>(&value), 32, 1, False);
+}
+
+
+/*
+ * Set an array of 32-bit properties value on a window.
+ */
+void OBProperty::set(Window win, Atoms atom, Atoms type,
+ unsigned long value[], int elements) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_ATOMS);
+ set(win, _atoms[atom], _atoms[type],
+ reinterpret_cast<unsigned char*>(value), 32, elements, False);
+}
+
+
+/*
+ * Set an string property value on a window.
+ */
+void OBProperty::set(Window win, Atoms atom, StringType type,
+ const std::string &value) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_STRING_TYPE);
+
+ Atom t;
+ switch (type) {
+ case ascii: t = _atoms[Atom_String]; break;
+ case utf8: t = _atoms[Atom_Utf8]; break;
+ default: assert(False); return; // unhandled StringType
+ }
+ set(win, _atoms[atom], t,
+ reinterpret_cast<unsigned char *>(const_cast<char *>(value.c_str())),
+ 8, value.size() + 1, False); // add 1 to the size to include the null
+}
+
+
+/*
+ * Set an array of string property values on a window.
+ */
+void OBProperty::set(Window win, Atoms atom, StringType type,
+ const StringVect &strings) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_STRING_TYPE);
+
+ Atom t;
+ switch (type) {
+ case ascii: t = _atoms[Atom_String]; break;
+ case utf8: t = _atoms[Atom_Utf8]; break;
+ default: assert(False); return; // unhandled StringType
+ }
+
+ std::string value;
+
+ StringVect::const_iterator it = strings.begin();
+ const StringVect::const_iterator end = strings.end();
+ for (; it != end; ++it)
+ value += *it + '\0';
+
+ set(win, _atoms[atom], t,
+ reinterpret_cast<unsigned char *>(const_cast<char *>(value.c_str())),
+ 8, value.size(), False);
+}
+
+
+/*
+ * Internal get function used by all of the typed get functions.
+ * Gets an property's value from a window.
+ * Returns True if the property was successfully retrieved; False if the
+ * property did not exist on the window, or has a different type/size format
+ * than the user tried to retrieve.
+ */
+bool OBProperty::get(Window win, Atom atom, Atom type,
+ unsigned long *nelements, unsigned char **value,
+ int size) const
+{
+ assert(win != None); assert(atom != None); assert(type != None);
+ assert(size == 8 || size == 16 || size == 32);
+ assert(*nelements > 0);
+ unsigned char *c_val = 0; // value alloc'd in Xlib, must be XFree()d
+ Atom ret_type;
+ int ret_size;
+ unsigned long ret_bytes;
+ int result;
+ unsigned long maxread = *nelements;
+ bool ret = False;
+
+ // try get the first element
+ result = XGetWindowProperty(OBDisplay::display, win, atom, 0l, 1l,
+ False, AnyPropertyType, &ret_type, &ret_size,
+ nelements, &ret_bytes, &c_val);
+ ret = (result == Success && ret_type == type && ret_size == size &&
+ *nelements > 0);
+ if (ret) {
+ if (ret_bytes == 0 || maxread <= *nelements) {
+ // we got the whole property's value
+ *value = new unsigned char[*nelements * size/8 + 1];
+ memcpy(*value, c_val, *nelements * size/8 + 1);
+ } else {
+ // get the entire property since it is larger than one long
+ XFree(c_val);
+ // the number of longs that need to be retreived to get the property's
+ // entire value. The last + 1 is the first long that we retrieved above.
+ int remain = (ret_bytes - 1)/sizeof(long) + 1 + 1;
+ if (remain > size/8 * (signed)maxread) // dont get more than the max
+ remain = size/8 * (signed)maxread;
+ result = XGetWindowProperty(OBDisplay::display, win, atom, 0l,
+ remain, False, type, &ret_type, &ret_size,
+ nelements, &ret_bytes, &c_val);
+ ret = (result == Success && ret_type == type && ret_size == size &&
+ ret_bytes == 0);
+ /*
+ If the property has changed type/size, or has grown since our first
+ read of it, then stop here and try again. If it shrank, then this will
+ still work.
+ */
+ if (! ret)
+ return get(win, atom, type, &maxread, value, size);
+
+ *value = new unsigned char[*nelements * size/8 + 1];
+ memcpy(*value, c_val, *nelements * size/8 + 1);
+ }
+ }
+ if (c_val) XFree(c_val);
+ return ret;
+}
+
+
+/*
+ * Gets a 32-bit property's value from a window.
+ */
+bool OBProperty::get(Window win, Atoms atom, Atoms type,
+ unsigned long *nelements,
+ unsigned long **value) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_ATOMS);
+ return get(win, _atoms[atom], _atoms[type], nelements,
+ reinterpret_cast<unsigned char **>(value), 32);
+}
+
+
+/*
+ * Gets a single 32-bit property's value from a window.
+ */
+bool OBProperty::get(Window win, Atoms atom, Atoms type,
+ unsigned long *value) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_ATOMS);
+ unsigned long *temp;
+ unsigned long num = 1;
+ if (! get(win, _atoms[atom], _atoms[type], &num,
+ reinterpret_cast<unsigned char **>(&temp), 32))
+ return False;
+ *value = temp[0];
+ delete [] temp;
+ return True;
+}
+
+
+/*
+ * Gets an string property's value from a window.
+ */
+bool OBProperty::get(Window win, Atoms atom, StringType type,
+ std::string *value) const
+{
+ unsigned long n = 1;
+ StringVect s;
+ if (get(win, atom, type, &n, &s)) {
+ *value = s[0];
+ return True;
+ }
+ return False;
+}
+
+
+bool OBProperty::get(Window win, Atoms atom, StringType type,
+ unsigned long *nelements, StringVect *strings) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ assert(type >= 0 && type < NUM_STRING_TYPE);
+ assert(win != None); assert(_atoms[atom] != None);
+ assert(*nelements > 0);
+
+ Atom t;
+ switch (type) {
+ case ascii: t = _atoms[Atom_String]; break;
+ case utf8: t = _atoms[Atom_Utf8]; break;
+ default: assert(False); return False; // unhandled StringType
+ }
+
+ unsigned char *value;
+ unsigned long elements = (unsigned) -1;
+ if (!get(win, _atoms[atom], t, &elements, &value, 8) || elements < 1)
+ return False;
+
+ std::string s(reinterpret_cast<char *>(value), elements);
+ delete [] value;
+
+ std::string::const_iterator it = s.begin(), end = s.end();
+ unsigned long num = 0;
+ while(num < *nelements) {
+ std::string::const_iterator tmp = it; // current string.begin()
+ it = std::find(tmp, end, '\0'); // look for null between tmp and end
+ strings->push_back(std::string(tmp, it)); // s[tmp:it)
+ ++num;
+ if (it == end) break;
+ ++it;
+ if (it == end) break;
+ }
+
+ *nelements = num;
+
+ return True;
+}
+
+
+/*
+ * Removes a property entirely from a window.
+ */
+void OBProperty::erase(Window win, Atoms atom) const
+{
+ assert(atom >= 0 && atom < NUM_ATOMS);
+ XDeleteProperty(OBDisplay::display, win, _atoms[atom]);
+}
+
+}
--- /dev/null
+// -*- mode: C++; indent-tabs-mode: nil; -*-
+#ifndef __atom_hh
+#define __atom_hh
+
+/*! @file property.hh
+ @brief Provides access to window properties
+*/
+
+extern "C" {
+#include <X11/Xlib.h>
+#include <X11/Xatom.h>
+
+#include <assert.h>
+}
+
+#include <vector>
+#include <string>
+
+#include "screeninfo.hh"
+
+namespace otk {
+
+//! Provides easy access to window properties.
+class OBProperty {
+public:
+ //! The atoms on the X server which this class will cache
+ enum Atoms {
+ // types
+ Atom_Cardinal, //!< The atom which represents the Cardinal data type
+ Atom_Window, //!< The atom which represents window ids
+ Atom_Pixmap, //!< The atom which represents pixmap ids
+ Atom_Atom, //!< The atom which represents atom values
+ Atom_String, //!< The atom which represents ascii strings
+ Atom_Utf8, //!< The atom which represents utf8-encoded strings
+
+#ifdef HAVE_GETPID
+ blackbox_pid,
+#endif // HAVE_GETPID
+
+ // window hints
+ wm_colormap_windows,
+ wm_protocols,
+ wm_state,
+ wm_delete_window,
+ wm_take_focus,
+ wm_change_state,
+ wm_name,
+ wm_icon_name,
+ wm_class,
+ motif_wm_hints,
+ blackbox_attributes,
+ blackbox_change_attributes,
+ blackbox_hints,
+
+ // blackbox-protocol atoms (wm -> client)
+ blackbox_structure_messages,
+ blackbox_notify_startup,
+ blackbox_notify_window_add,
+ blackbox_notify_window_del,
+ blackbox_notify_window_focus,
+ blackbox_notify_current_workspace,
+ blackbox_notify_workspace_count,
+ blackbox_notify_window_raise,
+ blackbox_notify_window_lower,
+ // blackbox-protocol atoms (client -> wm)
+ blackbox_change_workspace,
+ blackbox_change_window_focus,
+ blackbox_cycle_window_focus,
+
+ openbox_show_root_menu,
+ openbox_show_workspace_menu,
+
+ // NETWM atoms
+ // root window properties
+ net_supported,
+ net_client_list,
+ net_client_list_stacking,
+ net_number_of_desktops,
+ net_desktop_geometry,
+ net_desktop_viewport,
+ net_current_desktop,
+ net_desktop_names,
+ net_active_window,
+ net_workarea,
+ net_supporting_wm_check,
+// net_virtual_roots,
+ // root window messages
+ net_close_window,
+ net_wm_moveresize,
+ // application window properties
+// net_properties,
+ net_wm_name,
+ net_wm_visible_name,
+ net_wm_icon_name,
+ net_wm_visible_icon_name,
+ net_wm_desktop,
+ net_wm_window_type,
+ net_wm_state,
+ net_wm_strut,
+// net_wm_icon_geometry,
+// net_wm_icon,
+// net_wm_pid,
+// net_wm_handled_icons,
+ net_wm_allowed_actions,
+ // application protocols
+// net_wm_ping,
+
+ net_wm_window_type_desktop,
+ net_wm_window_type_dock,
+ net_wm_window_type_toolbar,
+ net_wm_window_type_menu,
+ net_wm_window_type_utility,
+ net_wm_window_type_splash,
+ net_wm_window_type_dialog,
+ net_wm_window_type_normal,
+
+ net_wm_moveresize_size_topleft,
+ net_wm_moveresize_size_topright,
+ net_wm_moveresize_size_bottomleft,
+ net_wm_moveresize_size_bottomright,
+ net_wm_moveresize_move,
+
+ net_wm_action_move,
+ net_wm_action_resize,
+ net_wm_action_shade,
+ net_wm_action_maximize_horz,
+ net_wm_action_maximize_vert,
+ net_wm_action_change_desktop,
+ net_wm_action_close,
+
+ net_wm_state_modal,
+ net_wm_state_maximized_vert,
+ net_wm_state_maximized_horz,
+ net_wm_state_shaded,
+ net_wm_state_skip_taskbar,
+ net_wm_state_skip_pager,
+ net_wm_state_hidden,
+ net_wm_state_fullscreen,
+
+ kde_net_system_tray_windows,
+ kde_net_wm_system_tray_window_for,
+ kde_net_wm_window_type_override,
+
+ // constant for how many atoms exist in the enumerator
+ NUM_ATOMS
+ };
+
+ //! The possible types/encodings of strings
+ enum StringType {
+ ascii, //!< Standard 8-bit ascii string
+ utf8, //!< Utf8-encoded string
+ NUM_STRING_TYPE
+ };
+
+private:
+ //! The value of all atoms on the X server that exist in the
+ //! OBProperty::Atoms enum
+ Atom _atoms[NUM_ATOMS];
+
+ //! Gets the value of an Atom from the X server, creating it if nessesary
+ Atom create(const char *name) const;
+
+ //! Sets a property on a window
+ void set(Window win, Atom atom, Atom type, unsigned char *data,
+ int size, int nelements, bool append) const;
+ //! Gets a property's value from a window
+ bool get(Window win, Atom atom, Atom type,
+ unsigned long *nelements, unsigned char **value,
+ int size) const;
+
+public:
+ //! A list of strings
+ typedef std::vector<std::string> StringVect;
+
+ //! Constructs a new OBAtom object
+ /*!
+ CAUTION: This constructor uses OBDisplay::display, so ensure that it is
+ initialized before initializing this class!
+ */
+ OBProperty();
+ //! Destroys the OBAtom object
+ virtual ~OBProperty();
+
+ //! Sets a property on a window to a new value
+ /*!
+ @param win The window id of the window on which to set the property's value
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to set
+ @param type A member of the OBProperty::Atoms enum that specifies the type
+ of the property to set
+ @param value The value to set the property to
+ */
+ void set(Window win, Atoms atom, Atoms type, unsigned long value) const;
+ //! Sets a property on a window to a new value
+ /*!
+ @param win The window id of the window on which to set the property's value
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to set
+ @param type A member of the OBProperty::Atoms enum that specifies the type
+ of the property to set
+ @param value Any array of values to set the property to. The array must
+ contain <i>elements</i> number of elements
+ @param elements The number of elements in the <i>value</i> array
+ */
+ void set(Window win, Atoms atom, Atoms type,
+ unsigned long value[], int elements) const;
+ //! Sets a property on a window to a new value
+ /*!
+ @param win The window id of the window on which to set the property's value
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to set
+ @param type A member of the OBProperty::StringType enum that specifies the
+ type of the string the property is being set to
+ @param value The string to set the property to
+ */
+ void set(Window win, Atoms atom, StringType type,
+ const std::string &value) const;
+ //! Sets a property on a window to a new value
+ /*!
+ @param win The window id of the window on which to set the property's value
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to set
+ @param type A member of the OBProperty::StringType enum that specifies the
+ type of the string the property is being set to
+ @param strings A list of strings to set the property to
+ */
+ void set(Window win, Atoms atom, StringType type,
+ const StringVect &strings) const;
+
+ //! Gets the value of a property on a window
+ /*!
+ @param win The window id of the window to get the property value from
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to retrieve
+ @param type A member of the OBProperty::Atoms enum that specifies the type
+ of the property to retrieve
+ @param nelements The maximum number of elements to retrieve from the
+ property (assuming it has more than 1 value in it). To
+ retrieve all possible elements, use "(unsigned) -1".<br>
+ When the function returns, if it returns true, this will
+ contain the actual number of elements retrieved.<br>
+ @param value If the function returns true, then this contains an array of
+ retrieved values for the property.<br>
+ The <i>value</i> is allocated inside the function and
+ <b>delete[]</b> value needs to be called when you are done
+ with it.<br>
+ The <i>value</i> array returned is null terminated, and has
+ <i>nelements</i> elements in it plus the terminating null.
+ @return true if retrieval of the specified property with the specified
+ type was successful; otherwise, false
+ */
+ bool get(Window win, Atoms atom, Atoms type,
+ unsigned long *nelements, unsigned long **value) const;
+ //! Gets a single element from the value of a property on a window
+ /*!
+ @param win The window id of the window to get the property value from
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to retrieve
+ @param type A member of the OBProperty::Atoms enum that specifies the type
+ of the property to retrieve
+ @param value If the function returns true, then this contains the first
+ (and possibly only) element in the value of the specified
+ property.
+ @return true if retrieval of the specified property with the specified
+ type was successful; otherwise, false
+ */
+ bool get(Window win, Atoms atom, Atoms type, unsigned long *value) const;
+ //! Gets a single string from the value of a property on a window
+ /*!
+ @param win The window id of the window to get the property value from
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to retrieve
+ @param type A member of the OBProperty::StringType enum that specifies the
+ type of the string property to retrieve
+ @param value If the function returns true, then this contains the first
+ (and possibly only) string in the value of the specified
+ property.
+ @return true if retrieval of the specified property with the specified
+ type was successful; otherwise, false
+ */
+ bool get(Window win, Atoms atom, StringType type, std::string *value) const;
+ //! Gets strings from the value of a property on a window
+ /*!
+ @param win The window id of the window to get the property value from
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to retrieve
+ @param type A member of the OBProperty::StringType enum that specifies the
+ type of the string property to retrieve
+ @param nelements The maximum number of strings to retrieve from the
+ property (assuming it has more than 1 string in it). To
+ retrieve all possible strings, use "(unsigned) -1".<br>
+ When the function returns, if it returns true, this will
+ contain the actual number of strings retrieved.<br>
+ @param value If the function returns true, then this contains all of the
+ strings retrieved from the property's value.
+ @return true if retrieval of the specified property with the specified
+ type was successful; otherwise, false
+ */
+ bool get(Window win, Atoms atom, StringType type,
+ unsigned long *nelements, StringVect *strings) const;
+
+ //! Removes a property from a window
+ /*!
+ @param The window id of the window to remove the property from
+ @param A member of the OBProperty::Atoms enum that specifies which property
+ to remove from the window
+ */
+ void erase(Window win, Atoms atom) const;
+
+ //! Gets the value of an atom on the X server
+ /*!
+ @param a A member of the OBProperty::Atoms enum that specifies which Atom's
+ value to return
+ @return The value of the specified Atom
+ */
+ inline Atom atom(Atoms a) {
+ assert(a >= 0 && a < NUM_ATOMS); Atom ret = _atoms[a]; assert(ret != 0);
+ return ret;
+ }
+};
+
+}
+
+#endif // __atom_hh
projects / chaz / openbox / commitdiff
