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.
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_ACCEL_MAP_H__
25 #define __GTK_ACCEL_MAP_H__
28 #include <gtk/gtkaccelgroup.h>
32 /* --- global GtkAccelMap object --- */
33 #define GTK_TYPE_ACCEL_MAP (gtk_accel_map_get_type ())
34 #define GTK_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_CAST ((accel_map), GTK_TYPE_ACCEL_MAP, GtkAccelMap))
35 #define GTK_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
36 #define GTK_IS_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_TYPE ((accel_map), GTK_TYPE_ACCEL_MAP))
37 #define GTK_IS_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ACCEL_MAP))
38 #define GTK_ACCEL_MAP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
40 typedef struct _GtkAccelMap GtkAccelMap;
41 typedef struct _GtkAccelMapClass GtkAccelMapClass;
43 /* --- notifier --- */
46 * @data: User data passed to gtk_accel_map_foreach() or
47 * gtk_accel_map_foreach_unfiltered()
48 * @accel_path: Accel path of the current accelerator
49 * @accel_key: Key of the current accelerator
50 * @accel_mods: Modifiers of the current accelerator
51 * @changed: Changed flag of the accelerator (if %TRUE, accelerator has changed
52 * during runtime and would need to be saved during an accelerator dump)
54 typedef void (*GtkAccelMapForeach) (gpointer data,
55 const gchar *accel_path,
57 GdkModifierType accel_mods,
61 /* --- public API --- */
63 void gtk_accel_map_add_entry (const gchar *accel_path,
65 GdkModifierType accel_mods);
66 gboolean gtk_accel_map_lookup_entry (const gchar *accel_path,
68 gboolean gtk_accel_map_change_entry (const gchar *accel_path,
70 GdkModifierType accel_mods,
72 void gtk_accel_map_load (const gchar *file_name);
73 void gtk_accel_map_save (const gchar *file_name);
74 void gtk_accel_map_foreach (gpointer data,
75 GtkAccelMapForeach foreach_func);
76 void gtk_accel_map_load_fd (gint fd);
77 void gtk_accel_map_load_scanner (GScanner *scanner);
78 void gtk_accel_map_save_fd (gint fd);
80 void gtk_accel_map_lock_path (const gchar *accel_path);
81 void gtk_accel_map_unlock_path (const gchar *accel_path);
83 /* --- filter functions --- */
84 void gtk_accel_map_add_filter (const gchar *filter_pattern);
85 void gtk_accel_map_foreach_unfiltered (gpointer data,
86 GtkAccelMapForeach foreach_func);
88 /* --- notification --- */
89 GType gtk_accel_map_get_type (void) G_GNUC_CONST;
90 GtkAccelMap *gtk_accel_map_get (void);
93 /* --- internal API --- */
94 void _gtk_accel_map_init (void);
96 void _gtk_accel_map_add_group (const gchar *accel_path,
97 GtkAccelGroup *accel_group);
98 void _gtk_accel_map_remove_group (const gchar *accel_path,
99 GtkAccelGroup *accel_group);
100 gboolean _gtk_accel_path_is_valid (const gchar *accel_path);
105 #endif /* __GTK_ACCEL_MAP_H__ */