merge the C branch into HEAD
[mikachu/openbox.git] / openbox / stacking.h
1 #ifndef __stacking_h
2 #define __stacking_h
3
4 #include <glib.h>
5
6 struct Client;
7
8 /*! The possible stacking layers a client window can be a part of */
9 typedef enum {
10     Layer_Icon,       /*!< 0 - iconified windows, in any order at all */
11     Layer_Desktop,    /*!< 1 - desktop windows */
12     Layer_Below,      /*!< 2 - normal windows w/ below */
13     Layer_Normal,     /*!< 3 - normal windows */
14     Layer_Above,      /*!< 4 - normal windows w/ above */
15     Layer_Top,        /*!< 5 - always-on-top-windows (docks?) */
16     Layer_Fullscreen, /*!< 6 - fullscreeen windows */
17     Layer_Internal    /*!< 7 - openbox windows/menus */
18 } StackLayer;
19
20 /* list of Client*s in stacking order from highest to lowest */
21 extern GList  *stacking_list;
22
23 /*! Sets the client stacking list on the root window from the
24   stacking_clientlist */
25 void stacking_set_list();
26
27 /*! Raises a client window above all others in its stacking layer
28   raiseWindow has a couple of constraints that lowerWindow does not.<br>
29   1) raiseWindow can be called after changing a Client's stack layer, and
30      the list will be reorganized properly.<br>
31   2) raiseWindow guarantees that XRestackWindows() will <i>always</i> be
32      called for the specified client.
33 */
34 void stacking_raise(struct Client *client);
35
36 /*! Lowers a client window below all others in its stacking layer */
37 void stacking_lower(struct Client *client);
38
39 #endif