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/.
32 #include "gtkitemfactory.h"
33 #include "gtk/gtksignal.h"
34 #include "gtk/gtkoptionmenu.h"
35 #include "gtk/gtkmenubar.h"
36 #include "gtk/gtkmenu.h"
37 #include "gtk/gtkmenuitem.h"
38 #include "gtk/gtkradiomenuitem.h"
39 #include "gtk/gtkcheckmenuitem.h"
40 #include "gtk/gtkimagemenuitem.h"
41 #include "gtk/gtktearoffmenuitem.h"
42 #include "gtk/gtkaccellabel.h"
43 #include "gdk/gdkkeysyms.h"
44 #include "gtk/gtkimage.h"
45 #include "gtk/gtkstock.h"
46 #include "gtk/gtkiconfactory.h"
56 #include <io.h> /* For _open and _close */
59 #define S_ISREG(mode) ((mode)&_S_IFREG)
65 #define ITEM_FACTORY_STRING ((gchar*) item_factory_string)
66 #define ITEM_BLOCK_SIZE (128)
69 /* --- structures --- */
70 typedef struct _GtkIFCBData GtkIFCBData;
71 typedef struct _GtkIFDumpData GtkIFDumpData;
74 GtkItemFactoryCallback func;
77 guint callback_action;
81 GtkPrintFunc print_func;
83 guint modified_only : 1;
88 /* --- prototypes --- */
89 static void gtk_item_factory_class_init (GtkItemFactoryClass *klass);
90 static void gtk_item_factory_init (GtkItemFactory *ifactory);
91 static void gtk_item_factory_destroy (GtkObject *object);
92 static void gtk_item_factory_finalize (GObject *object);
95 /* --- static variables --- */
96 static GtkItemFactoryClass *gtk_item_factory_class = NULL;
97 static gpointer parent_class = NULL;
98 static const gchar *item_factory_string = "Gtk-<ItemFactory>";
99 static GMemChunk *ifactory_item_chunks = NULL;
100 static GMemChunk *ifactory_cb_data_chunks = NULL;
101 static GQuark quark_popup_data = 0;
102 static GQuark quark_if_menu_pos = 0;
103 static GQuark quark_item_factory = 0;
104 static GQuark quark_item_path = 0;
105 static GQuark quark_action = 0;
106 static GQuark quark_accel_group = 0;
107 static GQuark quark_type_item = 0;
108 static GQuark quark_type_title = 0;
109 static GQuark quark_type_radio_item = 0;
110 static GQuark quark_type_check_item = 0;
111 static GQuark quark_type_toggle_item = 0;
112 static GQuark quark_type_image_item = 0;
113 static GQuark quark_type_stock_item = 0;
114 static GQuark quark_type_tearoff_item = 0;
115 static GQuark quark_type_separator_item = 0;
116 static GQuark quark_type_branch = 0;
117 static GQuark quark_type_last_branch = 0;
118 static GScannerConfig ifactory_scanner_config =
122 ) /* cset_skip_characters */,
127 ) /* cset_identifier_first */,
134 ) /* cset_identifier_nth */,
135 ( ";\n" ) /* cpair_comment_single */,
137 FALSE /* case_sensitive */,
139 TRUE /* skip_comment_multi */,
140 TRUE /* skip_comment_single */,
141 FALSE /* scan_comment_multi */,
142 TRUE /* scan_identifier */,
143 FALSE /* scan_identifier_1char */,
144 FALSE /* scan_identifier_NULL */,
145 TRUE /* scan_symbols */,
146 TRUE /* scan_binary */,
147 TRUE /* scan_octal */,
148 TRUE /* scan_float */,
150 FALSE /* scan_hex_dollar */,
151 TRUE /* scan_string_sq */,
152 TRUE /* scan_string_dq */,
153 TRUE /* numbers_2_int */,
154 FALSE /* int_2_float */,
155 FALSE /* identifier_2_string */,
156 TRUE /* char_2_token */,
157 FALSE /* symbol_2_token */,
161 /* --- functions --- */
163 gtk_item_factory_get_type (void)
165 static GtkType item_factory_type = 0;
167 if (!item_factory_type)
169 static const GtkTypeInfo item_factory_info =
172 sizeof (GtkItemFactory),
173 sizeof (GtkItemFactoryClass),
174 (GtkClassInitFunc) gtk_item_factory_class_init,
175 (GtkObjectInitFunc) gtk_item_factory_init,
176 /* reserved_1 */ NULL,
177 /* reserved_2 */ NULL,
178 (GtkClassInitFunc) NULL,
181 item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
184 return item_factory_type;
188 gtk_item_factory_class_init (GtkItemFactoryClass *class)
190 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
191 GtkObjectClass *object_class;
193 gtk_item_factory_class = class;
195 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
197 object_class = (GtkObjectClass*) class;
199 gobject_class->finalize = gtk_item_factory_finalize;
201 object_class->destroy = gtk_item_factory_destroy;
203 class->cpair_comment_single = g_strdup (";\n");
205 class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
207 ifactory_item_chunks =
208 g_mem_chunk_new ("GtkItemFactoryItem",
209 sizeof (GtkItemFactoryItem),
210 sizeof (GtkItemFactoryItem) * ITEM_BLOCK_SIZE,
212 ifactory_cb_data_chunks =
213 g_mem_chunk_new ("GtkIFCBData",
214 sizeof (GtkIFCBData),
215 sizeof (GtkIFCBData) * ITEM_BLOCK_SIZE,
218 quark_popup_data = g_quark_from_static_string ("GtkItemFactory-popup-data");
219 quark_if_menu_pos = g_quark_from_static_string ("GtkItemFactory-menu-position");
220 quark_item_factory = g_quark_from_static_string ("GtkItemFactory");
221 quark_item_path = g_quark_from_static_string ("GtkItemFactory-path");
222 quark_action = g_quark_from_static_string ("GtkItemFactory-action");
223 quark_accel_group = g_quark_from_static_string ("GtkAccelGroup");
224 quark_type_item = g_quark_from_static_string ("<Item>");
225 quark_type_title = g_quark_from_static_string ("<Title>");
226 quark_type_radio_item = g_quark_from_static_string ("<RadioItem>");
227 quark_type_check_item = g_quark_from_static_string ("<CheckItem>");
228 quark_type_toggle_item = g_quark_from_static_string ("<ToggleItem>");
229 quark_type_image_item = g_quark_from_static_string ("<ImageItem>");
230 quark_type_stock_item = g_quark_from_static_string ("<StockItem>");
231 quark_type_separator_item = g_quark_from_static_string ("<Separator>");
232 quark_type_tearoff_item = g_quark_from_static_string ("<Tearoff>");
233 quark_type_branch = g_quark_from_static_string ("<Branch>");
234 quark_type_last_branch = g_quark_from_static_string ("<LastBranch>");
238 gtk_item_factory_init (GtkItemFactory *ifactory)
242 object = GTK_OBJECT (ifactory);
244 ifactory->path = NULL;
245 ifactory->accel_group = NULL;
246 ifactory->widget = NULL;
247 ifactory->items = NULL;
248 ifactory->translate_func = NULL;
249 ifactory->translate_data = NULL;
250 ifactory->translate_notify = NULL;
254 gtk_item_factory_new (GtkType container_type,
256 GtkAccelGroup *accel_group)
258 GtkItemFactory *ifactory;
260 g_return_val_if_fail (path != NULL, NULL);
262 ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
263 gtk_item_factory_construct (ifactory, container_type, path, accel_group);
269 gtk_item_factory_callback_marshal (GtkWidget *widget,
276 if (data->callback_type == 1)
278 GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
279 func1 (data->func_data, data->callback_action, widget);
281 else if (data->callback_type == 2)
283 GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
284 func2 (widget, data->func_data, data->callback_action);
289 gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
295 if (item->in_propagation)
298 item->in_propagation = TRUE;
301 for (slist = item->widgets; slist; slist = slist->next)
305 widget = slist->data;
307 if (widget != exclude)
309 gtk_widget_ref (widget);
310 widget_list = g_slist_prepend (widget_list, widget);
314 for (slist = widget_list; slist; slist = slist->next)
317 GtkAccelGroup *accel_group;
320 widget = slist->data;
322 accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
324 signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
325 if (signal_id && accel_group)
327 if (item->accelerator_key)
328 gtk_widget_add_accelerator (widget,
331 item->accelerator_key,
332 item->accelerator_mods,
338 work = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
341 GtkAccelEntry *ac_entry;
343 ac_entry = work->data;
345 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
346 ac_entry->accel_group == accel_group &&
347 ac_entry->signal_id == signal_id)
348 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
349 ac_entry->accel_group,
350 ac_entry->accelerator_key,
351 ac_entry->accelerator_mods);
356 gtk_widget_unref (widget);
359 g_slist_free (widget_list);
361 item->in_propagation = FALSE;
365 gtk_item_factory_item_add_accelerator (GtkWidget *widget,
366 guint accel_signal_id,
367 GtkAccelGroup *accel_group,
370 GtkAccelFlags accel_flags,
371 GtkItemFactoryItem *item)
373 if (!item->in_propagation &&
374 g_slist_find (item->widgets, widget) &&
375 accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
377 item->accelerator_key = accel_key;
378 item->accelerator_mods = accel_mods;
379 item->modified = TRUE;
381 gtk_item_factory_propagate_accelerator (item, widget);
388 gtk_item_factory_item_remove_accelerator (GtkWidget *widget,
389 GtkAccelGroup *accel_group,
392 GtkItemFactoryItem *item)
394 if (!item->in_propagation &&
395 g_slist_find (item->widgets, widget) &&
396 item->accelerator_key == accel_key &&
397 item->accelerator_mods == accel_mods)
399 item->accelerator_key = 0;
400 item->accelerator_mods = 0;
401 item->modified = TRUE;
403 gtk_item_factory_propagate_accelerator (item, widget);
408 gtk_item_factory_item_remove_widget (GtkWidget *widget,
409 GtkItemFactoryItem *item)
411 item->widgets = g_slist_remove (item->widgets, widget);
412 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
413 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
417 gtk_item_factory_add_foreign (GtkWidget *accel_widget,
418 const gchar *full_path,
419 GtkAccelGroup *accel_group,
421 GdkModifierType modifiers)
423 GtkItemFactoryClass *class;
424 GtkItemFactoryItem *item;
426 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
427 g_return_if_fail (full_path != NULL);
429 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
431 keyval = keyval != GDK_VoidSymbol ? keyval : 0;
433 item = g_hash_table_lookup (class->item_ht, full_path);
436 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
438 item->path = g_strdup (full_path);
439 item->accelerator_key = keyval;
440 item->accelerator_mods = modifiers;
441 item->modified = FALSE;
442 item->in_propagation = FALSE;
444 item->widgets = NULL;
446 g_hash_table_insert (class->item_ht, item->path, item);
449 item->widgets = g_slist_prepend (item->widgets, accel_widget);
450 gtk_signal_connect (GTK_OBJECT (accel_widget),
452 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
455 /* set the item path for the widget
457 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
458 gtk_widget_set_name (accel_widget, item->path);
461 gtk_accel_group_ref (accel_group);
462 gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
465 (GtkDestroyNotify) gtk_accel_group_unref);
468 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
470 /* install defined accelerators
472 if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
474 if (item->accelerator_key && accel_group)
475 gtk_widget_add_accelerator (accel_widget,
478 item->accelerator_key,
479 item->accelerator_mods,
482 gtk_widget_remove_accelerators (accel_widget,
487 /* keep track of accelerator changes
489 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
491 GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
493 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
494 "remove-accelerator",
495 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
500 ifactory_cb_data_free (gpointer mem)
502 g_mem_chunk_free (ifactory_cb_data_chunks, mem);
506 gtk_item_factory_add_item (GtkItemFactory *ifactory,
508 const gchar *accelerator,
509 GtkItemFactoryCallback callback,
510 guint callback_action,
511 gpointer callback_data,
516 GtkItemFactoryClass *class;
517 GtkItemFactoryItem *item;
521 g_return_if_fail (widget != NULL);
522 g_return_if_fail (item_type != NULL);
524 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
526 /* set accelerator group on menu widgets
528 if (GTK_IS_MENU (widget))
529 gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
531 /* connect callback if neccessary
537 data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
538 data->func = callback;
539 data->callback_type = callback_type;
540 data->func_data = callback_data;
541 data->callback_action = callback_action;
543 gtk_object_weakref (GTK_OBJECT (widget),
544 ifactory_cb_data_free,
546 gtk_signal_connect (GTK_OBJECT (widget),
548 GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
552 /* link the widget into its item-entry
553 * and keep back pointer on both the item factory and the widget
555 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
556 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
558 gtk_accelerator_parse (accelerator, &keyval, &mods);
564 fpath = g_strconcat (ifactory->path, path, NULL);
565 gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
566 item = g_hash_table_lookup (class->item_ht, fpath);
569 g_return_if_fail (item != NULL);
571 if (!g_slist_find (ifactory->items, item))
572 ifactory->items = g_slist_prepend (ifactory->items, item);
576 gtk_item_factory_construct (GtkItemFactory *ifactory,
577 GtkType container_type,
579 GtkAccelGroup *accel_group)
583 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
584 g_return_if_fail (ifactory->accel_group == NULL);
585 g_return_if_fail (path != NULL);
586 if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
587 g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
591 if (path[0] != '<' && path[len - 1] != '>')
593 g_warning ("GtkItemFactory: invalid factory path `%s'", path);
599 ifactory->accel_group = accel_group;
600 gtk_accel_group_ref (ifactory->accel_group);
603 ifactory->accel_group = gtk_accel_group_new ();
605 ifactory->path = g_strdup (path);
606 ifactory->widget = g_object_connect (gtk_widget_new (container_type, NULL),
607 "signal::destroy", gtk_widget_destroyed, &ifactory->widget,
609 gtk_object_ref (GTK_OBJECT (ifactory));
610 gtk_object_sink (GTK_OBJECT (ifactory));
612 gtk_item_factory_add_item (ifactory,
620 gtk_item_factory_from_path (const gchar *path)
622 GtkItemFactoryClass *class;
623 GtkItemFactoryItem *item;
627 g_return_val_if_fail (path != NULL, NULL);
628 g_return_val_if_fail (path[0] == '<', NULL);
630 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
633 while (path[i] && path[i] != '>')
637 g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
641 fname = g_new (gchar, i + 2);
642 g_memmove (fname, path, i + 1);
645 item = g_hash_table_lookup (class->item_ht, fname);
649 if (item && item->widgets)
650 return gtk_item_factory_from_widget (item->widgets->data);
656 gtk_item_factory_destroy (GtkObject *object)
658 GtkItemFactory *ifactory;
661 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
663 ifactory = (GtkItemFactory*) object;
665 if (ifactory->widget)
669 dobj = GTK_OBJECT (ifactory->widget);
671 gtk_object_ref (dobj);
672 gtk_object_sink (dobj);
673 gtk_object_destroy (dobj);
674 gtk_object_unref (dobj);
676 ifactory->widget = NULL;
679 for (slist = ifactory->items; slist; slist = slist->next)
681 GtkItemFactoryItem *item = slist->data;
684 for (link = item->widgets; link; link = link->next)
685 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
686 gtk_object_remove_data_by_id (link->data, quark_item_factory);
688 g_slist_free (ifactory->items);
689 ifactory->items = NULL;
691 GTK_OBJECT_CLASS (parent_class)->destroy (object);
695 gtk_item_factory_finalize (GObject *object)
697 GtkItemFactory *ifactory;
699 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
701 ifactory = GTK_ITEM_FACTORY (object);
703 gtk_accel_group_unref (ifactory->accel_group);
704 g_free (ifactory->path);
705 g_assert (ifactory->widget == NULL);
707 if (ifactory->translate_notify)
708 ifactory->translate_notify (ifactory->translate_data);
710 G_OBJECT_CLASS (parent_class)->finalize (object);
714 gtk_item_factory_from_widget (GtkWidget *widget)
716 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
718 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
722 gtk_item_factory_path_from_widget (GtkWidget *widget)
724 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
726 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
730 item_factory_escape_path (const gchar *path)
732 GString *str = g_string_new (NULL);
741 g_string_append (str, "\\n");
744 g_string_append (str, "\\r");
748 g_string_append_c (str, '\\');
751 g_string_append_c (str, c);
757 return g_string_free (str, FALSE);
761 gtk_item_factory_foreach (gpointer hash_key,
765 GtkItemFactoryItem *item;
770 gchar comment_prefix[2] = "\000\000";
775 if (data->pspec && !g_pattern_match_string (data->pspec, item->path))
778 comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];
780 path = item_factory_escape_path (hash_key);
781 name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
782 string = g_strconcat (item->modified ? "" : comment_prefix,
792 data->print_func (data->func_data, string);
798 gtk_item_factory_dump_items (GPatternSpec *path_pspec,
799 gboolean modified_only,
800 GtkPrintFunc print_func,
805 g_return_if_fail (print_func != NULL);
807 if (!gtk_item_factory_class)
808 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
810 data.print_func = print_func;
811 data.func_data = func_data;
812 data.modified_only = (modified_only != FALSE);
813 data.pspec = path_pspec;
815 g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
819 gtk_item_factory_print_func (gpointer FILE_pointer,
822 FILE *f_out = FILE_pointer;
824 g_return_if_fail (FILE_pointer != NULL);
825 g_return_if_fail (string != NULL);
827 fputs (string, f_out);
832 gtk_item_factory_dump_rc (const gchar *file_name,
833 GPatternSpec *path_pspec,
834 gboolean modified_only)
838 g_return_if_fail (file_name != NULL);
840 f_out = fopen (file_name, "w");
845 if (g_get_prgname ())
846 fputs (g_get_prgname (), f_out);
847 fputs (" GtkItemFactory rc-file -*- scheme -*-\n", f_out);
848 fputs ("; this file is an automated menu-path dump\n", f_out);
849 fputs (";\n", f_out);
851 gtk_item_factory_dump_items (path_pspec,
853 gtk_item_factory_print_func,
860 gtk_item_factory_create_items (GtkItemFactory *ifactory,
862 GtkItemFactoryEntry *entries,
863 gpointer callback_data)
865 gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
869 gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
871 GtkItemFactoryEntry *entries,
872 gpointer callback_data,
877 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
878 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
883 g_return_if_fail (entries != NULL);
885 for (i = 0; i < n_entries; i++)
886 gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
890 gtk_item_factory_get_widget (GtkItemFactory *ifactory,
893 GtkItemFactoryClass *class;
894 GtkItemFactoryItem *item;
896 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
897 g_return_val_if_fail (path != NULL, NULL);
899 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
902 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
907 fpath = g_strconcat (ifactory->path, path, NULL);
908 item = g_hash_table_lookup (class->item_ht, fpath);
916 for (slist = item->widgets; slist; slist = slist->next)
918 if (gtk_item_factory_from_widget (slist->data) == ifactory)
927 gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
932 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
934 for (slist = ifactory->items; slist; slist = slist->next)
936 GtkItemFactoryItem *item = slist->data;
939 for (link = item->widgets; link; link = link->next)
940 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
941 gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
949 gtk_item_factory_get_item (GtkItemFactory *ifactory,
954 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
955 g_return_val_if_fail (path != NULL, NULL);
957 widget = gtk_item_factory_get_widget (ifactory, path);
959 if (GTK_IS_MENU (widget))
960 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
962 return GTK_IS_ITEM (widget) ? widget : NULL;
966 gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
971 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
973 widget = gtk_item_factory_get_widget_by_action (ifactory, action);
975 if (GTK_IS_MENU (widget))
976 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
978 return GTK_IS_ITEM (widget) ? widget : NULL;
982 item_factory_find_separator_r (char *path)
984 gchar *result = NULL;
985 gboolean escaped = FALSE;
995 else if (*path == '/')
1006 item_factory_unescape_label (const char *label)
1008 char *new = g_malloc (strlen (label) + 1);
1010 gboolean escaped = FALSE;
1036 gtk_item_factory_parse_path (GtkItemFactory *ifactory,
1039 gchar **parent_path,
1045 *path = g_strdup (str);
1066 *parent_path = g_strdup (*path);
1067 p = item_factory_find_separator_r (*parent_path);
1070 g_warning ("GtkItemFactory: invalid entry path `%s'", str);
1075 if (ifactory->translate_func)
1076 translation = ifactory->translate_func (str, ifactory->translate_data);
1080 p = item_factory_find_separator_r (translation);
1086 *item = item_factory_unescape_label (p);
1092 gtk_item_factory_create_item (GtkItemFactory *ifactory,
1093 GtkItemFactoryEntry *entry,
1094 gpointer callback_data,
1095 guint callback_type)
1097 GtkOptionMenu *option_menu = NULL;
1101 GSList *radio_group;
1108 gchar *item_type_path;
1109 GtkStockItem stock_item;
1111 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1112 g_return_if_fail (entry != NULL);
1113 g_return_if_fail (entry->path != NULL);
1114 g_return_if_fail (entry->path[0] == '/');
1115 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
1117 if (!entry->item_type ||
1118 entry->item_type[0] == 0)
1120 item_type_path = "<Item>";
1121 type_id = quark_type_item;
1125 item_type_path = entry->item_type;
1126 type_id = gtk_object_data_try_key (item_type_path);
1130 if (type_id == quark_type_item)
1131 type = GTK_TYPE_MENU_ITEM;
1132 else if (type_id == quark_type_title)
1133 type = GTK_TYPE_MENU_ITEM;
1134 else if (type_id == quark_type_radio_item)
1135 type = GTK_TYPE_RADIO_MENU_ITEM;
1136 else if (type_id == quark_type_check_item)
1137 type = GTK_TYPE_CHECK_MENU_ITEM;
1138 else if (type_id == quark_type_image_item)
1139 type = GTK_TYPE_IMAGE_MENU_ITEM;
1140 else if (type_id == quark_type_stock_item)
1141 type = GTK_TYPE_IMAGE_MENU_ITEM;
1142 else if (type_id == quark_type_tearoff_item)
1143 type = GTK_TYPE_TEAROFF_MENU_ITEM;
1144 else if (type_id == quark_type_toggle_item)
1145 type = GTK_TYPE_CHECK_MENU_ITEM;
1146 else if (type_id == quark_type_separator_item)
1147 type = GTK_TYPE_MENU_ITEM;
1148 else if (type_id == quark_type_branch)
1149 type = GTK_TYPE_MENU_ITEM;
1150 else if (type_id == quark_type_last_branch)
1151 type = GTK_TYPE_MENU_ITEM;
1154 GtkWidget *radio_link;
1156 radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
1157 if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
1159 type = GTK_TYPE_RADIO_MENU_ITEM;
1160 radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
1164 g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
1171 if (!gtk_item_factory_parse_path (ifactory, entry->path,
1172 &path, &parent_path, &name))
1175 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1178 GtkItemFactoryEntry pentry;
1181 ppath = g_strdup (entry->path);
1182 p = item_factory_find_separator_r (ppath);
1183 g_return_if_fail (p != NULL);
1185 pentry.path = ppath;
1186 pentry.accelerator = NULL;
1187 pentry.callback = NULL;
1188 pentry.callback_action = 0;
1189 pentry.item_type = "<Branch>";
1191 gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1194 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1195 g_return_if_fail (parent != NULL);
1197 g_free (parent_path);
1199 if (GTK_IS_OPTION_MENU (parent))
1201 option_menu = GTK_OPTION_MENU (parent);
1202 if (!option_menu->menu)
1203 gtk_option_menu_set_menu (option_menu, gtk_widget_new (GTK_TYPE_MENU, NULL));
1204 parent = option_menu->menu;
1207 g_return_if_fail (GTK_IS_CONTAINER (parent));
1209 accelerator = entry->accelerator;
1211 widget = gtk_widget_new (type,
1212 "GtkWidget::visible", TRUE,
1213 "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
1214 type_id != quark_type_title),
1215 "GtkWidget::parent", parent,
1217 if (option_menu && !option_menu->menu_item)
1218 gtk_option_menu_set_history (option_menu, 0);
1220 if (type == GTK_TYPE_RADIO_MENU_ITEM)
1221 gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
1222 if (GTK_IS_CHECK_MENU_ITEM (widget))
1223 gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1224 if (type_id == quark_type_image_item)
1226 GdkPixbuf *pixbuf = NULL;
1229 pixbuf = gdk_pixbuf_new_from_stream (-1,
1235 image = gtk_image_new_from_pixbuf (pixbuf);
1238 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
1241 g_object_unref (G_OBJECT (pixbuf));
1243 if (type_id == quark_type_stock_item)
1245 image = gtk_image_new_from_stock (entry->extra_data, GTK_ICON_SIZE_MENU);
1247 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (widget), image);
1249 if (gtk_stock_lookup (entry->extra_data, &stock_item))
1252 accelerator = gtk_accelerator_name (stock_item.keyval, stock_item.modifier);
1258 /* install underline accelerators for this item
1260 if (type_id != quark_type_separator_item &&
1261 type_id != quark_type_tearoff_item &&
1266 label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
1267 "GtkWidget::visible", TRUE,
1268 "GtkWidget::parent", widget,
1269 "GtkAccelLabel::accel_widget", widget,
1270 "GtkMisc::xalign", 0.0,
1273 gtk_label_set_text_with_mnemonic (GTK_LABEL (label), name);
1278 if (type_id == quark_type_branch ||
1279 type_id == quark_type_last_branch)
1281 if (entry->callback)
1282 g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
1285 if (type_id == quark_type_last_branch)
1286 gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1289 widget = gtk_widget_new (GTK_TYPE_MENU,
1292 gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
1295 gtk_item_factory_add_item (ifactory,
1297 (type_id == quark_type_branch ||
1298 type_id == quark_type_last_branch) ?
1299 (GtkItemFactoryCallback) NULL : entry->callback,
1300 entry->callback_action, callback_data,
1305 if (accelerator != entry->accelerator)
1306 g_free (accelerator);
1312 gtk_item_factory_create_menu_entries (guint n_entries,
1313 GtkMenuEntry *entries)
1315 static GPatternSpec *pspec_separator = NULL;
1316 static GPatternSpec *pspec_check = NULL;
1321 g_return_if_fail (entries != NULL);
1323 if (!pspec_separator)
1325 pspec_separator = g_pattern_spec_new ("*<separator>*");
1326 pspec_check = g_pattern_spec_new ("*<check>*");
1329 for (i = 0; i < n_entries; i++)
1331 GtkItemFactory *ifactory;
1332 GtkItemFactoryEntry entry;
1336 path = entries[i].path;
1337 ifactory = gtk_item_factory_from_path (path);
1340 g_warning ("gtk_item_factory_create_menu_entries(): "
1341 "entry[%u] refers to unknown item factory: \"%s\"",
1342 i, entries[i].path);
1346 while (*path != '>')
1352 entry.accelerator = entries[i].accelerator;
1353 entry.callback = entries[i].callback;
1354 entry.callback_action = 0;
1355 if (g_pattern_match_string (pspec_separator, path))
1356 entry.item_type = "<Separator>";
1357 else if (!g_pattern_match_string (pspec_check, path))
1358 entry.item_type = NULL;
1361 gboolean in_brace = FALSE;
1364 cpath = g_new (gchar, strlen (path));
1370 else if (*path == '>')
1377 entry.item_type = "<ToggleItem>";
1381 gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
1382 entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1388 gtk_item_factories_path_delete (const gchar *ifactory_path,
1391 GtkItemFactoryClass *class;
1392 GtkItemFactoryItem *item;
1394 g_return_if_fail (path != NULL);
1396 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1399 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
1404 g_return_if_fail (ifactory_path != NULL);
1406 fpath = g_strconcat (ifactory_path, path, NULL);
1407 item = g_hash_table_lookup (class->item_ht, fpath);
1413 GSList *widget_list;
1417 for (slist = item->widgets; slist; slist = slist->next)
1421 widget = slist->data;
1422 widget_list = g_slist_prepend (widget_list, widget);
1423 gtk_widget_ref (widget);
1426 for (slist = widget_list; slist; slist = slist->next)
1430 widget = slist->data;
1431 gtk_widget_destroy (widget);
1432 gtk_widget_unref (widget);
1434 g_slist_free (widget_list);
1439 gtk_item_factory_delete_item (GtkItemFactory *ifactory,
1442 GtkItemFactoryClass *class;
1445 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1446 g_return_if_fail (path != NULL);
1448 class = GTK_ITEM_FACTORY_GET_CLASS (ifactory);
1450 widget = gtk_item_factory_get_widget (ifactory, path);
1454 if (GTK_IS_MENU (widget))
1455 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
1457 gtk_widget_destroy (widget);
1462 gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
1463 GtkItemFactoryEntry *entry)
1465 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1466 g_return_if_fail (entry != NULL);
1468 gtk_item_factory_delete_item (ifactory, entry->path);
1472 gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
1474 GtkItemFactoryEntry *entries)
1478 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1480 g_return_if_fail (entries != NULL);
1482 for (i = 0; i < n_entries; i++)
1483 gtk_item_factory_delete_item (ifactory, (entries + i)->path);
1493 gtk_item_factory_menu_pos (GtkMenu *menu,
1499 MenuPos *mpos = func_data;
1506 gtk_item_factory_popup_data_from_widget (GtkWidget *widget)
1508 GtkItemFactory *ifactory;
1510 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1512 ifactory = gtk_item_factory_from_widget (widget);
1514 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1520 gtk_item_factory_popup_data (GtkItemFactory *ifactory)
1522 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
1524 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1528 ifactory_delete_popup_data (GtkObject *object,
1529 GtkItemFactory *ifactory)
1531 gtk_signal_disconnect_by_func (object,
1532 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1534 gtk_object_remove_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1538 gtk_item_factory_popup (GtkItemFactory *ifactory,
1544 gtk_item_factory_popup_with_data (ifactory, NULL, NULL, x, y, mouse_button, time);
1548 gtk_item_factory_popup_with_data (GtkItemFactory *ifactory,
1549 gpointer popup_data,
1550 GtkDestroyNotify destroy,
1558 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1559 g_return_if_fail (GTK_IS_MENU (ifactory->widget));
1561 mpos = gtk_object_get_data_by_id (GTK_OBJECT (ifactory->widget), quark_if_menu_pos);
1565 mpos = g_new0 (MenuPos, 1);
1566 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory->widget),
1575 if (popup_data != NULL)
1577 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory),
1581 gtk_signal_connect (GTK_OBJECT (ifactory->widget),
1583 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1587 gtk_menu_popup (GTK_MENU (ifactory->widget),
1589 gtk_item_factory_menu_pos, mpos,
1590 mouse_button, time);
1594 gtk_item_factory_parse_menu_path (GScanner *scanner,
1595 GtkItemFactoryClass *class)
1597 GtkItemFactoryItem *item;
1599 g_scanner_get_next_token (scanner);
1600 if (scanner->token != G_TOKEN_STRING)
1601 return G_TOKEN_STRING;
1603 g_scanner_peek_next_token (scanner);
1604 if (scanner->next_token != G_TOKEN_STRING)
1606 g_scanner_get_next_token (scanner);
1607 return G_TOKEN_STRING;
1610 item = g_hash_table_lookup (class->item_ht, scanner->value.v_string);
1613 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
1615 item->path = g_strdup (scanner->value.v_string);
1616 item->accelerator_key = 0;
1617 item->accelerator_mods = 0;
1618 item->modified = TRUE;
1619 item->in_propagation = FALSE;
1621 item->widgets = NULL;
1623 g_hash_table_insert (class->item_ht, item->path, item);
1625 g_scanner_get_next_token (scanner);
1627 if (!item->in_propagation)
1632 old_keyval = item->accelerator_key;
1633 old_mods = item->accelerator_mods;
1634 gtk_accelerator_parse (scanner->value.v_string,
1635 &item->accelerator_key,
1636 &item->accelerator_mods);
1637 if (old_keyval != item->accelerator_key ||
1638 old_mods != item->accelerator_mods)
1640 item->modified = TRUE;
1641 gtk_item_factory_propagate_accelerator (item, NULL);
1645 g_scanner_get_next_token (scanner);
1646 if (scanner->token != ')')
1649 return G_TOKEN_NONE;
1653 gtk_item_factory_parse_statement (GScanner *scanner,
1654 GtkItemFactoryClass *class)
1656 guint expected_token;
1658 g_scanner_get_next_token (scanner);
1660 if (scanner->token == G_TOKEN_SYMBOL)
1662 guint (*parser_func) (GScanner*, GtkItemFactoryClass*);
1664 parser_func = scanner->value.v_symbol;
1666 /* check whether this is a GtkItemFactory symbol.
1668 if (parser_func == gtk_item_factory_parse_menu_path)
1669 expected_token = parser_func (scanner, class);
1671 expected_token = G_TOKEN_SYMBOL;
1674 expected_token = G_TOKEN_SYMBOL;
1676 /* skip rest of statement on errrors
1678 if (expected_token != G_TOKEN_NONE)
1680 register guint level;
1683 if (scanner->token == ')')
1685 if (scanner->token == '(')
1688 while (!g_scanner_eof (scanner) && level > 0)
1690 g_scanner_get_next_token (scanner);
1692 if (scanner->token == '(')
1694 else if (scanner->token == ')')
1701 gtk_item_factory_parse_rc_string (const gchar *rc_string)
1705 g_return_if_fail (rc_string != NULL);
1707 if (!gtk_item_factory_class)
1708 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1710 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1711 scanner = g_scanner_new (&ifactory_scanner_config);
1713 g_scanner_input_text (scanner, rc_string, strlen (rc_string));
1715 gtk_item_factory_parse_rc_scanner (scanner);
1717 g_scanner_destroy (scanner);
1721 gtk_item_factory_parse_rc_scanner (GScanner *scanner)
1723 gpointer saved_symbol;
1725 g_return_if_fail (scanner != NULL);
1727 if (!gtk_item_factory_class)
1728 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1730 saved_symbol = g_scanner_lookup_symbol (scanner, "menu-path");
1731 g_scanner_remove_symbol (scanner, "menu-path");
1732 g_scanner_add_symbol (scanner, "menu-path", gtk_item_factory_parse_menu_path);
1734 g_scanner_peek_next_token (scanner);
1736 while (scanner->next_token == '(')
1738 g_scanner_get_next_token (scanner);
1740 gtk_item_factory_parse_statement (scanner, gtk_item_factory_class);
1742 g_scanner_peek_next_token (scanner);
1745 g_scanner_remove_symbol (scanner, "menu-path");
1746 g_scanner_add_symbol (scanner, "menu-path", saved_symbol);
1750 gtk_item_factory_parse_rc (const gchar *file_name)
1755 g_return_if_fail (file_name != NULL);
1757 if (!S_ISREG (g_scanner_stat_mode (file_name)))
1760 fd = open (file_name, O_RDONLY);
1764 if (!gtk_item_factory_class)
1765 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1767 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1768 scanner = g_scanner_new (&ifactory_scanner_config);
1770 g_scanner_input_file (scanner, fd);
1772 gtk_item_factory_parse_rc_scanner (scanner);
1774 g_scanner_destroy (scanner);
1780 gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
1781 GtkTranslateFunc func,
1783 GtkDestroyNotify notify)
1785 g_return_if_fail (ifactory != NULL);
1787 if (ifactory->translate_notify)
1788 ifactory->translate_notify (ifactory->translate_data);
1790 ifactory->translate_func = func;
1791 ifactory->translate_data = data;
1792 ifactory->translate_notify = notify;