X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=openbox%2Fstacking.h;h=c14aa2eddb59e62819f73ae4eb45e2e14a5d92e2;hb=HEAD;hp=083d20249f57559ea92f5df758797257139ccf6d;hpb=7120face258ee4bd71fb19ded271665acde6465c;p=chaz%2Fopenbox

diff --git a/openbox/stacking.h b/openbox/stacking.h
index 083d2024..c14aa2ed 100644
--- a/openbox/stacking.h
+++ b/openbox/stacking.h
@@ -1,41 +1,85 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   stacking.h for the Openbox window manager
+   Copyright (c) 2006        Mikael Magnusson
+   Copyright (c) 2003-2007   Dana Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
 #ifndef __stacking_h
 #define __stacking_h
 
-#include "window.h"
-
 #include <glib.h>
 #include <X11/Xlib.h>
 
+struct _ObWindow;
+struct _ObClient;
+
 /*! The possible stacking layers a client window can be a part of */
 typedef enum {
-    OB_STACKING_LAYER_DESKTOP,    /*!< 0 - desktop windows */
-    OB_STACKING_LAYER_BELOW,      /*!< 1 - normal windows w/ below */
-    OB_STACKING_LAYER_NORMAL,     /*!< 2 - normal windows */
-    OB_STACKING_LAYER_ABOVE,      /*!< 3 - normal windows w/ above */
-    OB_STACKING_LAYER_TOP,        /*!< 4 - always-on-top-windows (docks?) */
-    OB_STACKING_LAYER_FULLSCREEN, /*!< 5 - fullscreeen windows */
-    OB_STACKING_LAYER_INTERNAL,   /*!< 6 - openbox windows/menus */
+    OB_STACKING_LAYER_INVALID,
+    OB_STACKING_LAYER_DESKTOP,          /*!< 0 - desktop windows */
+    OB_STACKING_LAYER_BELOW,            /*!< 1 - normal windows w/ below */
+    OB_STACKING_LAYER_NORMAL,           /*!< 2 - normal windows */
+    OB_STACKING_LAYER_ABOVE,            /*!< 3 - normal windows w/ above */
+    OB_STACKING_LAYER_FULLSCREEN,       /*!< 4 - fullscreeen windows */
+    OB_STACKING_LAYER_INTERNAL,         /*!< 5 - openbox windows/menus */
     OB_NUM_STACKING_LAYERS
 } ObStackingLayer;
 
 /* list of ObWindow*s in stacking order from highest to lowest */
-extern GList  *stacking_list;
+extern GList *stacking_list;
+/* list of ObWindow*s in stacking order from lowest to highest */
+extern GList *stacking_list_tail;
 
 /*! Sets the window stacking list on the root window from the
   stacking_list */
-void stacking_set_list();
+void stacking_set_list(void);
 
-void stacking_add(ObWindow *win);
-void stacking_add_nonintrusive(ObWindow *win);
+void stacking_add(struct _ObWindow *win);
+void stacking_add_nonintrusive(struct _ObWindow *win);
 #define stacking_remove(win) stacking_list = g_list_remove(stacking_list, win);
 
 /*! Raises a window above all others in its stacking layer */
-void stacking_raise(ObWindow *window);
+void stacking_raise(struct _ObWindow *window);
+
+/*! Temporarily raises a window above all others */
+void stacking_temp_raise(struct _ObWindow *window);
+
+/*! Restores any temporarily raised windows to their correct place */
+void stacking_restore(void);
 
 /*! Lowers a window below all others in its stacking layer */
-void stacking_lower(ObWindow *window);
+void stacking_lower(struct _ObWindow *window);
+
+/*! Moves a window below another if its in the same layer.
+  This function does not enforce stacking rules IRT transients n such, and so
+  it should really ONLY be used to restore stacking orders from saved sessions
+*/
+void stacking_below(struct _ObWindow *window, struct _ObWindow *below);
 
-/*! Moves a window below another if its in the same layer */
-void stacking_below(ObWindow *window, ObWindow *below);
+/*! Restack a window based upon a sibling (or all windows) in various ways.
+  @param client The client to be restacked
+  @param sibling Another client to compare to, or NULL to compare to all
+                 windows
+  @param detail One of Above, Below, TopIf, BottomIf, Opposite
+  @return TRUE if the client was restacked
+  See http://tronche.com/gui/x/xlib/window/configure.html for details on
+  how each detail works with and without a sibling.
+*/
+gboolean stacking_restack_request(struct _ObClient *client,
+                                  struct _ObClient *sibling,
+                                  gint detail);
 
 #endif