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 */
41 typedef gchar * (*GtkTranslateFunc) (const gchar *path,
44 #if !defined (GTK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION)
46 typedef void (*GtkPrintFunc) (gpointer func_data,
48 /* We use () here to mean unspecified arguments. This is deprecated
49 * as of C99, but we can't change it without breaking compatibility.
50 * (Note that if we are included from a C++ program () will mean
51 * (void) so an explicit cast will be needed.)
53 typedef void (*GtkItemFactoryCallback) ();
54 typedef void (*GtkItemFactoryCallback1) (gpointer callback_data,
55 guint callback_action,
58 #define GTK_TYPE_ITEM_FACTORY (gtk_item_factory_get_type ())
59 #define GTK_ITEM_FACTORY(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_ITEM_FACTORY, GtkItemFactory))
60 #define GTK_ITEM_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ITEM_FACTORY, GtkItemFactoryClass))
61 #define GTK_IS_ITEM_FACTORY(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_ITEM_FACTORY))
62 #define GTK_IS_ITEM_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ITEM_FACTORY))
63 #define GTK_ITEM_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ITEM_FACTORY, GtkItemFactoryClass))
66 typedef struct _GtkItemFactory GtkItemFactory;
67 typedef struct _GtkItemFactoryClass GtkItemFactoryClass;
68 typedef struct _GtkItemFactoryEntry GtkItemFactoryEntry;
69 typedef struct _GtkItemFactoryItem GtkItemFactoryItem;
71 struct _GtkItemFactory
76 GtkAccelGroup *accel_group;
80 GtkTranslateFunc translate_func;
81 gpointer translate_data;
82 GtkDestroyNotify translate_notify;
85 struct _GtkItemFactoryClass
87 GtkObjectClass object_class;
91 /* Padding for future expansion */
92 void (*_gtk_reserved1) (void);
93 void (*_gtk_reserved2) (void);
94 void (*_gtk_reserved3) (void);
95 void (*_gtk_reserved4) (void);
98 struct _GtkItemFactoryEntry
103 GtkItemFactoryCallback callback;
104 guint callback_action;
109 * "<Title>" -> create a title item
110 * "<Item>" -> create a simple item
111 * "<ImageItem>" -> create an item holding an image
112 * "<StockItem>" -> create an item holding a stock image
113 * "<CheckItem>" -> create a check item
114 * "<ToggleItem>" -> create a toggle item
115 * "<RadioItem>" -> create a radio item
116 * <path> -> path of a radio item to link against
117 * "<Separator>" -> create a separator
118 * "<Tearoff>" -> create a tearoff separator
119 * "<Branch>" -> create an item to hold sub items
120 * "<LastBranch>" -> create a right justified item to hold sub items
124 /* Extra data for some item types:
125 * ImageItem -> pointer to inlined pixbuf stream
126 * StockItem -> name of stock item
128 gconstpointer extra_data;
131 struct _GtkItemFactoryItem
138 GType gtk_item_factory_get_type (void) G_GNUC_CONST;
140 /* `container_type' must be of GTK_TYPE_MENU_BAR, GTK_TYPE_MENU,
141 * or GTK_TYPE_OPTION_MENU.
143 GtkItemFactory* gtk_item_factory_new (GType container_type,
145 GtkAccelGroup *accel_group);
146 void gtk_item_factory_construct (GtkItemFactory *ifactory,
147 GType container_type,
149 GtkAccelGroup *accel_group);
151 /* These functions operate on GtkItemFactoryClass basis.
153 void gtk_item_factory_add_foreign (GtkWidget *accel_widget,
154 const gchar *full_path,
155 GtkAccelGroup *accel_group,
157 GdkModifierType modifiers);
159 GtkItemFactory* gtk_item_factory_from_widget (GtkWidget *widget);
160 G_CONST_RETURN gchar* gtk_item_factory_path_from_widget (GtkWidget *widget);
162 GtkWidget* gtk_item_factory_get_item (GtkItemFactory *ifactory,
164 GtkWidget* gtk_item_factory_get_widget (GtkItemFactory *ifactory,
166 GtkWidget* gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
168 GtkWidget* gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
171 void gtk_item_factory_create_item (GtkItemFactory *ifactory,
172 GtkItemFactoryEntry *entry,
173 gpointer callback_data,
174 guint callback_type);
175 void gtk_item_factory_create_items (GtkItemFactory *ifactory,
177 GtkItemFactoryEntry *entries,
178 gpointer callback_data);
179 void gtk_item_factory_delete_item (GtkItemFactory *ifactory,
181 void gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
182 GtkItemFactoryEntry *entry);
183 void gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
185 GtkItemFactoryEntry *entries);
186 void gtk_item_factory_popup (GtkItemFactory *ifactory,
191 void gtk_item_factory_popup_with_data(GtkItemFactory *ifactory,
193 GtkDestroyNotify destroy,
198 gpointer gtk_item_factory_popup_data (GtkItemFactory *ifactory);
199 gpointer gtk_item_factory_popup_data_from_widget (GtkWidget *widget);
200 void gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
201 GtkTranslateFunc func,
203 GtkDestroyNotify notify);
205 /* Compatibility functions for deprecated GtkMenuFactory code
208 /* Used by gtk_item_factory_create_menu_entries () */
209 typedef void (*GtkMenuCallback) (GtkWidget *widget,
214 GtkMenuCallback callback;
215 gpointer callback_data;
219 /* Used by gtk_item_factory_callback_marshal () */
220 typedef void (*GtkItemFactoryCallback2) (GtkWidget *widget,
221 gpointer callback_data,
222 guint callback_action);
224 /* Used by gtk_item_factory_create_items () */
225 void gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
227 GtkItemFactoryEntry *entries,
228 gpointer callback_data,
229 guint callback_type);
231 GtkItemFactory* gtk_item_factory_from_path (const gchar *path);
232 void gtk_item_factory_create_menu_entries (guint n_entries,
233 GtkMenuEntry *entries);
234 void gtk_item_factories_path_delete (const gchar *ifactory_path,
237 #endif /* !GTK_DISABLE_DEPRECATED || GTK_COMPILATION */
242 #endif /* __cplusplus */
245 #endif /* __GTK_ITEM_FACTORY_H__ */