fallback to transients' parents when possible.

[chaz/openbox] / openbox / client.h

diff --git a/openbox/client.h b/openbox/client.h
index e01e2ebeeabc7c1a266a7c7fd27232352ad18712..3ab555b00097706f63e7f7044ac5ebb96055a75d 100644 (file)
--- a/openbox/client.h
+++ b/openbox/client.h
@@ -7,7 +7,11 @@
 #include <X11/Xlib.h>
 
 struct Frame;
+struct Group;
 
+/* The value in client.transient_for indicating it is a transient for its
+   group instead of for a single window */
+#define TRAN_GROUP ((void*)~0l)
 
 /*! Holds an icon in ARGB format */
 typedef struct Icon {
@@ -100,7 +104,8 @@ typedef enum {
     /*! Display a button to toggle the window's placement on
       all desktops */
     Decor_AllDesktops = 1 << 6,
-    Decor_Close       = 1 << 7  /*!< Display a close button */
+    Decor_Shade       = 1 << 7, /*!< Displays a shade button */
+    Decor_Close       = 1 << 8  /*!< Display a close button */
 } Decoration;
 
 
@@ -113,12 +118,16 @@ typedef struct Client {
     int ignore_unmaps;
 
     /*! The id of the group the window belongs to */
-    Window  group;
+    struct Group *group;
     /*! Whether or not the client is a transient window. This is guaranteed to 
       be TRUE if transient_for != NULL, but not guaranteed to be FALSE if
       transient_for == NULL. */
     gboolean transient;
-    /*! The client which this client is a transient (child) for */
+    /*! The client which this client is a transient (child) for.
+      A value of TRAN_GROUP signifies that the window is a transient for all
+      members of its Group, and is not a valid pointer to be followed in this
+      case.
+     */
     struct Client *transient_for;
     /*! The clients which are transients (children) of this client */
     GSList *transients;
@@ -284,7 +293,7 @@ typedef struct Client {
     Pixmap pixmap_icon_mask;
 } Client;
 
-extern GSList *client_list;
+extern GList *client_list;
 extern GHashTable *client_map;
 
 void client_startup();
@@ -381,7 +390,9 @@ void client_close(Client *self);
 /*! Kill the client off violently */
 void client_kill(Client *self);
 
-/*! Sends the window to the specified desktop */
+/*! Sends the window to the specified desktop
+  @param donthide If TRUE, the window will not be shown/hidden after its
+         desktop has been changed. Generally this should be FALSE. */
 void client_set_desktop(Client *self, guint target, gboolean donthide);
 
 /*! Return a modal child of the client window
@@ -407,6 +418,14 @@ void client_set_wm_state(Client *self, long state);
 */
 void client_set_state(Client *self, Atom action, long data1, long data2);
 
+/* Given a Client, find the client that focus would actually be sent to if
+   you wanted to give focus to the specified Client. Will return the same
+   Client passed to it or another Client if appropriate. */
+Client *client_focus_target(Client *self);
+
+/* Returns if a client can be focused or not */
+gboolean client_focusable(Client *self);
+
 /*! Attempt to focus the client window */
 gboolean client_focus(Client *self);