gntbindable.h

   1 /**
   2  * @file gntbindable.h Bindable API
   3  * @ingroup gnt
   4  */
   5 /*
   6  * GNT - The GLib Ncurses Toolkit
   7  *
   8  * GNT is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This library is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26
  27 #ifndef GNT_BINDABLE_H
  28 #define GNT_BINDABLE_H
  29
  30 #include <stdio.h>
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include <ncurses.h>
  34
  35 #define GNT_TYPE_BINDABLE                               (gnt_bindable_get_gtype())
  36 #define GNT_BINDABLE(obj)                               (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_BINDABLE, GntBindable))
  37 #define GNT_BINDABLE_CLASS(klass)               (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_BINDABLE, GntBindableClass))
  38 #define GNT_IS_BINDABLE(obj)                    (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_BINDABLE))
  39 #define GNT_IS_BINDABLE_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_BINDABLE))
  40 #define GNT_BINDABLE_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_BINDABLE, GntBindableClass))
  41
  42 #define GNTDEBUG
  43
  44 typedef struct _GntBindable                     GntBindable;
  45 typedef struct _GntBindableClass                GntBindableClass;
  46
  47 struct _GntBindable
  48 {
  49         GObject inherit;
  50 };
  51
  52 struct _GntBindableClass
  53 {
  54         GObjectClass parent;
  55
  56         GHashTable *remaps;   /* Key remaps */
  57         GHashTable *actions;  /* name -> Action */
  58         GHashTable *bindings; /* key -> ActionParam */
  59
  60         GntBindable * help_window;
  61
  62         void (*gnt_reserved2)(void);
  63         void (*gnt_reserved3)(void);
  64         void (*gnt_reserved4)(void);
  65 };
  66
  67 G_BEGIN_DECLS
  68
  69 /**
  70  *
  71  *
  72  * @return
  73  */
  74 GType gnt_bindable_get_gtype(void);
  75
  76 /******************/
  77 /*   Key Remaps   */
  78 /******************/
  79 const char * gnt_bindable_remap_keys(GntBindable *bindable, const char *text);
  80
  81 /******************/
  82 /* Bindable Actions */
  83 /******************/
  84 typedef gboolean (*GntBindableActionCallback) (GntBindable *bindable, GList *params);
  85 typedef gboolean (*GntBindableActionCallbackNoParam)(GntBindable *bindable);
  86
  87 typedef struct _GntBindableAction GntBindableAction;
  88 typedef struct _GntBindableActionParam GntBindableActionParam;
  89
  90 struct _GntBindableAction
  91 {
  92         char *name;        /* The name of the action */
  93         union {
  94                 gboolean (*action)(GntBindable *bindable, GList *params);
  95                 gboolean (*action_noparam)(GntBindable *bindable);
  96         } u;
  97 };
  98
  99 struct _GntBindableActionParam
 100 {
 101         GntBindableAction *action;
 102         GList *list;
 103 };
 104
 105 /*GntBindableAction *gnt_bindable_action_parse(const char *name);*/
 106
 107 /**
 108  * Free a bindable action.
 109  *
 110  * @param action The bindable action.
 111  */
 112 void gnt_bindable_action_free(GntBindableAction *action);
 113
 114 /**
 115  * Free a GntBindableActionParam.
 116  *
 117  * @param param  The GntBindableActionParam to free.
 118  */
 119 void gnt_bindable_action_param_free(GntBindableActionParam *param);
 120
 121 /**
 122  * Register a bindable action for a class.
 123  *
 124  * @param klass      The class the binding is for.
 125  * @param name       The name of the binding.
 126  * @param callback   The callback  for the binding.
 127  * @param trigger    The default trigger for the binding, or @c NULL, followed by a NULL-terminated
 128  *                   list of default parameters.
 129  */
 130 void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
 131
 132 /**
 133  * Register a key-binding to an existing action.
 134  *
 135  * @param klass     The class the binding is for.
 136  * @param name      The name of the binding.
 137  * @param trigger   A new trigger for the binding, followed by a @c NULL-terminated list of parameters for the callback.
 138  */
 139 void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
 140
 141 /**
 142  * Perform an action from a keybinding.
 143  *
 144  * @param bindable  The bindable object.
 145  * @param keys      The key to trigger the action.
 146  *
 147  * @return  @c TRUE if the action was performed successfully, @c FALSE otherwise.
 148  */
 149 gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
 150
 151 /**
 152  * Perform an action on a bindable object.
 153  *
 154  * @param bindable  The bindable object.
 155  * @param name      The action to perform, followed by a @c NULL-terminated list of parameters.
 156  *
 157  * @return  @c TRUE if the action was performed successfully, @c FALSE otherwise.
 158  */
 159 gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...);
 160
 161 /**
 162  * Returns a GntTree populated with "key" -> "binding" for the widget.
 163  *
 164  * @param bind  The object to list the bindings for.
 165  *
 166  * @return   The GntTree.
 167  */
 168 GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
 169
 170 /**
 171  * Builds a window that list the key bindings for a GntBindable object.
 172  * From this window a user can select a listing to rebind a new key for the given action.
 173  *
 174  * @param bindable   The object to list the bindings for.
 175  *
 176  * @return  @c TRUE
 177  */
 178
 179 gboolean gnt_bindable_build_help_window(GntBindable *bindable);
 180
 181 G_END_DECLS
 182
 183 #endif /* GNT_BINDABLE_H */
 184