gtkbindings.h 4.36 KB
Newer Older
Tim Janik's avatar
Tim Janik committed
1 2 3 4 5 6 7
/* GTK - The GIMP Toolkit
 * 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 27 28 29
 * 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/. 
 */

Tim Janik's avatar
Tim Janik committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43
#ifndef __GTK_BINDINGS_H__
#define __GTK_BINDINGS_H__


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


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


44 45 46
/* Binding sets
 */

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

struct _GtkBindingEntry
{
  /* key portion
   */
  guint			 keyval;
69
  GdkModifierType	 modifiers;
Tim Janik's avatar
Tim Janik committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
  
  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;
};

struct _GtkBindingArg
{
Manish Singh's avatar
Manish Singh committed
89
  GType		 arg_type;
Tim Janik's avatar
Tim Janik committed
90 91 92 93 94 95 96
  union {
    glong	 long_data;
    gdouble	 double_data;
    gchar	*string_data;
  } d;
};

97 98 99

/* Application-level methods */

Tim Janik's avatar
Tim Janik committed
100 101 102 103 104
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,
105
					 GdkModifierType modifiers);
Owen Taylor's avatar
Owen Taylor committed
106 107
gboolean gtk_bindings_activate_event    (GtkObject      *object,
					 GdkEventKey    *event);
Tim Janik's avatar
Tim Janik committed
108 109
gboolean gtk_binding_set_activate	(GtkBindingSet	*binding_set,
					 guint		 keyval,
110
					 GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
111 112 113 114
					 GtkObject	*object);
#define	 gtk_binding_entry_add		gtk_binding_entry_clear
void	 gtk_binding_entry_clear	(GtkBindingSet	*binding_set,
					 guint		 keyval,
115
					 GdkModifierType modifiers);
Tim Janik's avatar
Tim Janik committed
116 117
void	 gtk_binding_entry_add_signal	(GtkBindingSet	*binding_set,
					 guint		 keyval,
118
					 GdkModifierType modifiers,
Tim Janik's avatar
Tim Janik committed
119 120 121 122 123 124 125 126 127
					 const gchar	*signal_name,
					 guint		 n_args,
					 ...);
void	 gtk_binding_set_add_path	(GtkBindingSet	*binding_set,
					 GtkPathType	 path_type,
					 const gchar	*path_pattern,
					 GtkPathPriorityType priority);


128 129 130 131
/* Non-public methods */

void	 gtk_binding_entry_remove	(GtkBindingSet	*binding_set,
					 guint		 keyval,
132
					 GdkModifierType modifiers);
133 134
void	 gtk_binding_entry_add_signall	(GtkBindingSet	*binding_set,
					 guint		 keyval,
135
					 GdkModifierType modifiers,
136 137
					 const gchar	*signal_name,
					 GSList		*binding_args);
138
guint	 gtk_binding_parse_binding	(GScanner	*scanner);
139

Tim Janik's avatar
Tim Janik committed
140

141
void     _gtk_binding_reset_parsed    (void);
142

143 144 145 146 147 148 149 150 151 152 153 154 155
/* Creates a signal with a fixed callback instead of a class offset;
 * useful for key binding signals
 */
guint _gtk_binding_signal_new (const gchar       *signal_name,
			       GType		  itype,
			       GSignalFlags	  signal_flags,
			       GCallback          handler,
			       GSignalAccumulator accumulator,
			       gpointer		  accu_data,
			       GSignalCMarshaller c_marshaller,
			       GType		  return_type,
			       guint		  n_params,
			       ...);
Tim Janik's avatar
Tim Janik committed
156 157 158 159 160 161
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_BINDINGS_H__ */