1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkItemFactory: Flexible item factory with automatic rc handling
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #ifndef __GTK_ITEM_FACTORY_H__
31 #define __GTK_ITEM_FACTORY_H__
34 #include <gtk/gtkwidget.h>
39 #endif /* __cplusplus */
42 typedef void (*GtkPrintFunc) (gpointer func_data,
44 typedef gchar * (*GtkTranslateFunc) (const gchar *path,
46 typedef void (*GtkItemFactoryCallback) ();
47 typedef void (*GtkItemFactoryCallback1) (gpointer callback_data,
48 guint callback_action,
51 #define GTK_TYPE_ITEM_FACTORY (gtk_item_factory_get_type ())
52 #define GTK_ITEM_FACTORY(object) (GTK_CHECK_CAST ((object), GTK_TYPE_ITEM_FACTORY, GtkItemFactory))
53 #define GTK_ITEM_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ITEM_FACTORY, GtkItemFactoryClass))
54 #define GTK_IS_ITEM_FACTORY(object) (GTK_CHECK_TYPE ((object), GTK_TYPE_ITEM_FACTORY))
55 #define GTK_IS_ITEM_FACTORY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ITEM_FACTORY))
56 #define GTK_ITEM_FACTORY_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ITEM_FACTORY, GtkItemFactoryClass))
59 typedef struct _GtkItemFactory GtkItemFactory;
60 typedef struct _GtkItemFactoryClass GtkItemFactoryClass;
61 typedef struct _GtkItemFactoryEntry GtkItemFactoryEntry;
62 typedef struct _GtkItemFactoryItem GtkItemFactoryItem;
64 struct _GtkItemFactory
69 GtkAccelGroup *accel_group;
73 GtkTranslateFunc translate_func;
74 gpointer translate_data;
75 GtkDestroyNotify translate_notify;
78 struct _GtkItemFactoryClass
80 GtkObjectClass object_class;
82 gchar *cpair_comment_single;
89 struct _GtkItemFactoryEntry
94 GtkItemFactoryCallback callback;
95 guint callback_action;
100 * "<Title>" -> create a title item
101 * "<Item>" -> create a simple item
102 * "<CheckItem>" -> create a check item
103 * "<ToggleItem>" -> create a toggle item
104 * "<RadioItem>" -> create a radio item
105 * <path> -> path of a radio item to link against
106 * "<Separator>" -> create a separator
107 * "<Branch>" -> create an item to hold sub items
108 * "<LastBranch>" -> create a right justified item to hold sub items
112 /* Extra data for some item types:
113 * ImageItem -> pointer to inline pixbuf + inline pixbuf length
114 * StockItem -> name of stock item
120 struct _GtkItemFactoryItem
123 guint accelerator_key;
124 guint accelerator_mods;
126 guint in_propagation : 1;
133 GtkType gtk_item_factory_get_type (void) G_GNUC_CONST;
135 /* `container_type' must be of GTK_TYPE_MENU_BAR, GTK_TYPE_MENU,
136 * or GTK_TYPE_OPTION_MENU.
138 GtkItemFactory* gtk_item_factory_new (GtkType container_type,
140 GtkAccelGroup *accel_group);
141 void gtk_item_factory_construct (GtkItemFactory *ifactory,
142 GtkType container_type,
144 GtkAccelGroup *accel_group);
146 /* These functions operate on GtkItemFactoryClass basis.
148 void gtk_item_factory_parse_rc (const gchar *file_name);
149 void gtk_item_factory_parse_rc_string (const gchar *rc_string);
150 void gtk_item_factory_parse_rc_scanner (GScanner *scanner);
151 void gtk_item_factory_add_foreign (GtkWidget *accel_widget,
152 const gchar *full_path,
153 GtkAccelGroup *accel_group,
155 GdkModifierType modifiers);
157 GtkItemFactory* gtk_item_factory_from_widget (GtkWidget *widget);
158 gchar* gtk_item_factory_path_from_widget (GtkWidget *widget);
160 GtkWidget* gtk_item_factory_get_item (GtkItemFactory *ifactory,
162 GtkWidget* gtk_item_factory_get_widget (GtkItemFactory *ifactory,
164 GtkWidget* gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
166 GtkWidget* gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
169 /* If `path_pspec' is passed as `NULL', this function will iterate over
170 * all hash entries. otherwise only those entries will be dumped for which
171 * the pattern matches, e.g. "<Image>*...".
173 void gtk_item_factory_dump_items (GPatternSpec *path_pspec,
174 gboolean modified_only,
175 GtkPrintFunc print_func,
177 void gtk_item_factory_dump_rc (const gchar *file_name,
178 GPatternSpec *path_pspec,
179 gboolean modified_only);
180 void gtk_item_factory_print_func (gpointer FILE_pointer,
181 const gchar *string);
182 void gtk_item_factory_create_item (GtkItemFactory *ifactory,
183 GtkItemFactoryEntry *entry,
184 gpointer callback_data,
185 guint callback_type);
186 void gtk_item_factory_create_items (GtkItemFactory *ifactory,
188 GtkItemFactoryEntry *entries,
189 gpointer callback_data);
190 void gtk_item_factory_delete_item (GtkItemFactory *ifactory,
192 void gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
193 GtkItemFactoryEntry *entry);
194 void gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
196 GtkItemFactoryEntry *entries);
197 void gtk_item_factory_popup (GtkItemFactory *ifactory,
202 void gtk_item_factory_popup_with_data(GtkItemFactory *ifactory,
204 GtkDestroyNotify destroy,
209 gpointer gtk_item_factory_popup_data (GtkItemFactory *ifactory);
210 gpointer gtk_item_factory_popup_data_from_widget (GtkWidget *widget);
211 void gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
212 GtkTranslateFunc func,
214 GtkDestroyNotify notify);
216 /* Compatibility functions for deprecated GtkMenuFactory code
218 typedef void (*GtkMenuCallback) (GtkWidget *widget,
223 GtkMenuCallback callback;
224 gpointer callback_data;
227 GtkItemFactory* gtk_item_factory_from_path (const gchar *path);
228 void gtk_item_factory_create_menu_entries (guint n_entries,
229 GtkMenuEntry *entries);
230 void gtk_item_factories_path_delete (const gchar *ifactory_path,
232 typedef void (*GtkItemFactoryCallback2) (GtkWidget *widget,
233 gpointer callback_data,
234 guint callback_action);
235 void gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
237 GtkItemFactoryEntry *entries,
238 gpointer callback_data,
239 guint callback_type);
245 #endif /* __cplusplus */
248 #endif /* __GTK_ITEM_FACTORY_H__ */