add support for _NET_RESTACK_WINDOW
[dana/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) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #ifndef __stacking_h
21 #define __stacking_h
22
23 #include "window.h"
24
25 #include <glib.h>
26 #include <X11/Xlib.h>
27
28 /*! The possible stacking layers a client window can be a part of */
29 typedef enum {
30     OB_STACKING_LAYER_DESKTOP,     /*!< 0 - desktop windows */
31     OB_STACKING_LAYER_BELOW,       /*!< 1 - normal windows w/ below */
32     OB_STACKING_LAYER_NORMAL,      /*!< 2 - normal windows */
33     OB_STACKING_LAYER_ABOVE,       /*!< 3 - normal windows w/ above */
34     OB_STACKING_LAYER_FULLSCREEN,  /*!< 4 - fullscreeen windows */
35     OB_STACKING_LAYER_INTERNAL,    /*!< 5 - openbox windows/menus */
36     OB_NUM_STACKING_LAYERS
37 } ObStackingLayer;
38
39 /* list of ObWindow*s in stacking order from highest to lowest */
40 extern GList *stacking_list;
41
42 /*! Sets the window stacking list on the root window from the
43   stacking_list */
44 void stacking_set_list();
45
46 void stacking_add(ObWindow *win);
47 void stacking_add_nonintrusive(ObWindow *win);
48 #define stacking_remove(win) stacking_list = g_list_remove(stacking_list, win);
49
50 /*! Raises a window above all others in its stacking layer */
51 void stacking_raise(ObWindow *window);
52
53 /*! Lowers a window below all others in its stacking layer */
54 void stacking_lower(ObWindow *window);
55
56 /*! Moves a window below another if its in the same layer.
57   This function does not enforce stacking rules IRT transients n such, and so
58   it should really ONLY be used to restore stacking orders from saved sessions
59 */
60 void stacking_below(ObWindow *window, ObWindow *below);
61
62 /*! Returns TRUE if client is occluded by sibling. If sibling is NULL it tries
63   against all other clients. Otherwise, it returns FALSE.
64 */
65 gboolean stacking_occluded(struct _ObClient *client,struct _ObClient *sibling);
66
67 /*! Restack a window based upon a sibling (or all windows) in various ways.
68   @param client The client to be restacked
69   @param sibling Another client to compare to, or NULL to compare to all
70                  windows
71   @param detail One of Above, Below, TopIf, BottomIf, Opposite
72   See http://tronche.com/gui/x/xlib/window/configure.html for details on
73   how each detail works with and without a sibling.
74 */
75 void stacking_restack_request(struct _ObClient *client,
76                               struct _ObClient *sibling,
77                               gint detail);
78
79 #endif