add copyright headers, adjust --version output to include copyright, and --help outpu...

[chaz/openbox] / openbox / focus.h

diff --git a/openbox/focus.h b/openbox/focus.h
index ff5bc503a0b976fc417b79d5f50b54a101bd5397..e6606dd5968c4c8a19d09647489b9bf5eababaf5 100644 (file)
--- a/openbox/focus.h
+++ b/openbox/focus.h
@@ -1,39 +1,72 @@
+/* -*- indent-tabs-mode: t; tab-width: 4; c-basic-offset: 4; -*-
+
+   focus.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 __focus_h
 #define __focus_h
 
+#include "misc.h"
+
 #include <X11/Xlib.h>
 #include <glib.h>
 
-struct Client;
-
-/*! The window which gets focus when nothing else will be focused */
-extern Window focus_backup;
+struct _ObClient;
 
 /*! The client which is currently focused */
-extern struct Client *focus_client;
+extern struct _ObClient *focus_client;
+/*! The client which appears focused during a focus cycle operation */
+extern struct _ObClient *focus_cycle_target;
 
 /*! The recent focus order on each desktop */
 extern GList **focus_order;
 
-void focus_startup();
-void focus_shutdown();
+void focus_startup(gboolean reconfig);
+void focus_shutdown(gboolean reconfig);
 
 /*! Specify which client is currently focused, this doesn't actually
   send focus anywhere, its called by the Focus event handlers */
-void focus_set_client(struct Client *client);
+void focus_set_client(struct _ObClient *client);
 
 typedef enum {
-    Fallback_Desktop,    /* switching desktops */
-    Fallback_Unfocusing, /* forcefully remove focus from the current window */
-    Fallback_NoFocus     /* nothing has focus for some reason */
-} FallbackType;
+    OB_FOCUS_FALLBACK_UNFOCUSING, /*!< forcefully remove focus from the
+                                    current window */
+    OB_FOCUS_FALLBACK_NOFOCUS     /*!< nothing has focus for some reason */
+} ObFocusFallbackType;
 
 /*! Call this when you need to focus something! */
-void focus_fallback(FallbackType type);
+void focus_fallback(ObFocusFallbackType type);
+
+/*! Cycle focus amongst windows. */
+void focus_cycle(gboolean forward, gboolean linear,
+                 gboolean dialog, gboolean done, gboolean cancel);
+void focus_directional_cycle(ObDirection dir,
+                             gboolean dialog, gboolean done, gboolean cancel);
+
+/*! Add a new client into the focus order */
+void focus_order_add_new(struct _ObClient *c);
+
+/*! Remove a client from the focus order */
+void focus_order_remove(struct _ObClient *c);
+
+/*! Move a client to the top of the focus order */
+void focus_order_to_top(struct _ObClient *c);
 
-/*! Cycle focus amongst windows
-  Returns the Client to which focus has been cycled, or NULL if none. */
-struct Client *focus_cycle(gboolean forward, gboolean linear, gboolean done,
-                           gboolean cancel);
+/*! Move a client to the bottom of the focus order (keeps iconic windows at the
+  very bottom always though). */
+void focus_order_to_bottom(struct _ObClient *c);
 
 #endif