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