add a NONE user action, for internal stuff, ie running actions without direct user...

[chaz/openbox] / openbox / client.h

diff --git a/openbox/client.h b/openbox/client.h
index b28acab2dbe77aca7999128c095142b840c7232b..0c523debeabdf8f4490fdbfa4806cdd6f878f4d3 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
 
@@ -88,6 +106,10 @@ struct _ObClient
       desktops) */
     guint desktop;
 
+    /*! The startup id for the startup-notification protocol. This will be
+      NULL if a startup id is not set. */
+    gchar *startup_id;
+
     /*! Normal window title */
     gchar *title;
     /*! The count for the title. When another window with the same title
@@ -102,6 +124,8 @@ struct _ObClient
     gchar *class;
     /*! The specified role of the window, used for identification */
     gchar *role;
+    /*! The session client id for the window. *This can be NULL!* */
+    gchar *sm_client_id;
 
     /*! The type of window (what its function is) */
     ObClientType type;
@@ -113,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.
@@ -221,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
@@ -240,13 +269,11 @@ struct _ObClient
 
 extern GList *client_list;
 
-void client_startup();
-void client_shutdown();
-
-typedef void (*ObClientDestructorFunc)(ObClient *c);
+void client_startup(gboolean reconfig);
+void client_shutdown(gboolean reconfig);
 
-void client_add_destructor(ObClientDestructorFunc func);
-void client_remove_destructor(ObClientDestructorFunc func);
+void client_add_destructor(GDestroyNotify func);
+void client_remove_destructor(GDestroyNotify func);
 
 /*! Manages all existing windows */
 void client_manage_all();
@@ -458,6 +485,12 @@ void client_get_type(ObClient *self);
 
 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.
   If no focused transient is found, NULL is returned.
@@ -478,6 +511,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 */
@@ -493,8 +532,13 @@ 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);
 
-gchar* client_get_sm_client_id(ObClient *self);
+void client_update_sm_client_id(ObClient *self);
+
+ObClient* client_under_pointer();
 
 #endif