]> Dogcows Code - chaz/openbox/blobdiff - openbox/client.h
all my changes while i was offline.
[chaz/openbox] / openbox / client.h
index 808f4e5f8a6f2aee151483bce96400d0ba2370a7..faa04e63c2d2346ebe89b286da88ca5736fb1c12 100644 (file)
@@ -7,11 +7,15 @@
 #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 {
-    unsigned long w, h;
+    unsigned long width, height;
     unsigned long *data;
 } Icon;
      
@@ -100,34 +104,43 @@ 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;
 
 
 typedef struct Client {
     Window  window;
 
+    /*! The window's decorations. NULL while the window is being managed! */
     struct Frame *frame;
 
     /*! The number of unmap events to ignore on the window */
     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;
     /*! The desktop on which the window resides (0xffffffff for all
       desktops) */
-    unsigned int desktop;
+    guint desktop;
 
     /*! Normal window title */
     gchar *title;
+    /*! The count for the title. When another window with the same title
+      exists, a count will be appended to it. */
+    guint title_count;
     /*! Window title when iconified */
     gchar *icon_title;
 
@@ -267,12 +280,6 @@ typedef struct Client {
     */
     int functions;
 
-    /*! Saved decorations from before becoming fullscreen */
-    int pre_fs_decor;
-
-    /*! Saved functions from before becoming fullscreen */
-    int pre_fs_func;
-
     /*! Icons for the client as specified on the client window */
     Icon *icons;
     /*! The number of icons in icons */
@@ -284,7 +291,7 @@ typedef struct Client {
     Pixmap pixmap_icon_mask;
 } Client;
 
-extern GSList *client_list;
+extern GList *client_list;
 extern GHashTable *client_map;
 
 void client_startup();
@@ -320,11 +327,6 @@ gboolean client_normal(Client *self);
 /* Returns if the window is focused */
 gboolean client_focused(Client *self);
 
-/*! Sets the client to a focused or unfocused state. This does not actually
-  change the input focus, but rather is used once focus has been moved to tell
-  the client that it is so. */
-void client_set_focused(Client *self, gboolean focused);
-
 /*! Move and/or resize the window.
   This also maintains things like the client's minsize, and size increments.
   @param anchor The corner to keep in the same position when resizing.
@@ -343,6 +345,11 @@ void client_set_focused(Client *self, gboolean focused);
 void client_configure(Client *self, Corner anchor, int x, int y, int w, int h,
                      gboolean user, gboolean final);
 
+/*! Moves a client so that it is on screen if it is entirely out of the
+  viewable screen.
+*/
+void client_move_onscreen(Client *self);
+
 /*! Fullscreen's or unfullscreen's the client window
   @param fs true if the window should be made fullscreen; false if it should
             be returned to normal state.
@@ -386,13 +393,10 @@ void client_close(Client *self);
 /*! Kill the client off violently */
 void client_kill(Client *self);
 
-/*! Sends the window to the specified desktop */
-void client_set_desktop(Client *self, guint target);
-
-/*! Return a modal child of the client window
-    @return A modal child of the client window, or 0 if none was found.
-*/
-Client *client_find_modal_child(Client *self);
+/*! 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);
 
 /*! Validate client, by making sure no Destroy or Unmap events exist in
   the event queue for the window.
@@ -412,6 +416,11 @@ 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);
+
 /*! Attempt to focus the client window */
 gboolean client_focus(Client *self);
 
@@ -435,10 +444,8 @@ void client_update_normal_hints(Client *self);
                   process.
 */
 void client_update_wmhints(Client *self);
-/*! Updates the window's title */
+/*! Updates the window's title and icon title */
 void client_update_title(Client *self);
-/*! Updates the window's icon title */
-void client_update_icon_title(Client *self);
 /*! Updates the window's application name and class */
 void client_update_class(Client *self);
 /*! Updates the strut for the client */
@@ -457,4 +464,23 @@ void client_setup_decor_and_functions(Client *self);
 /*! Retrieves the window's type and sets Client->type */
 void client_get_type(Client *self);
 
+Icon *client_icon(Client *self, int w, int h);
+
+/*! Searches a client's transients for a focused window. The function does not
+  check for the passed client, only for its transients.
+  If no focused transient is found, NULL is returned.
+*/
+Client *client_search_focus_tree(Client *self);
+
+/*! Searches a client's transient tree for a focused window. The function
+  searches up the tree and down other branches as well as the passed client's.
+  If no focused client is found, NULL is returned.
+*/
+Client *client_search_focus_tree_full(Client *self);
+
+/*! Return a modal child of the client window
+    @return A modal child of the client window, or 0 if none was found.
+*/
+Client *client_search_modal_child(Client *self);
+
 #endif
This page took 0.026053 seconds and 4 git commands to generate.