openbox/focus_cycle_popup.h

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    focus_cycle.h for the Openbox window manager
   4    Copyright (c) 2006        Mikael Magnusson
   5    Copyright (c) 2003-2007   Dana 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_cycle_popup_h
  21 #define __focus_cycle_popup_h
  22
  23 struct _ObClient;
  24 struct _ObClientSet;
  25
  26 #include <glib.h>
  27
  28 typedef enum {
  29     OB_FOCUS_CYCLE_POPUP_MODE_NONE,
  30     OB_FOCUS_CYCLE_POPUP_MODE_ICONS,
  31     OB_FOCUS_CYCLE_POPUP_MODE_LIST
  32 } ObFocusCyclePopupMode;
  33
  34 void focus_cycle_popup_startup(gboolean reconfig);
  35 void focus_cycle_popup_shutdown(gboolean reconfig);
  36
  37 void focus_cycle_popup_show(const struct _ObClientSet *set,
  38                             struct _ObClient *c,
  39                             ObFocusCyclePopupMode mode, gboolean linear);
  40 void focus_cycle_popup_hide(void);
  41
  42 void focus_cycle_popup_single_show(struct _ObClient *c);
  43 void focus_cycle_popup_single_hide(void);
  44
  45 gboolean focus_cycle_popup_is_showing(struct _ObClient *c);
  46
  47 /*! Redraws the focus cycle popup, and returns the current target.  If
  48     the target given to the function is no longer valid, this will return
  49     a different target that is valid, and which should be considered the
  50     current focus cycling target. */
  51 struct _ObClient *focus_cycle_popup_refresh(const struct _ObClientSet *set,
  52                                             struct _ObClient *target,
  53                                             gboolean redraw,
  54                                             gboolean linear);
  55
  56 #endif