add a dock below layer, and dock above layer
[mikachu/openbox.git] / openbox / stacking.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    stacking.h for the Openbox window manager
4    Copyright (c) 2003        Ben Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __stacking_h
20 #define __stacking_h
21
22 #include "window.h"
23
24 #include <glib.h>
25 #include <X11/Xlib.h>
26
27 /*! The possible stacking layers a client window can be a part of */
28 typedef enum {
29     OB_STACKING_LAYER_DESKTOP,    /*!< 0 - desktop windows */
30     OB_STACKING_LAYER_DOCK_BELOW, /*!< 1 - dock windows set to below */
31     OB_STACKING_LAYER_BELOW,      /*!< 2 - normal windows w/ below */
32     OB_STACKING_LAYER_NORMAL,     /*!< 3 - normal windows */
33     OB_STACKING_LAYER_ABOVE,      /*!< 4 - normal windows w/ above */
34     OB_STACKING_LAYER_DOCK_ABOVE, /*!< 5 - dock windows set to on top */
35     OB_STACKING_LAYER_FULLSCREEN, /*!< 6 - fullscreeen windows */
36     OB_STACKING_LAYER_INTERNAL,   /*!< 7 - openbox windows/menus */
37     OB_NUM_STACKING_LAYERS
38 } ObStackingLayer;
39
40 /* list of ObWindow*s in stacking order from highest to lowest */
41 extern GList *stacking_list;
42
43 /*! Sets the window stacking list on the root window from the
44   stacking_list */
45 void stacking_set_list();
46
47 void stacking_add(ObWindow *win);
48 void stacking_add_nonintrusive(ObWindow *win);
49 #define stacking_remove(win) stacking_list = g_list_remove(stacking_list, win);
50
51 /*! Raises a window above all others in its stacking layer */
52 void stacking_raise(ObWindow *window);
53
54 /*! Lowers a window below all others in its stacking layer */
55 void stacking_lower(ObWindow *window);
56
57 /*! Moves a window below another if its in the same layer.
58   This function does not enforce stacking rules IRT transients n such, and so
59   it should really ONLY be used to restore stacking orders from saved sessions
60 */
61 void stacking_below(ObWindow *window, ObWindow *below);
62
63 #endif