Pileus Git - ~andy/gtk/blob - gtk/gtkbindings.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * GtkBindingSet: Keybinding manager for GObjects.
   5  * Copyright (C) 1998 Tim Janik
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library 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 GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /*
  24  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  25  * file for a list of people on the GTK+ Team.  See the ChangeLog
  26  * files for a list of changes.  These files are distributed with
  27  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  28  */
  29
  30 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  31 #error "Only <gtk/gtk.h> can be included directly."
  32 #endif
  33
  34 #ifndef __GTK_BINDINGS_H__
  35 #define __GTK_BINDINGS_H__
  36
  37
  38 #include <gdk/gdk.h>
  39 #include <gtk/gtkenums.h>
  40
  41 G_BEGIN_DECLS
  42
  43
  44 /* Binding sets
  45  */
  46
  47 typedef struct _GtkBindingSet           GtkBindingSet;
  48 typedef struct _GtkBindingEntry         GtkBindingEntry;
  49 typedef struct _GtkBindingSignal        GtkBindingSignal;
  50 typedef struct _GtkBindingArg           GtkBindingArg;
  51
  52 struct _GtkBindingSet
  53 {
  54   gchar                 *set_name;
  55   gint                   priority;
  56   GSList                *widget_path_pspecs;
  57   GSList                *widget_class_pspecs;
  58   GSList                *class_branch_pspecs;
  59   GtkBindingEntry       *entries;
  60   GtkBindingEntry       *current;
  61   guint                  parsed : 1; /* From RC content */
  62 };
  63
  64 struct _GtkBindingEntry
  65 {
  66   /* key portion
  67    */
  68   guint                  keyval;
  69   GdkModifierType        modifiers;
  70
  71   GtkBindingSet         *binding_set;
  72   guint                 destroyed : 1;
  73   guint                 in_emission : 1;
  74   guint                 marks_unbound : 1;
  75   GtkBindingEntry       *set_next;
  76   GtkBindingEntry       *hash_next;
  77   GtkBindingSignal      *signals;
  78 };
  79
  80 struct _GtkBindingArg
  81 {
  82   GType          arg_type;
  83   union {
  84     glong        long_data;
  85     gdouble      double_data;
  86     gchar       *string_data;
  87   } d;
  88 };
  89
  90 struct _GtkBindingSignal
  91 {
  92   GtkBindingSignal      *next;
  93   gchar                 *signal_name;
  94   guint                  n_args;
  95   GtkBindingArg         *args;
  96 };
  97
  98 /* Application-level methods */
  99
 100 GtkBindingSet*  gtk_binding_set_new     (const gchar    *set_name);
 101 GtkBindingSet*  gtk_binding_set_by_class(gpointer        object_class);
 102 GtkBindingSet*  gtk_binding_set_find    (const gchar    *set_name);
 103 gboolean gtk_bindings_activate          (GObject        *object,
 104                                          guint           keyval,
 105                                          GdkModifierType modifiers);
 106 gboolean gtk_bindings_activate_event    (GObject        *object,
 107                                          GdkEventKey    *event);
 108 gboolean gtk_binding_set_activate       (GtkBindingSet  *binding_set,
 109                                          guint           keyval,
 110                                          GdkModifierType modifiers,
 111                                          GObject        *object);
 112
 113 void     gtk_binding_entry_skip         (GtkBindingSet  *binding_set,
 114                                          guint           keyval,
 115                                          GdkModifierType modifiers);
 116 void     gtk_binding_entry_add_signal   (GtkBindingSet  *binding_set,
 117                                          guint           keyval,
 118                                          GdkModifierType modifiers,
 119                                          const gchar    *signal_name,
 120                                          guint           n_args,
 121                                          ...);
 122 void     gtk_binding_entry_add_signall  (GtkBindingSet  *binding_set,
 123                                          guint           keyval,
 124                                          GdkModifierType modifiers,
 125                                          const gchar    *signal_name,
 126                                          GSList         *binding_args);
 127 void     gtk_binding_entry_remove       (GtkBindingSet  *binding_set,
 128                                          guint           keyval,
 129                                          GdkModifierType modifiers);
 130
 131 void     gtk_binding_set_add_path       (GtkBindingSet  *binding_set,
 132                                          GtkPathType     path_type,
 133                                          const gchar    *path_pattern,
 134                                          GtkPathPriorityType priority);
 135
 136
 137 /* Non-public methods */
 138
 139 guint    _gtk_binding_parse_binding     (GScanner       *scanner);
 140 void     _gtk_binding_reset_parsed      (void);
 141 void     _gtk_binding_entry_add_signall (GtkBindingSet  *binding_set,
 142                                          guint           keyval,
 143                                          GdkModifierType modifiers,
 144                                          const gchar    *signal_name,
 145                                          GSList         *binding_args);
 146
 147 G_END_DECLS
 148
 149 #endif /* __GTK_BINDINGS_H__ */