openbox/focus.h

   1 #ifndef __focus_h
   2 #define __focus_h
   3
   4 #include "misc.h"
   5
   6 #include <X11/Xlib.h>
   7 #include <glib.h>
   8
   9 struct _ObClient;
  10
  11 /*! The client which is currently focused */
  12 extern struct _ObClient *focus_client;
  13 /*! The client which appears focused during a focus cycle operation */
  14 extern struct _ObClient *focus_cycle_target;
  15
  16 /*! The recent focus order on each desktop */
  17 extern GList **focus_order;
  18
  19 void focus_startup(gboolean reconfig);
  20 void focus_shutdown(gboolean reconfig);
  21
  22 /*! Specify which client is currently focused, this doesn't actually
  23   send focus anywhere, its called by the Focus event handlers */
  24 void focus_set_client(struct _ObClient *client);
  25
  26 typedef enum {
  27     OB_FOCUS_FALLBACK_DESKTOP,    /*!< switching desktops */
  28     OB_FOCUS_FALLBACK_UNFOCUSING, /*!< forcefully remove focus from the
  29                                     current window */
  30     OB_FOCUS_FALLBACK_NOFOCUS     /*!< nothing has focus for some reason */
  31 } ObFocusFallbackType;
  32
  33 /*! Call this when you need to focus something! */
  34 void focus_fallback(ObFocusFallbackType type);
  35
  36 /*! Cycle focus amongst windows. */
  37 void focus_cycle(gboolean forward, gboolean linear,
  38                  gboolean dialog, gboolean done, gboolean cancel);
  39 void focus_directional_cycle(ObDirection dir,
  40                              gboolean dialog, gboolean done, gboolean cancel);
  41
  42 /*! Add a new client into the focus order */
  43 void focus_order_add_new(struct _ObClient *c);
  44
  45 /*! Remove a client from the focus order */
  46 void focus_order_remove(struct _ObClient *c);
  47
  48 /*! Move a client to the top of the focus order */
  49 void focus_order_to_top(struct _ObClient *c);
  50
  51 /*! Move a client to the bottom of the focus order (keeps iconic windows at the
  52   very bottom always though). */
  53 void focus_order_to_bottom(struct _ObClient *c);
  54
  55 #endif