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 GtkObjects.
   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 Library 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  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library 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 #ifndef __GTK_BINDINGS_H__
  23 #define __GTK_BINDINGS_H__
  24
  25
  26 #include <gdk/gdk.h>
  27 #include <gtk/gtkobject.h>
  28 #include <gtk/gtkenums.h>
  29
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #pragma }
  34 #endif /* __cplusplus */
  35
  36
  37 /* Pattern matching
  38  */
  39 typedef struct  _GtkPatternSpec GtkPatternSpec;
  40
  41 struct _GtkPatternSpec
  42 {
  43   GtkMatchType   match_type;
  44   guint          pattern_length;
  45   gchar         *pattern;
  46   gchar         *pattern_reversed;
  47   gpointer       user_data;
  48   guint          seq_id;
  49 };
  50
  51 void     gtk_pattern_spec_init      (GtkPatternSpec      *pspec,
  52                                      const gchar         *pattern);
  53 void     gtk_pattern_spec_free_segs (GtkPatternSpec      *pspec);
  54 gboolean gtk_pattern_match          (GtkPatternSpec      *pspec,
  55                                      guint                string_length,
  56                                      const gchar         *string,
  57                                      const gchar         *string_reversed);
  58 gboolean gtk_pattern_match_string   (GtkPatternSpec      *pspec,
  59                                      const gchar         *string);
  60 gboolean gtk_pattern_match_simple   (const gchar         *pattern,
  61                                      const gchar         *string);
  62
  63
  64 /* Binding sets
  65  */
  66
  67 typedef struct _GtkBindingSet           GtkBindingSet;
  68 typedef struct _GtkBindingEntry         GtkBindingEntry;
  69 typedef struct _GtkBindingSignal        GtkBindingSignal;
  70 typedef struct _GtkBindingArg           GtkBindingArg;
  71
  72 struct _GtkBindingSet
  73 {
  74   gchar                 *set_name;
  75   gint                   priority;
  76   GSList                *widget_path_pspecs;
  77   GSList                *widget_class_pspecs;
  78   GSList                *class_branch_pspecs;
  79   GtkBindingEntry       *entries;
  80   GtkBindingEntry       *current;
  81 };
  82
  83 struct _GtkBindingEntry
  84 {
  85   /* key portion
  86    */
  87   guint                  keyval;
  88   guint                  modifiers;
  89
  90   GtkBindingSet         *binding_set;
  91   guint                 destroyed : 1;
  92   guint                 in_emission : 1;
  93   GtkBindingEntry       *set_next;
  94   GtkBindingEntry       *hash_next;
  95   GtkBindingSignal      *signals;
  96 };
  97
  98 struct _GtkBindingSignal
  99 {
 100   GtkBindingSignal      *next;
 101   gchar                 *signal_name;
 102   guint                  n_args;
 103   GtkBindingArg         *args;
 104 };
 105
 106 struct _GtkBindingArg
 107 {
 108   GtkType       arg_type;
 109   union {
 110     glong        long_data;
 111     gdouble      double_data;
 112     gchar       *string_data;
 113   } d;
 114 };
 115
 116
 117 /* Application-level methods */
 118
 119 GtkBindingSet*  gtk_binding_set_new     (const gchar    *set_name);
 120 GtkBindingSet*  gtk_binding_set_by_class(gpointer        object_class);
 121 GtkBindingSet*  gtk_binding_set_find    (const gchar    *set_name);
 122 gboolean gtk_bindings_activate          (GtkObject      *object,
 123                                          guint           keyval,
 124                                          guint           modifiers);
 125 gboolean gtk_binding_set_activate       (GtkBindingSet  *binding_set,
 126                                          guint           keyval,
 127                                          guint           modifiers,
 128                                          GtkObject      *object);
 129 #define  gtk_binding_entry_add          gtk_binding_entry_clear
 130 void     gtk_binding_entry_clear        (GtkBindingSet  *binding_set,
 131                                          guint           keyval,
 132                                          guint           modifiers);
 133 void     gtk_binding_entry_add_signal   (GtkBindingSet  *binding_set,
 134                                          guint           keyval,
 135                                          guint           modifiers,
 136                                          const gchar    *signal_name,
 137                                          guint           n_args,
 138                                          ...);
 139 void     gtk_binding_set_add_path       (GtkBindingSet  *binding_set,
 140                                          GtkPathType     path_type,
 141                                          const gchar    *path_pattern,
 142                                          GtkPathPriorityType priority);
 143
 144
 145 /* Non-public methods */
 146
 147 void     gtk_binding_entry_remove       (GtkBindingSet  *binding_set,
 148                                          guint           keyval,
 149                                          guint           modifiers);
 150 void     gtk_binding_entry_add_signall  (GtkBindingSet  *binding_set,
 151                                          guint           keyval,
 152                                          guint           modifiers,
 153                                          const gchar    *signal_name,
 154                                          GSList         *binding_args);
 155
 156
 157
 158
 159 #ifdef __cplusplus
 160 }
 161 #endif /* __cplusplus */
 162
 163
 164 #endif /* __GTK_BINDINGS_H__ */