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, see <http://www.gnu.org/licenses/>.
18 #ifndef __GTK_ACCEL_MAP_H__
19 #define __GTK_ACCEL_MAP_H__
22 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
23 #error "Only <gtk/gtk.h> can be included directly."
26 #include <gtk/gtkaccelgroup.h>
30 /* --- global GtkAccelMap object --- */
31 #define GTK_TYPE_ACCEL_MAP (gtk_accel_map_get_type ())
32 #define GTK_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_CAST ((accel_map), GTK_TYPE_ACCEL_MAP, GtkAccelMap))
33 #define GTK_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
34 #define GTK_IS_ACCEL_MAP(accel_map) (G_TYPE_CHECK_INSTANCE_TYPE ((accel_map), GTK_TYPE_ACCEL_MAP))
35 #define GTK_IS_ACCEL_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ACCEL_MAP))
36 #define GTK_ACCEL_MAP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ACCEL_MAP, GtkAccelMapClass))
38 typedef struct _GtkAccelMap GtkAccelMap;
39 typedef struct _GtkAccelMapClass GtkAccelMapClass;
41 /* --- notifier --- */
44 * @data: User data passed to gtk_accel_map_foreach() or
45 * gtk_accel_map_foreach_unfiltered()
46 * @accel_path: Accel path of the current accelerator
47 * @accel_key: Key of the current accelerator
48 * @accel_mods: Modifiers of the current accelerator
49 * @changed: Changed flag of the accelerator (if %TRUE, accelerator has changed
50 * during runtime and would need to be saved during an accelerator dump)
52 typedef void (*GtkAccelMapForeach) (gpointer data,
53 const gchar *accel_path,
55 GdkModifierType accel_mods,
59 /* --- public API --- */
61 void gtk_accel_map_add_entry (const gchar *accel_path,
63 GdkModifierType accel_mods);
64 gboolean gtk_accel_map_lookup_entry (const gchar *accel_path,
66 gboolean gtk_accel_map_change_entry (const gchar *accel_path,
68 GdkModifierType accel_mods,
70 void gtk_accel_map_load (const gchar *file_name);
71 void gtk_accel_map_save (const gchar *file_name);
72 void gtk_accel_map_foreach (gpointer data,
73 GtkAccelMapForeach foreach_func);
74 void gtk_accel_map_load_fd (gint fd);
75 void gtk_accel_map_load_scanner (GScanner *scanner);
76 void gtk_accel_map_save_fd (gint fd);
78 void gtk_accel_map_lock_path (const gchar *accel_path);
79 void gtk_accel_map_unlock_path (const gchar *accel_path);
81 /* --- filter functions --- */
82 void gtk_accel_map_add_filter (const gchar *filter_pattern);
83 void gtk_accel_map_foreach_unfiltered (gpointer data,
84 GtkAccelMapForeach foreach_func);
86 /* --- notification --- */
87 GType gtk_accel_map_get_type (void) G_GNUC_CONST;
88 GtkAccelMap *gtk_accel_map_get (void);
93 #endif /* __GTK_ACCEL_MAP_H__ */