1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1998, 2001 Tim Janik
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 #ifndef __GTK_ACCEL_MAP_H__
20 #define __GTK_ACCEL_MAP_H__
23 #include <gtk/gtkaccelgroup.h>
27 /* --- global GtkAccelMap object --- */
28 #define GTK_TYPE_ACCEL_MAP (gtk_accel_map_get_type ())
29 #define GTK_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_CAST ((accel_map), GTK_TYPE_ACCEL_MAP, GtkAccelMap))
30 #define GTK_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
31 #define GTK_IS_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_TYPE ((accel_map), GTK_TYPE_ACCEL_MAP))
32 #define GTK_IS_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ACCEL_MAP))
33 #define GTK_ACCEL_MAP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
35 typedef struct _GtkAccelMap GtkAccelMap;
36 typedef struct _GtkAccelMapClass GtkAccelMapClass;
38 /* --- notifier --- */
39 typedef void (*GtkAccelMapForeach) (gpointer data,
40 const gchar *accel_path,
42 GdkModifierType accel_mods,
46 /* --- public API --- */
49 /* Reserve old names for DLL ABI backward compatibility */
50 #define gtk_accel_map_load gtk_accel_map_load_utf8
51 #define gtk_accel_map_save gtk_accel_map_save_utf8
54 void gtk_accel_map_add_entry (const gchar *accel_path,
56 GdkModifierType accel_mods);
57 gboolean gtk_accel_map_lookup_entry (const gchar *accel_path,
59 gboolean gtk_accel_map_change_entry (const gchar *accel_path,
61 GdkModifierType accel_mods,
63 void gtk_accel_map_load (const gchar *file_name);
64 void gtk_accel_map_save (const gchar *file_name);
65 void gtk_accel_map_foreach (gpointer data,
66 GtkAccelMapForeach foreach_func);
67 void gtk_accel_map_load_fd (gint fd);
68 void gtk_accel_map_load_scanner (GScanner *scanner);
69 void gtk_accel_map_save_fd (gint fd);
71 void gtk_accel_map_lock_path (const gchar *accel_path);
72 void gtk_accel_map_unlock_path (const gchar *accel_path);
74 /* --- filter functions --- */
75 void gtk_accel_map_add_filter (const gchar *filter_pattern);
76 void gtk_accel_map_foreach_unfiltered (gpointer data,
77 GtkAccelMapForeach foreach_func);
79 /* --- notification --- */
80 GType gtk_accel_map_get_type (void) G_GNUC_CONST;
81 GtkAccelMap *gtk_accel_map_get (void);
84 /* --- internal API --- */
85 void _gtk_accel_map_init (void);
87 void _gtk_accel_map_add_group (const gchar *accel_path,
88 GtkAccelGroup *accel_group);
89 void _gtk_accel_map_remove_group (const gchar *accel_path,
90 GtkAccelGroup *accel_group);
91 gboolean _gtk_accel_path_is_valid (const gchar *accel_path);
96 #endif /* __GTK_ACCEL_MAP_H__ */