Make RaiseLower work for the dock as well

[dana/openbox.git] / openbox / stacking.h

diff --git a/openbox/stacking.h b/openbox/stacking.h
index d570c94..ebfa175 100644 (file)
--- a/openbox/stacking.h
+++ b/openbox/stacking.h
@@ -20,60 +20,66 @@
 #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_FULLSCREEN,  /*!< 4 - fullscreeen windows */
-    OB_STACKING_LAYER_INTERNAL,    /*!< 5 - 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;
+/* 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(ObWindow *window, ObWindow *below);
-
-/*! Returns TRUE if client is occluded by sibling. If sibling is NULL it tries
-  against all other clients. Otherwise, it returns FALSE.
-*/
-gboolean stacking_occluded(struct _ObClient *client,struct _ObClient *sibling);
+void stacking_below(struct _ObWindow *window, struct _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
+  @param sibling A window 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.
 */
-void stacking_restack_request(struct _ObClient *client,
-                              struct _ObClient *sibling,
-                              gint detail);
+gboolean stacking_restack_request(struct _ObClient *client,
+                                  struct _ObWindow *sibling_win,
+                                  gint detail);
 
 #endif