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, see <http://www.gnu.org/licenses/>.
16 */
17
18#ifndef __GTK_ACCEL_MAP_H__
19#define __GTK_ACCEL_MAP_H__
20
21
22#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
23#error "Only <gtk/gtk.h> can be included directly."
24#endif
25
26#include <gtk/gtkaccelgroup.h>
27
28G_BEGIN_DECLS
29
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))
37
38typedef struct _GtkAccelMap GtkAccelMap;
39typedef struct _GtkAccelMapClass GtkAccelMapClass;
40
41/* --- notifier --- */
42/**
43 * GtkAccelMapForeach:
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)
51 */
52typedef void (*GtkAccelMapForeach) (gpointer data,
53 const gchar *accel_path,
54 guint accel_key,
55 GdkModifierType accel_mods,
56 gboolean changed);
57
58
59/* --- public API --- */
60
61GDK_AVAILABLE_IN_ALL
62void gtk_accel_map_add_entry (const gchar *accel_path,
63 guint accel_key,
64 GdkModifierType accel_mods);
65GDK_AVAILABLE_IN_ALL
66gboolean gtk_accel_map_lookup_entry (const gchar *accel_path,
67 GtkAccelKey *key);
68GDK_AVAILABLE_IN_ALL
69gboolean gtk_accel_map_change_entry (const gchar *accel_path,
70 guint accel_key,
71 GdkModifierType accel_mods,
72 gboolean replace);
73GDK_AVAILABLE_IN_ALL
74void gtk_accel_map_load (const gchar *file_name);
75GDK_AVAILABLE_IN_ALL
76void gtk_accel_map_save (const gchar *file_name);
77GDK_AVAILABLE_IN_ALL
78void gtk_accel_map_foreach (gpointer data,
79 GtkAccelMapForeach foreach_func);
80GDK_AVAILABLE_IN_ALL
81void gtk_accel_map_load_fd (gint fd);
82GDK_AVAILABLE_IN_ALL
83void gtk_accel_map_load_scanner (GScanner *scanner);
84GDK_AVAILABLE_IN_ALL
85void gtk_accel_map_save_fd (gint fd);
86
87GDK_AVAILABLE_IN_ALL
88void gtk_accel_map_lock_path (const gchar *accel_path);
89GDK_AVAILABLE_IN_ALL
90void gtk_accel_map_unlock_path (const gchar *accel_path);
91
92/* --- filter functions --- */
93GDK_AVAILABLE_IN_ALL
94void gtk_accel_map_add_filter (const gchar *filter_pattern);
95GDK_AVAILABLE_IN_ALL
96void gtk_accel_map_foreach_unfiltered (gpointer data,
97 GtkAccelMapForeach foreach_func);
98
99/* --- notification --- */
100GDK_AVAILABLE_IN_ALL
101GType gtk_accel_map_get_type (void) G_GNUC_CONST;
102GDK_AVAILABLE_IN_ALL
103GtkAccelMap *gtk_accel_map_get (void);
104
105G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkAccelMap, g_object_unref)
106
107G_END_DECLS
108
109#endif /* __GTK_ACCEL_MAP_H__ */
110

source code of include/gtk-3.0/gtk/gtkaccelmap.h