improve comment
[mikachu/openbox.git] / openbox / client.h
index ed67792..83fdc9a 100644 (file)
 #include "mwm.h"
 #include "geom.h"
 #include "stacking.h"
+#include "window.h"
 #include "render/color.h"
 
 #include <glib.h>
 #include <X11/Xlib.h>
 
+#ifdef HAVE_SYS_TYPES_H
+#  include <sys/types.h> /* for pid_t */
+#endif
+
 struct _ObFrame;
 struct _ObGroup;
 struct _ObSessionState;
@@ -43,7 +48,7 @@ struct _ObClientIcon
     gint height;
     RrPixel32 *data;
 };
-     
+
 /*! Possible window types */
 typedef enum
 {
@@ -114,6 +119,8 @@ struct _ObClient
     gchar *client_machine;
     /*! The command used to run the program. Pre-XSMP window identification. */
     gchar *wm_command;
+    /*! The PID of the process which owns the window */
+    pid_t pid;
 
     /*! The application that created the window */
     gchar *name;
@@ -147,7 +154,7 @@ struct _ObClient
       window placement. In theory, where this window exists.
     */
     StrutPartial strut;
-     
+
     /*! The logical size of the window
       The "logical" size of the window is refers to the user's perception of
       the size of the window, and is the value that should be displayed to the
@@ -170,7 +177,7 @@ struct _ObClient
       A value of 0 means this is ignored.
     */
     gfloat max_ratio;
-  
+
     /*! The minimum size of the client window
       If the min is > the max, then the window is not resizable
     */
@@ -192,7 +199,7 @@ struct _ObClient
 
     /*! The client's specified colormap */
     Colormap colormap;
-  
+
     /*! Where to place the decorated window in relation to the undecorated
       window */
     gint gravity;
@@ -203,7 +210,7 @@ struct _ObClient
 
     /*! True if the client supports the delete_window protocol */
     gboolean delete_window;
-  
+
     /*! Was the window's position requested by the application or the user?
       if by the application, we force it completely onscreen, if by the user
       we only force it if it tries to go completely offscreen, if neither, we
@@ -213,12 +220,20 @@ struct _ObClient
     /*! Was the window's size requested by the application or the user?
       If by the application we don't let it go outside the available area */
     guint sized;
-  
+
     /*! Can the window receive input focus? */
     gboolean can_focus;
     /*! Notify the window when it receives focus? */
     gboolean focus_notify;
 
+    /*! Will the client respond to pings? */
+    gboolean ping;
+    /*! Indicates if the client is trying to close but has stopped responding
+      to pings */
+    gboolean not_responding;
+    /*! We tried to close the window with a SIGTERM */
+    gboolean close_tried_term;
+
 #ifdef SYNC
     /*! The client wants to sync during resizes */
     gboolean sync_request;
@@ -290,14 +305,11 @@ struct _ObClient
     /*! Where the window should iconify to/from */
     Rect icon_geometry;
 
-    /*! The time when the client last received user interaction */
-    guint32 user_time;
-    /*! A separate window for the client to update it's user_time on */
-    Window  user_time_window;
+    /*! A boolean used for algorithms which need to mark clients as visited */
+    gboolean visited;
 };
 
 extern GList      *client_list;
-extern GHashTable *client_user_time_window_map;
 
 void client_startup(gboolean reconfig);
 void client_shutdown(gboolean reconfig);
@@ -455,6 +467,18 @@ gboolean client_find_onscreen(ObClient *self, gint *x, gint *y, gint w, gint h,
 */
 void client_move_onscreen(ObClient *self, gboolean rude);
 
+/*! dir is either North, South, East or West. It can't be, for example,
+  Northwest */
+void client_find_edge_directional(ObClient *self, ObDirection dir,
+                                  gint my_head, gint my_tail,
+                                  gint my_edge_start, gint my_edge_size,
+                                  gint *dest, gboolean *near_edge);
+void client_find_move_directional(ObClient *self, ObDirection dir,
+                                  gint *x, gint *y);
+void client_find_resize_directional(ObClient *self, ObDirection side,
+                                    gboolean grow,
+                                    gint *x, gint *y, gint *w, gint *h);
+
 /*! 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.
@@ -550,10 +574,13 @@ gboolean client_focus(ObClient *self);
   when the user deliberately selects a window for use.
   @param here If true, then the client is brought to the current desktop;
               otherwise, the desktop is changed to where the client lives.
+  @param raise If true, the client is brought to the front.
+  @param unshade If true, the client is unshaded (if it is shaded)
   @param user If true, then a user action is what requested the activation;
               otherwise, it means an application requested it on its own
 */
-void client_activate(ObClient *self, gboolean here, gboolean user);
+void client_activate(ObClient *self, gboolean here, gboolean raise,
+                     gboolean unshade, gboolean user);
 
 /*! Bring all of its helper windows to its desktop. These are the utility and
   stuff windows. */
@@ -591,10 +618,6 @@ void client_update_title(ObClient *self);
 void client_update_strut(ObClient *self);
 /*! Updates the window's icons */
 void client_update_icons(ObClient *self);
-/*! Updates the window's user time */
-void client_update_user_time(ObClient *self);
-/*! Updates the window's user time window */
-void client_update_user_time_window(ObClient *self);
 /*! Updates the window's icon geometry (where to iconify to/from) */
 void client_update_icon_geometry(ObClient *self);
 
@@ -668,7 +691,9 @@ ObClient *client_direct_parent(ObClient *self);
 */
 ObClient *client_search_top_direct_parent(ObClient *self);
 
-/*! Is one client a direct child of another (i.e. not through the group.) */
+/*! Is one client a direct child of another (i.e. not through the group.)
+  This checks more than one level, so there may be another direct child in
+  between */
 gboolean client_is_direct_child(ObClient *parent, ObClient *child);
 
 /*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
@@ -679,9 +704,6 @@ ObClient *client_search_parent(ObClient *self, ObClient *search);
   NULL is returned if the given search is not a transient of the client. */
 ObClient *client_search_transient(ObClient *self, ObClient *search);
 
-/*! Return the closest edge in the given direction */
-gint client_directional_edge_search(ObClient *c, ObDirection dir, gboolean hang);
-
 /*! Set a client window to be above/below other clients.
   @layer < 0 indicates the client should be placed below other clients.<br />
          = 0 indicates the client should be placed with other clients.<br />