symmetry..tho it's not used right now

[chaz/openbox] / openbox / stacking.h

diff --git a/openbox/stacking.h b/openbox/stacking.h
index 70e4b2d4e3a81bc470fba56edd9e71137269fe0f..ac9c8239cdc000fa2ec527df172968dcbc1277cf 100644 (file)
--- a/openbox/stacking.h
+++ b/openbox/stacking.h
@@ -27,12 +27,13 @@
 
 /*! 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;
 
@@ -59,9 +60,17 @@ void stacking_lower(ObWindow *window);
 */
 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.
+/*! 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_occluded(struct _ObClient *client,struct _ObClient *sibling);
+gboolean stacking_restack_request(struct _ObClient *client,
+                                  struct _ObClient *sibling,
+                                  gint detail);
 
 #endif