class Frame;
class Screen;
+struct Icon {
+ unsigned long w, h;
+ unsigned long *data;
+};
+
//! The MWM Hints as retrieved from the window property
/*!
This structure only contains 3 elements, even though the Motif 2.0
enum Decoration { Decor_Titlebar = 1 << 0, //!< Display a titlebar
Decor_Handle = 1 << 1, //!< Display a handle (bottom)
Decor_Border = 1 << 2, //!< Display a border
- Decor_Iconify = 1 << 3, //!< Display an iconify button
- Decor_Maximize = 1 << 4, //!< Display a maximize button
+ Decor_Icon = 1 << 3, //!< Display the window's icon
+ Decor_Iconify = 1 << 4, //!< Display an iconify button
+ Decor_Maximize = 1 << 5, //!< Display a maximize button
//! Display a button to toggle the window's placement on
//! all desktops
- Decor_AllDesktops = 1 << 5,
- Decor_Close = 1 << 6 //!< Display a close button
+ Decor_AllDesktops = 1 << 6,
+ Decor_Close = 1 << 7 //!< Display a close button
};
//! Holds a bitmask of Client::Decoration values
typedef unsigned char DecorationFlags;
- //! Possible actions that can be made with the _NET_WM_STATE client message
- enum StateAction { State_Remove = 0, //!< _NET_WM_STATE_REMOVE
- State_Add, //!< _NET_WM_STATE_ADD
- State_Toggle //!< _NET_WM_STATE_TOGGLE
- };
-
//! The event mask to grab on client windows
static const long event_mask = PropertyChangeMask | FocusChangeMask |
StructureNotifyMask;
//! The window should be underneath other windows of the same type
bool _below;
+ //! The layer in which the window will be stacked, windows in lower layers
+ //! are always below windows in higher layers.
StackLayer _layer;
//! A bitmask of values in the Client::Decoration enum
*/
FunctionFlags _functions;
+ //! Icons for the client as specified on the client window
+ Icon *_icons;
+ //! The number of icons in _icons
+ int _nicons;
+
+ Pixmap _pixmap_icon;
+ Pixmap _pixmap_icon_mask;
+
//! Retrieves the window's initial gravity
void getGravity();
//! Retrieves the desktop hint's value and sets Client::_desktop
Client::applyStartupState is used to do the same things during the mapping
process.
*/
- void setState(StateAction action, long data1, long data2);
+ void setState(Atom action, long data1, long data2);
//! Sends the window to the specified desktop
void setDesktop(unsigned int desktop);
void updateStrut();
//! Updates the window's transient status, and any parents of it
void updateTransientFor();
+ //! Updates the window's icons
+ void updateIcons();
+ //! Updates the window's kwm icon
+ void updateKwmIcon();
//! Change the client's state hints to match the class' data
void changeState();
//! the topmost node (the window you're starting with).
Client *Client::searchModalTree(Client *node, Client *skip);
+ //! Recursively searches the client 'tree' for a focused client, always skips
+ //! the topmost node (the window you're starting with).
+ Client *Client::searchFocusTree(Client *node, Client *skip);
+
//! Fires the urgent callbacks which lets the user do what they want with
//! urgent windows
void fireUrgent();
void applyStartupState();
public:
-#ifndef SWIG
//! Constructs a new Client object around a specified window id
/*!
-BB @param window The window id that the Client class should handle
+ @param window The window id that the Client class should handle
@param screen The screen on which the window resides
*/
Client(int screen, Window window);
//! Destroys the Client object
virtual ~Client();
-#endif
//! Returns the screen on which the clien resides
inline int screen() const { return _screen; }
inline bool skipPager() const { return _skip_pager; }
//! The window should not be displayed by taskbars
inline bool skipTaskbar() const { return _skip_taskbar; }
- //! Returns if the window is shaded
+ //! Returns if the window is shaded
/*!
When the window is shaded, only its titlebar is visible.
*/
//! Returns the client's strut definition
inline const otk::Strut &strut() const { return _strut; }
+ //! Returns an icon for the window
+ /*!
+ The icon chosen will be the smallest icon available that is still bigger or
+ equal to the specified Size.<br>
+ If none that meet the requirements is found, the largest icon that is
+ smaller than the specified size will be returned.
+ */
+ const Icon *icon(const otk::Size &s) const;
+
+ //! Returns the pixmap for the pixmap icon specified on the window (or None)
+ /*!
+ The icon given by Client::icon should take precedence over this icon/mask.
+ */
+ Pixmap pixmapIcon() const { return _pixmap_icon; }
+ //! Returns the mask for the pixmap icon specified on the window (or None)
+ /*!
+ The icon given by Client::icon should take precedence over this icon/mask.
+ */
+ Pixmap pixmapIconMask() const { return _pixmap_icon_mask; }
+
//! Move the window (actually, its frame) to a position.
/*!
This moves the window so that the top-left corner of its frame will be at