X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkbindings.h;h=fb911f78bdc48066fe7e90bac527dc55a3f3d1b7;hb=3b2182e711ace4a2d6843848208224cd7525d530;hp=d9ed4033d8c47b4800d7395245a1df1b7b3b6d8a;hpb=a391196ba51da34253593712e8bf4552c04f19e5;p=~andy%2Fgtk diff --git a/gtk/gtkbindings.h b/gtk/gtkbindings.h index d9ed4033d..fb911f78b 100644 --- a/gtk/gtkbindings.h +++ b/gtk/gtkbindings.h @@ -1,166 +1,189 @@ /* GTK - The GIMP Toolkit * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald * - * GtkBindingSet: Keybinding manager for GtkObjects. + * GtkBindingSet: Keybinding manager for GObjects. * Copyright (C) 1998 Tim Janik * * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Library General Public + * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library 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 - * Library General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. * - * You should have received a copy of the GNU Library General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see . */ + +/* + * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS + * file for a list of people on the GTK+ Team. See the ChangeLog + * files for a list of changes. These files are distributed with + * GTK+ at ftp://ftp.gtk.org/pub/gtk/. + */ + #ifndef __GTK_BINDINGS_H__ #define __GTK_BINDINGS_H__ +#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION) +#error "Only can be included directly." +#endif + #include -#include #include - -#ifdef __cplusplus -extern "C" { -#pragma } -#endif /* __cplusplus */ - - -/* Pattern matching - */ -typedef struct _GtkPatternSpec GtkPatternSpec; - -struct _GtkPatternSpec -{ - GtkMatchType match_type; - guint pattern_length; - gchar *pattern; - gchar *pattern_reversed; - gpointer user_data; - guint seq_id; -}; - -void gtk_pattern_spec_init (GtkPatternSpec *pspec, - const gchar *pattern); -void gtk_pattern_spec_free_segs (GtkPatternSpec *pspec); -gboolean gtk_pattern_match (GtkPatternSpec *pspec, - guint string_length, - const gchar *string, - const gchar *string_reversed); -gboolean gtk_pattern_match_string (GtkPatternSpec *pspec, - const gchar *string); -gboolean gtk_pattern_match_simple (const gchar *pattern, - const gchar *string); - - -/* Binding sets +G_BEGIN_DECLS + +typedef struct _GtkBindingSet GtkBindingSet; +typedef struct _GtkBindingEntry GtkBindingEntry; +typedef struct _GtkBindingSignal GtkBindingSignal; +typedef struct _GtkBindingArg GtkBindingArg; + +/** + * GtkBindingSet: + * @set_name: unique name of this binding set + * @priority: unused + * @widget_path_pspecs: unused + * @widget_class_pspecs: unused + * @class_branch_pspecs: unused + * @entries: the key binding entries in this binding set + * @current: implementation detail + * @parsed: whether this binding set stems from a CSS file and is reset upon theme changes + * + * A binding set maintains a list of activatable key bindings. + * A single binding set can match multiple types of widgets. + * Similar to style contexts, can be matched by any information contained + * in a widgets #GtkWidgetPath. When a binding within a set is matched upon + * activation, an action signal is emitted on the target widget to carry out + * the actual activation. */ - -#define GTK_BINDING_ARG_INT (GTK_TYPE_INT) -#define GTK_BINDING_ARG_LONG (GTK_TYPE_LONG) -#define GTK_BINDING_ARG_FLOAT (GTK_TYPE_FLOAT) -#define GTK_BINDING_ARG_DOUBLE (GTK_TYPE_DOUBLE) -#define GTK_BINDING_ARG_STRING (GTK_TYPE_STRING) - -typedef struct _GtkBindingSet GtkBindingSet; -typedef struct _GtkBindingEntry GtkBindingEntry; -typedef struct _GtkBindingSignal GtkBindingSignal; -typedef struct _GtkBindingArg GtkBindingArg; - struct _GtkBindingSet { - gchar *set_name; - gint priority; - GSList *widget_path_pspecs; - GSList *widget_class_pspecs; - GSList *class_branch_pspecs; - GtkBindingEntry *entries; - GtkBindingEntry *current; + gchar *set_name; + gint priority; + GSList *widget_path_pspecs; + GSList *widget_class_pspecs; + GSList *class_branch_pspecs; + GtkBindingEntry *entries; + GtkBindingEntry *current; + guint parsed : 1; }; +/** + * GtkBindingEntry: + * @keyval: key value to match + * @modifiers: key modifiers to match + * @binding_set: binding set this entry belongs to + * @destroyed: implementation detail + * @in_emission: implementation detail + * @marks_unbound: implementation detail + * @set_next: linked list of entries maintained by binding set + * @hash_next: implementation detail + * @signals: action signals of this entry + * + * Each key binding element of a binding sets binding list is + * represented by a GtkBindingEntry. + */ struct _GtkBindingEntry { - /* key portion - */ - guint keyval; - guint modifiers; - - GtkBindingSet *binding_set; - guint destroyed : 1; - guint in_emission : 1; - GtkBindingEntry *set_next; - GtkBindingEntry *hash_next; - GtkBindingSignal *signals; -}; - -struct _GtkBindingSignal -{ - GtkBindingSignal *next; - gchar *signal_name; - guint n_args; - GtkBindingArg *args; + /* key portion */ + guint keyval; + GdkModifierType modifiers; + + GtkBindingSet *binding_set; + guint destroyed : 1; + guint in_emission : 1; + guint marks_unbound : 1; + GtkBindingEntry *set_next; + GtkBindingEntry *hash_next; + GtkBindingSignal *signals; }; +/** + * GtkBindingArg: + * @arg_type: implementation detail + * + * A #GtkBindingArg holds the data associated with + * an argument for a key binding signal emission as + * stored in #GtkBindingSignal. + */ struct _GtkBindingArg { - GtkType arg_type; + GType arg_type; union { - glong long_data; - gdouble double_data; - gchar *string_data; + glong long_data; + gdouble double_data; + gchar *string_data; } d; }; -/* Binding sets +/** + * GtkBindingSignal: + * @next: implementation detail + * @signal_name: the action signal to be emitted + * @n_args: number of arguments specified for the signal + * @args: the arguments specified for the signal + * + * + * A GtkBindingSignal stores the necessary information to + * activate a widget in response to a key press via a signal + * emission. */ -GtkBindingSet* gtk_binding_set_new (const gchar *set_name); -GtkBindingSet* gtk_binding_set_by_class(gpointer object_class); -GtkBindingSet* gtk_binding_set_find (const gchar *set_name); -gboolean gtk_bindings_activate (GtkObject *object, - guint keyval, - guint modifiers); -gboolean gtk_binding_set_activate (GtkBindingSet *binding_set, - guint keyval, - guint modifiers, - GtkObject *object); -#define gtk_binding_entry_add gtk_binding_entry_clear -void gtk_binding_entry_clear (GtkBindingSet *binding_set, - guint keyval, - guint modifiers); -void gtk_binding_entry_remove (GtkBindingSet *binding_set, - guint keyval, - guint modifiers); -void gtk_binding_entry_add_signal (GtkBindingSet *binding_set, - guint keyval, - guint modifiers, - const gchar *signal_name, - guint n_args, - ...); -void gtk_binding_entry_add_signall (GtkBindingSet *binding_set, - guint keyval, - guint modifiers, - const gchar *signal_name, - GSList *binding_args); -void gtk_binding_set_add_path (GtkBindingSet *binding_set, - GtkPathType path_type, - const gchar *path_pattern, - GtkPathPriorityType priority); - - - - - -#ifdef __cplusplus -} -#endif /* __cplusplus */ +struct _GtkBindingSignal +{ + GtkBindingSignal *next; + gchar *signal_name; + guint n_args; + GtkBindingArg *args; +}; +GtkBindingSet *gtk_binding_set_new (const gchar *set_name); +GtkBindingSet *gtk_binding_set_by_class (gpointer object_class); +GtkBindingSet *gtk_binding_set_find (const gchar *set_name); + +gboolean gtk_bindings_activate (GObject *object, + guint keyval, + GdkModifierType modifiers); +gboolean gtk_bindings_activate_event (GObject *object, + GdkEventKey *event); +gboolean gtk_binding_set_activate (GtkBindingSet *binding_set, + guint keyval, + GdkModifierType modifiers, + GObject *object); + +void gtk_binding_entry_skip (GtkBindingSet *binding_set, + guint keyval, + GdkModifierType modifiers); +void gtk_binding_entry_add_signal (GtkBindingSet *binding_set, + guint keyval, + GdkModifierType modifiers, + const gchar *signal_name, + guint n_args, + ...); +void gtk_binding_entry_add_signall (GtkBindingSet *binding_set, + guint keyval, + GdkModifierType modifiers, + const gchar *signal_name, + GSList *binding_args); + +GTokenType gtk_binding_entry_add_signal_from_string + (GtkBindingSet *binding_set, + const gchar *signal_desc); + +void gtk_binding_entry_remove (GtkBindingSet *binding_set, + guint keyval, + GdkModifierType modifiers); + +GDK_DEPRECATED_IN_3_0 +void gtk_binding_set_add_path (GtkBindingSet *binding_set, + GtkPathType path_type, + const gchar *path_pattern, + GtkPathPriorityType priority); + +G_END_DECLS #endif /* __GTK_BINDINGS_H__ */