gracefully handle grabs failing when doing interactive actions

[chaz/openbox] / openbox / client.h

diff --git a/openbox/client.h b/openbox/client.h
index 4d6ee56c6d9aef95e160aab234cd37bd85415b07..aeb2160e47aa4716548287cc8d04ba6fa05b057c 100644 (file)
--- a/openbox/client.h
+++ b/openbox/client.h
@@ -1,3 +1,21 @@
+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+   client.h for the Openbox window manager
+   Copyright (c) 2003        Ben Jansens
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   See the COPYING file for a copy of the GNU General Public License.
+*/
+
 #ifndef __client_h
 #define __client_h
 
@@ -119,6 +137,11 @@ struct _ObClient
     */
     Rect area;
 
+    /*! Position and size of the window prior to being maximized */
+    Rect pre_max_area;
+    /*! Position and size of the window prior to being fullscreened */
+    Rect pre_fullscreen_area;
+
     /*! The window's strut
       The strut defines areas of the screen that are marked off-bounds for
       window placement. In theory, where this window exists.
@@ -227,10 +250,10 @@ struct _ObClient
     */
     guint decorations;
 
-    /*! A user option. When this is set to FALSE the client will not ever
+    /*! A user option. When this is set to TRUE the client will not ever
       be decorated.
     */
-    gboolean decorate;
+    gboolean undecorated;
 
     /*! A bitmask of values in the ObFunctions enum
       The values in the variable specify the ways in which the user is allowed
@@ -249,8 +272,10 @@ extern GList *client_list;
 void client_startup(gboolean reconfig);
 void client_shutdown(gboolean reconfig);
 
-void client_add_destructor(GDestroyNotify func);
-void client_remove_destructor(GDestroyNotify func);
+typedef void (*ObClientDestructor)(ObClient *client, gpointer data);
+
+void client_add_destructor(ObClientDestructor func, gpointer data);
+void client_remove_destructor(ObClientDestructor func);
 
 /*! Manages all existing windows */
 void client_manage_all();
@@ -428,6 +453,26 @@ void client_activate(ObClient *self, gboolean here);
 /*! Calculates the stacking layer for the client window */
 void client_calc_layer(ObClient *self);
 
+/*! Raises the client to the top of its stacking layer
+  Normally actions call to the client_* functions to make stuff go, but this
+  one is an exception. It just fires off an action, which will be queued.
+  This is because stacking order rules can be changed by focus state, and so
+  any time focus changes you have to wait for it to complete before you can
+  properly restart windows. As such, this only queues an action for later
+  execution, once the focus change has gone through.
+*/
+void client_raise(ObClient *self);
+
+/*! Lowers the client to the bottom of its stacking layer
+  Normally actions call to the client_* functions to make stuff go, but this
+  one is an exception. It just fires off an action, which will be queued.
+  This is because stacking order rules can be changed by focus state, and so
+  any time focus changes you have to wait for it to complete before you can
+  properly restart windows. As such, this only queues an action for later
+  execution, once the focus change has gone through.
+*/
+void client_lower(ObClient *self);
+
 /*! Updates the window's transient status, and any parents of it */
 void client_update_transient_for(ObClient *self);
 /*! Update the protocols that the window supports and adjusts things if they
@@ -460,7 +505,13 @@ void client_setup_decor_and_functions(ObClient *self);
 /*! Retrieves the window's type and sets ObClient->type */
 void client_get_type(ObClient *self);
 
-ObClientIcon *client_icon(ObClient *self, int w, int h);
+const ObClientIcon *client_icon(ObClient *self, int w, int h);
+
+/*! Searches a client's direct parents for a focused window. The function does
+  not check for the passed client, only for *ONE LEVEL* of its parents.
+  If no focused parentt is found, NULL is returned.
+*/
+ObClient *client_search_focus_parent(ObClient *self);
 
 /*! Searches a client's transients for a focused window. The function does not
   check for the passed client, only for its transients.
@@ -482,6 +533,12 @@ ObClient *client_search_modal_child(ObClient *self);
 
 ObClient *client_search_top_transient(ObClient *self);
 
+/*! Search for a parent of a client. This only searches up *ONE LEVEL*, and
+  returns the searched for parent if it is a parent, or NULL if not. */
+ObClient *client_search_parent(ObClient *self, ObClient *search);
+
+/*! Search for a transient of a client. The transient is returned if it is one,
+  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" client in the given direction */
@@ -497,8 +554,15 @@ int client_directional_edge_search(ObClient *c, ObDirection dir);
 */
 void client_set_layer(ObClient *self, int layer);
 
+/*! Set a client window to have decorations or not */
+void client_set_undecorated(ObClient *self, gboolean undecorated);
+
 guint client_monitor(ObClient *self);
 
 void client_update_sm_client_id(ObClient *self);
 
+ObClient* client_under_pointer();
+
+gboolean client_has_group_siblings(ObClient *self);
+
 #endif