gntbindable.h
Go to the documentation of this file.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNT_BINDABLE_H
#define GNT_BINDABLE_H
#include <stdio.h>
#include <glib.h>
#include <glib-object.h>
#include <ncurses.h>
#define GNT_TYPE_BINDABLE (gnt_bindable_get_gtype())
#define GNT_BINDABLE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_BINDABLE, GntBindable))
#define GNT_BINDABLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_BINDABLE, GntBindableClass))
#define GNT_IS_BINDABLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_BINDABLE))
#define GNT_IS_BINDABLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_BINDABLE))
#define GNT_BINDABLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_BINDABLE, GntBindableClass))
#define GNTDEBUG
typedef struct _GntBindable GntBindable;
typedef struct _GntBindableClass GntBindableClass;
struct _GntBindable
{
GObject inherit;
};
struct _GntBindableClass
{
GObjectClass parent;
GHashTable *remaps; /* Key remaps */
GHashTable *actions; /* name -> Action */
GHashTable *bindings; /* key -> ActionParam */
GntBindable * help_window;
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
GType gnt_bindable_get_gtype(void);
/******************/
/* Key Remaps */
/******************/
const char * gnt_bindable_remap_keys(GntBindable *bindable, const char *text);
/******************/
/* Bindable Actions */
/******************/
typedef gboolean (*GntBindableActionCallback) (GntBindable *bindable, GList *params);
typedef gboolean (*GntBindableActionCallbackNoParam)(GntBindable *bindable);
typedef struct _GntBindableAction GntBindableAction;
typedef struct _GntBindableActionParam GntBindableActionParam;
struct _GntBindableAction
{
char *name; /* The name of the action */
union {
gboolean (*action)(GntBindable *bindable, GList *params);
gboolean (*action_noparam)(GntBindable *bindable);
} u;
};
struct _GntBindableActionParam
{
GntBindableAction *action;
GList *list;
};
/*GntBindableAction *gnt_bindable_action_parse(const char *name);*/
void gnt_bindable_action_free(GntBindableAction *action);
void gnt_bindable_action_param_free(GntBindableActionParam *param);
void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name, ...) G_GNUC_NULL_TERMINATED;
GntBindable * gnt_bindable_bindings_view(GntBindable *bind);
gboolean gnt_bindable_build_help_window(GntBindable *bindable);
G_END_DECLS
#endif /* GNT_BINDABLE_H */
_GntBindableAction
Definition: gntbindable.h:90
gnt_bindable_get_gtype
G_BEGIN_DECLS GType gnt_bindable_get_gtype(void)
gnt_bindable_class_register_action
void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger,...)
Register a bindable action for a class.
gnt_bindable_action_param_free
void gnt_bindable_action_param_free(GntBindableActionParam *param)
Free a GntBindableActionParam.
gnt_bindable_action_free
void gnt_bindable_action_free(GntBindableAction *action)
Free a bindable action.
_GntBindableClass
Definition: gntbindable.h:52
_GntBindableActionParam
Definition: gntbindable.h:99
gnt_bindable_bindings_view
GntBindable * gnt_bindable_bindings_view(GntBindable *bind)
Returns a GntTree populated with "key" -> "binding" for the widget.
gnt_bindable_check_key
gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys)
Discover if a key is bound.
gnt_bindable_register_binding
void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger,...)
Register a key-binding to an existing action.
gnt_bindable_perform_action_key
gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys)
Perform an action from a keybinding.
_GntBindable
Definition: gntbindable.h:47
gnt_bindable_perform_action_named
gboolean gnt_bindable_perform_action_named(GntBindable *bindable, const char *name,...) G_GNUC_NULL_TERMINATED
Perform an action on a bindable object.
gnt_bindable_build_help_window
gboolean gnt_bindable_build_help_window(GntBindable *bindable)
Builds a window that list the key bindings for a GntBindable object.