X-Git-Url: https://git.brokenzipper.com/gitweb?a=blobdiff_plain;f=otk%2Fproperty.hh;h=9e2d7aca7c139e53757ed5d3b79a4de825166a4f;hb=fe55bb846db1933d8d6f023236298940cab441f8;hp=73a98e5dfa4b4d8b35952e5db388fa899f29b356;hpb=d2c380fb54a29a586b97ab6421370e7acdcf28e5;p=chaz%2Fopenbox
diff --git a/otk/property.hh b/otk/property.hh
index 73a98e5d..9e2d7aca 100644
--- a/otk/property.hh
+++ b/otk/property.hh
@@ -33,9 +33,7 @@ public:
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
+ openbox_pid,
// window hints
wm_colormap_windows,
@@ -136,26 +134,31 @@ public:
net_wm_state_skip_pager,
net_wm_state_hidden,
net_wm_state_fullscreen,
+ net_wm_state_floating,
kde_net_system_tray_windows,
kde_net_wm_system_tray_window_for,
kde_net_wm_window_type_override,
+#ifndef DOXYGEN_IGNORE
// constant for how many atoms exist in the enumerator
NUM_ATOMS
+#endif
};
//! The possible types/encodings of strings
enum StringType {
ascii, //!< Standard 8-bit ascii string
utf8, //!< Utf8-encoded string
+#ifndef DOXYGEN_IGNORE
NUM_STRING_TYPE
+#endif
};
private:
//! The value of all atoms on the X server that exist in the
//! OBProperty::Atoms enum
- Atom _atoms[NUM_ATOMS];
+ Atom _atoms[NUM_ATOMS];
//! Gets the value of an Atom from the X server, creating it if nessesary
Atom create(const char *name) const;
@@ -181,7 +184,7 @@ public:
//! Destroys the OBAtom object
virtual ~OBProperty();
- //! Sets a property on a window to a new value
+ //! Sets a single-value 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
@@ -191,7 +194,7 @@ public:
@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
+ //! Sets an multiple-value 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
@@ -204,7 +207,7 @@ public:
*/
void set(Window win, Atoms atom, Atoms type,
unsigned long value[], int elements) const;
- //! Sets a property on a window to a new value
+ //! Sets a string 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
@@ -215,7 +218,7 @@ public:
*/
void set(Window win, Atoms atom, StringType type,
const std::string &value) const;
- //! Sets a property on a window to a new value
+ //! Sets a string-array 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
@@ -291,8 +294,8 @@ public:
retrieve all possible strings, use "(unsigned) -1".
When the function returns, if it returns true, this will
contain the actual number of strings retrieved.
- @param value If the function returns true, then this contains all of the
- strings retrieved from the property's value.
+ @param strings 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
*/
@@ -301,9 +304,9 @@ public:
//! 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
+ @param win The window id of the window to remove the property from
+ @param atom A member of the OBProperty::Atoms enum that specifies which
+ property to remove from the window
*/
void erase(Window win, Atoms atom) const;
@@ -313,7 +316,7 @@ public:
value to return
@return The value of the specified Atom
*/
- inline Atom atom(Atoms a) {
+ inline Atom atom(Atoms a) const {
assert(a >= 0 && a < NUM_ATOMS); Atom ret = _atoms[a]; assert(ret != 0);
return ret;
}