1/* GTK - The GIMP Toolkit
2 * Copyright (C) 1998, 2001 Tim Janik
3 *
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.
8 *
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.
13 *
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.
18 */
19
20#ifndef __GTK_ACCEL_MAP_H__
21#define __GTK_ACCEL_MAP_H__
22
23
24#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
25#error "Only <gtk/gtk.h> can be included directly."
26#endif
27
28#include <gtk/gtkaccelgroup.h>
29
30G_BEGIN_DECLS
31
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))
39
40typedef struct _GtkAccelMap GtkAccelMap;
41typedef struct _GtkAccelMapClass GtkAccelMapClass;
42
43/* --- notifier --- */
44typedef void (*GtkAccelMapForeach) (gpointer data,
45 const gchar *accel_path,
46 guint accel_key,
47 GdkModifierType accel_mods,
48 gboolean changed);
49
50
51/* --- public API --- */
52
53#ifdef G_OS_WIN32
54/* Reserve old names for DLL ABI backward compatibility */
55#define gtk_accel_map_load gtk_accel_map_load_utf8
56#define gtk_accel_map_save gtk_accel_map_save_utf8
57#endif
58
59void gtk_accel_map_add_entry (const gchar *accel_path,
60 guint accel_key,
61 GdkModifierType accel_mods);
62gboolean gtk_accel_map_lookup_entry (const gchar *accel_path,
63 GtkAccelKey *key);
64gboolean gtk_accel_map_change_entry (const gchar *accel_path,
65 guint accel_key,
66 GdkModifierType accel_mods,
67 gboolean replace);
68void gtk_accel_map_load (const gchar *file_name);
69void gtk_accel_map_save (const gchar *file_name);
70void gtk_accel_map_foreach (gpointer data,
71 GtkAccelMapForeach foreach_func);
72void gtk_accel_map_load_fd (gint fd);
73void gtk_accel_map_load_scanner (GScanner *scanner);
74void gtk_accel_map_save_fd (gint fd);
75
76void gtk_accel_map_lock_path (const gchar *accel_path);
77void gtk_accel_map_unlock_path (const gchar *accel_path);
78
79/* --- filter functions --- */
80void gtk_accel_map_add_filter (const gchar *filter_pattern);
81void gtk_accel_map_foreach_unfiltered (gpointer data,
82 GtkAccelMapForeach foreach_func);
83
84/* --- notification --- */
85GType gtk_accel_map_get_type (void) G_GNUC_CONST;
86GtkAccelMap *gtk_accel_map_get (void);
87
88
89/* --- internal API --- */
90void _gtk_accel_map_init (void);
91
92void _gtk_accel_map_add_group (const gchar *accel_path,
93 GtkAccelGroup *accel_group);
94void _gtk_accel_map_remove_group (const gchar *accel_path,
95 GtkAccelGroup *accel_group);
96gboolean _gtk_accel_path_is_valid (const gchar *accel_path);
97
98
99G_END_DECLS
100
101#endif /* __GTK_ACCEL_MAP_H__ */
102