gtkbindings.h 4.71 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Tim Janik's avatar
Tim Janik committed
2 3 4 5 6 7
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * GtkBindingSet: Keybinding manager for GtkObjects.
 * Copyright (C) 1998 Tim Janik
 *
 * This library is free software; you can redistribute it and/or
8
 * modify it under the terms of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
9 10 11 12 13 14
 * 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
15
 * Lesser General Public License for more details.
Tim Janik's avatar
Tim Janik committed
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
Tim Janik's avatar
Tim Janik committed
18 19 20 21
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
22 23

/*
24
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
27
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28 29
 */

30 31 32 33
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Tim Janik's avatar
Tim Janik committed
34 35 36 37 38 39 40 41
#ifndef __GTK_BINDINGS_H__
#define __GTK_BINDINGS_H__


#include <gdk/gdk.h>
#include <gtk/gtkobject.h>


42
G_BEGIN_DECLS
Tim Janik's avatar
Tim Janik committed
43 44


45 46 47
/* Binding sets
 */

Tim Janik's avatar
Tim Janik committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61
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;
62
  guint                  parsed : 1; /* From RC content */
Tim Janik's avatar
Tim Janik committed
63 64 65 66 67 68 69
};

struct _GtkBindingEntry
{
  /* key portion
   */
  guint			 keyval;
70
  GdkModifierType	 modifiers;
Tim Janik's avatar
Tim Janik committed
71 72 73 74
  
  GtkBindingSet		*binding_set;
  guint			destroyed : 1;
  guint			in_emission : 1;
75
  guint                 marks_unbound : 1;
Tim Janik's avatar
Tim Janik committed
76 77 78 79 80 81 82
  GtkBindingEntry	*set_next;
  GtkBindingEntry	*hash_next;
  GtkBindingSignal	*signals;
};

struct _GtkBindingArg
{
Manish Singh's avatar
Manish Singh committed
83
  GType		 arg_type;
Tim Janik's avatar
Tim Janik committed
84 85 86 87 88 89 90
  union {
    glong	 long_data;
    gdouble	 double_data;
    gchar	*string_data;
  } d;
};

91 92 93 94 95
struct _GtkBindingSignal
{
  GtkBindingSignal	*next;
  gchar 		*signal_name;
  guint			 n_args;
96
  GtkBindingArg		*args;
97
};
98 99 100

/* Application-level methods */

Tim Janik's avatar
Tim Janik committed
101 102 103 104 105
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,
106
					 GdkModifierType modifiers);
Owen Taylor's avatar
Owen Taylor committed
107 108
gboolean gtk_bindings_activate_event    (GtkObject      *object,
					 GdkEventKey    *event);
Tim Janik's avatar
Tim Janik committed
109 110
gboolean gtk_binding_set_activate	(GtkBindingSet	*binding_set,
					 guint		 keyval,
111
					 GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
112
					 GtkObject	*object);
113 114

#ifndef GTK_DISABLE_DEPRECATED
Tim Janik's avatar
Tim Janik committed
115 116 117
#define	 gtk_binding_entry_add		gtk_binding_entry_clear
void	 gtk_binding_entry_clear	(GtkBindingSet	*binding_set,
					 guint		 keyval,
118
					 GdkModifierType modifiers);
119
void	 gtk_binding_entry_add_signall	(GtkBindingSet	*binding_set,
Tim Janik's avatar
Tim Janik committed
120
					 guint		 keyval,
121
					 GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
122
					 const gchar	*signal_name,
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
					 GSList		*binding_args);
guint	 gtk_binding_parse_binding      (GScanner       *scanner);
#endif /* GTK_DISABLE_DEPRECATED */

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_remove	(GtkBindingSet	*binding_set,
					 guint		 keyval,
					 GdkModifierType modifiers);

Tim Janik's avatar
Tim Janik committed
140 141 142 143 144 145
void	 gtk_binding_set_add_path	(GtkBindingSet	*binding_set,
					 GtkPathType	 path_type,
					 const gchar	*path_pattern,
					 GtkPathPriorityType priority);


146 147
/* Non-public methods */

148 149 150
guint	 _gtk_binding_parse_binding     (GScanner       *scanner);
void     _gtk_binding_reset_parsed      (void);
void	 _gtk_binding_entry_add_signall (GtkBindingSet  *binding_set,
151
					 guint		 keyval,
152
					 GdkModifierType modifiers,
153 154
					 const gchar	*signal_name,
					 GSList		*binding_args);
155

156
G_END_DECLS
Tim Janik's avatar
Tim Janik committed
157 158

#endif /* __GTK_BINDINGS_H__ */