openbox/focus.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    focus.h for the Openbox window manager
   4    Copyright (c) 2003        Ben Jansens
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #ifndef __focus_h
  20 #define __focus_h
  21
  22 #include "misc.h"
  23
  24 #include <X11/Xlib.h>
  25 #include <glib.h>
  26
  27 struct _ObClient;
  28
  29 /*! The client which is currently focused */
  30 extern struct _ObClient *focus_client;
  31 /*! The client which appears focused during a focus cycle operation */
  32 extern struct _ObClient *focus_cycle_target;
  33
  34 /*! The recent focus order on each desktop */
  35 extern GList **focus_order;
  36
  37 void focus_startup(gboolean reconfig);
  38 void focus_shutdown(gboolean reconfig);
  39
  40 /*! Specify which client is currently focused, this doesn't actually
  41   send focus anywhere, its called by the Focus event handlers */
  42 void focus_set_client(struct _ObClient *client);
  43
  44 typedef enum {
  45     OB_FOCUS_FALLBACK_UNFOCUSING, /*!< forcefully remove focus from the
  46                                     current window */
  47     OB_FOCUS_FALLBACK_NOFOCUS     /*!< nothing has focus for some reason */
  48 } ObFocusFallbackType;
  49
  50 /*! Call this when you need to focus something! */
  51 void focus_fallback(ObFocusFallbackType type);
  52
  53 /*! Cycle focus amongst windows. */
  54 void focus_cycle(gboolean forward, gboolean linear,
  55                  gboolean dialog, gboolean done, gboolean cancel);
  56 void focus_directional_cycle(ObDirection dir,
  57                              gboolean dialog, gboolean done, gboolean cancel);
  58
  59 /*! Add a new client into the focus order */
  60 void focus_order_add_new(struct _ObClient *c);
  61
  62 /*! Remove a client from the focus order */
  63 void focus_order_remove(struct _ObClient *c);
  64
  65 /*! Move a client to the top of the focus order */
  66 void focus_order_to_top(struct _ObClient *c);
  67
  68 /*! Move a client to the bottom of the focus order (keeps iconic windows at the
  69   very bottom always though). */
  70 void focus_order_to_bottom(struct _ObClient *c);
  71
  72 #endif