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 Library 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 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library 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-1999. 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/gtktearoffmenuitem.h"
41 #include "gtk/gtkaccellabel.h"
42 #include "gdk/gdkkeysyms.h"
52 #include <io.h> /* For _open and _close */
55 #define S_ISREG(mode) ((mode)&_S_IFREG)
61 #define ITEM_FACTORY_STRING ((gchar*) item_factory_string)
62 #define ITEM_BLOCK_SIZE (128)
65 /* --- structures --- */
66 typedef struct _GtkIFCBData GtkIFCBData;
67 typedef struct _GtkIFDumpData GtkIFDumpData;
70 GtkItemFactoryCallback func;
73 guint callback_action;
77 GtkPrintFunc print_func;
79 guint modified_only : 1;
80 GtkPatternSpec *pspec;
84 /* --- prototypes --- */
85 static void gtk_item_factory_class_init (GtkItemFactoryClass *klass);
86 static void gtk_item_factory_init (GtkItemFactory *ifactory);
87 static void gtk_item_factory_destroy (GtkObject *object);
88 static void gtk_item_factory_finalize (GtkObject *object);
91 /* --- static variables --- */
92 static GtkItemFactoryClass *gtk_item_factory_class = NULL;
93 static GtkObjectClass *parent_class = NULL;
94 static const gchar *item_factory_string = "Gtk-<ItemFactory>";
95 static GMemChunk *ifactory_item_chunks = NULL;
96 static GMemChunk *ifactory_cb_data_chunks = NULL;
97 static GQuark quark_popup_data = 0;
98 static GQuark quark_if_menu_pos = 0;
99 static GQuark quark_item_factory = 0;
100 static GQuark quark_item_path = 0;
101 static GQuark quark_action = 0;
102 static GQuark quark_accel_group = 0;
103 static GQuark quark_type_item = 0;
104 static GQuark quark_type_title = 0;
105 static GQuark quark_type_radio_item = 0;
106 static GQuark quark_type_check_item = 0;
107 static GQuark quark_type_toggle_item = 0;
108 static GQuark quark_type_tearoff_item = 0;
109 static GQuark quark_type_separator_item = 0;
110 static GQuark quark_type_branch = 0;
111 static GQuark quark_type_last_branch = 0;
112 static GScannerConfig ifactory_scanner_config =
116 ) /* cset_skip_characters */,
121 ) /* cset_identifier_first */,
128 ) /* cset_identifier_nth */,
129 ( ";\n" ) /* cpair_comment_single */,
131 FALSE /* case_sensitive */,
133 TRUE /* skip_comment_multi */,
134 TRUE /* skip_comment_single */,
135 FALSE /* scan_comment_multi */,
136 TRUE /* scan_identifier */,
137 FALSE /* scan_identifier_1char */,
138 FALSE /* scan_identifier_NULL */,
139 TRUE /* scan_symbols */,
140 TRUE /* scan_binary */,
141 TRUE /* scan_octal */,
142 TRUE /* scan_float */,
144 FALSE /* scan_hex_dollar */,
145 TRUE /* scan_string_sq */,
146 TRUE /* scan_string_dq */,
147 TRUE /* numbers_2_int */,
148 FALSE /* int_2_float */,
149 FALSE /* identifier_2_string */,
150 TRUE /* char_2_token */,
151 FALSE /* symbol_2_token */,
155 /* --- functions --- */
157 gtk_item_factory_get_type (void)
159 static GtkType item_factory_type = 0;
161 if (!item_factory_type)
163 static const GtkTypeInfo item_factory_info =
166 sizeof (GtkItemFactory),
167 sizeof (GtkItemFactoryClass),
168 (GtkClassInitFunc) gtk_item_factory_class_init,
169 (GtkObjectInitFunc) gtk_item_factory_init,
170 /* reserved_1 */ NULL,
171 /* reserved_2 */ NULL,
172 (GtkClassInitFunc) NULL,
175 item_factory_type = gtk_type_unique (GTK_TYPE_OBJECT, &item_factory_info);
178 return item_factory_type;
182 gtk_item_factory_class_init (GtkItemFactoryClass *class)
184 GtkObjectClass *object_class;
186 gtk_item_factory_class = class;
188 parent_class = gtk_type_class (GTK_TYPE_OBJECT);
190 object_class = (GtkObjectClass*) class;
192 object_class->destroy = gtk_item_factory_destroy;
193 object_class->finalize = gtk_item_factory_finalize;
195 class->cpair_comment_single = g_strdup (";\n");
197 class->item_ht = g_hash_table_new (g_str_hash, g_str_equal);
199 ifactory_item_chunks =
200 g_mem_chunk_new ("GtkItemFactoryItem",
201 sizeof (GtkItemFactoryItem),
202 sizeof (GtkItemFactoryItem) * ITEM_BLOCK_SIZE,
204 ifactory_cb_data_chunks =
205 g_mem_chunk_new ("GtkIFCBData",
206 sizeof (GtkIFCBData),
207 sizeof (GtkIFCBData) * ITEM_BLOCK_SIZE,
210 quark_popup_data = g_quark_from_static_string ("GtkItemFactory-popup-data");
211 quark_if_menu_pos = g_quark_from_static_string ("GtkItemFactory-menu-position");
212 quark_item_factory = g_quark_from_static_string ("GtkItemFactory");
213 quark_item_path = g_quark_from_static_string ("GtkItemFactory-path");
214 quark_action = g_quark_from_static_string ("GtkItemFactory-action");
215 quark_accel_group = g_quark_from_static_string ("GtkAccelGroup");
216 quark_type_item = g_quark_from_static_string ("<Item>");
217 quark_type_title = g_quark_from_static_string ("<Title>");
218 quark_type_radio_item = g_quark_from_static_string ("<RadioItem>");
219 quark_type_check_item = g_quark_from_static_string ("<CheckItem>");
220 quark_type_toggle_item = g_quark_from_static_string ("<ToggleItem>");
221 quark_type_tearoff_item = g_quark_from_static_string ("<Tearoff>");
222 quark_type_separator_item = g_quark_from_static_string ("<Separator>");
223 quark_type_branch = g_quark_from_static_string ("<Branch>");
224 quark_type_last_branch = g_quark_from_static_string ("<LastBranch>");
228 gtk_item_factory_init (GtkItemFactory *ifactory)
232 object = GTK_OBJECT (ifactory);
234 ifactory->path = NULL;
235 ifactory->accel_group = NULL;
236 ifactory->widget = NULL;
237 ifactory->items = NULL;
238 ifactory->translate_func = NULL;
239 ifactory->translate_data = NULL;
240 ifactory->translate_notify = NULL;
244 gtk_item_factory_new (GtkType container_type,
246 GtkAccelGroup *accel_group)
248 GtkItemFactory *ifactory;
250 g_return_val_if_fail (path != NULL, NULL);
252 ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
253 gtk_item_factory_construct (ifactory, container_type, path, accel_group);
259 gtk_item_factory_callback_marshal (GtkWidget *widget,
266 if (data->callback_type == 1)
268 GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
269 func1 (data->func_data, data->callback_action, widget);
271 else if (data->callback_type == 2)
273 GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
274 func2 (widget, data->func_data, data->callback_action);
279 gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
285 if (item->in_propagation)
288 item->in_propagation = TRUE;
291 for (slist = item->widgets; slist; slist = slist->next)
295 widget = slist->data;
297 if (widget != exclude)
299 gtk_widget_ref (widget);
300 widget_list = g_slist_prepend (widget_list, widget);
304 for (slist = widget_list; slist; slist = slist->next)
307 GtkAccelGroup *accel_group;
310 widget = slist->data;
312 accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
314 signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
315 if (signal_id && accel_group)
317 if (item->accelerator_key)
318 gtk_widget_add_accelerator (widget,
321 item->accelerator_key,
322 item->accelerator_mods,
328 work = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
331 GtkAccelEntry *ac_entry;
333 ac_entry = work->data;
335 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
336 ac_entry->accel_group == accel_group &&
337 ac_entry->signal_id == signal_id)
338 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
339 ac_entry->accel_group,
340 ac_entry->accelerator_key,
341 ac_entry->accelerator_mods);
346 gtk_widget_unref (widget);
349 g_slist_free (widget_list);
351 item->in_propagation = FALSE;
355 gtk_item_factory_item_add_accelerator (GtkWidget *widget,
356 guint accel_signal_id,
357 GtkAccelGroup *accel_group,
360 GtkAccelFlags accel_flags,
361 GtkItemFactoryItem *item)
363 if (!item->in_propagation &&
364 g_slist_find (item->widgets, widget) &&
365 accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
367 item->accelerator_key = accel_key;
368 item->accelerator_mods = accel_mods;
369 item->modified = TRUE;
371 gtk_item_factory_propagate_accelerator (item, widget);
378 gtk_item_factory_item_remove_accelerator (GtkWidget *widget,
379 GtkAccelGroup *accel_group,
382 GtkItemFactoryItem *item)
384 if (!item->in_propagation &&
385 g_slist_find (item->widgets, widget) &&
386 item->accelerator_key == accel_key &&
387 item->accelerator_mods == accel_mods)
389 item->accelerator_key = 0;
390 item->accelerator_mods = 0;
391 item->modified = TRUE;
393 gtk_item_factory_propagate_accelerator (item, widget);
398 gtk_item_factory_item_remove_widget (GtkWidget *widget,
399 GtkItemFactoryItem *item)
401 item->widgets = g_slist_remove (item->widgets, widget);
402 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
403 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
407 gtk_item_factory_add_foreign (GtkWidget *accel_widget,
408 const gchar *full_path,
409 GtkAccelGroup *accel_group,
411 GdkModifierType modifiers)
413 GtkItemFactoryClass *class;
414 GtkItemFactoryItem *item;
416 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
417 g_return_if_fail (full_path != NULL);
419 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
421 keyval = keyval != GDK_VoidSymbol ? keyval : 0;
423 item = g_hash_table_lookup (class->item_ht, full_path);
426 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
428 item->path = g_strdup (full_path);
429 item->accelerator_key = keyval;
430 item->accelerator_mods = modifiers;
431 item->modified = FALSE;
432 item->in_propagation = FALSE;
434 item->widgets = NULL;
436 g_hash_table_insert (class->item_ht, item->path, item);
439 item->widgets = g_slist_prepend (item->widgets, accel_widget);
440 gtk_signal_connect (GTK_OBJECT (accel_widget),
442 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
445 /* set the item path for the widget
447 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
448 gtk_widget_set_name (accel_widget, item->path);
451 gtk_accel_group_ref (accel_group);
452 gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
455 (GtkDestroyNotify) gtk_accel_group_unref);
458 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
460 /* install defined accelerators
462 if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
464 if (item->accelerator_key && accel_group)
465 gtk_widget_add_accelerator (accel_widget,
468 item->accelerator_key,
469 item->accelerator_mods,
472 gtk_widget_remove_accelerators (accel_widget,
477 /* keep track of accelerator changes
479 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
481 GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
483 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
484 "remove-accelerator",
485 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
490 ifactory_cb_data_free (gpointer mem)
492 g_mem_chunk_free (ifactory_cb_data_chunks, mem);
496 gtk_item_factory_add_item (GtkItemFactory *ifactory,
498 const gchar *accelerator,
499 GtkItemFactoryCallback callback,
500 guint callback_action,
501 gpointer callback_data,
506 GtkItemFactoryClass *class;
507 GtkItemFactoryItem *item;
511 g_return_if_fail (widget != NULL);
512 g_return_if_fail (item_type != NULL);
514 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
516 /* set accelerator group on menu widgets
518 if (GTK_IS_MENU (widget))
519 gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
521 /* connect callback if neccessary
527 data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
528 data->func = callback;
529 data->callback_type = callback_type;
530 data->func_data = callback_data;
531 data->callback_action = callback_action;
533 gtk_object_weakref (GTK_OBJECT (widget),
534 ifactory_cb_data_free,
536 gtk_signal_connect (GTK_OBJECT (widget),
538 GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
542 /* link the widget into its item-entry
543 * and keep back pointer on both the item factory and the widget
545 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
546 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
548 gtk_accelerator_parse (accelerator, &keyval, &mods);
554 fpath = g_strconcat (ifactory->path, path, NULL);
555 gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
556 item = g_hash_table_lookup (class->item_ht, fpath);
559 g_return_if_fail (item != NULL);
561 if (!g_slist_find (ifactory->items, item))
562 ifactory->items = g_slist_prepend (ifactory->items, item);
566 gtk_item_factory_construct (GtkItemFactory *ifactory,
567 GtkType container_type,
569 GtkAccelGroup *accel_group)
573 g_return_if_fail (ifactory != NULL);
574 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
575 g_return_if_fail (ifactory->accel_group == NULL);
576 g_return_if_fail (path != NULL);
577 if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
578 g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
582 if (path[0] != '<' && path[len - 1] != '>')
584 g_warning ("GtkItemFactory: invalid factory path `%s'", path);
590 ifactory->accel_group = accel_group;
591 gtk_accel_group_ref (ifactory->accel_group);
594 ifactory->accel_group = gtk_accel_group_new ();
596 ifactory->path = g_strdup (path);
598 gtk_widget_new (container_type,
599 "GtkObject::signal::destroy", gtk_widget_destroyed, &ifactory->widget,
601 gtk_object_ref (GTK_OBJECT (ifactory));
602 gtk_object_sink (GTK_OBJECT (ifactory));
604 gtk_item_factory_add_item (ifactory,
612 gtk_item_factory_from_path (const gchar *path)
614 GtkItemFactoryClass *class;
615 GtkItemFactoryItem *item;
619 g_return_val_if_fail (path != NULL, NULL);
620 g_return_val_if_fail (path[0] == '<', NULL);
622 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
625 while (path[i] && path[i] != '>')
629 g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
633 fname = g_new (gchar, i + 2);
634 g_memmove (fname, path, i + 1);
637 item = g_hash_table_lookup (class->item_ht, fname);
641 if (item && item->widgets)
642 return gtk_item_factory_from_widget (item->widgets->data);
648 gtk_item_factory_destroy (GtkObject *object)
650 GtkItemFactory *ifactory;
653 g_return_if_fail (object != NULL);
654 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
656 ifactory = (GtkItemFactory*) object;
658 if (ifactory->widget)
662 dobj = GTK_OBJECT (ifactory->widget);
664 gtk_object_ref (dobj);
665 gtk_object_sink (dobj);
666 gtk_object_destroy (dobj);
667 gtk_object_unref (dobj);
669 ifactory->widget = NULL;
672 for (slist = ifactory->items; slist; slist = slist->next)
674 GtkItemFactoryItem *item = slist->data;
677 for (link = item->widgets; link; link = link->next)
678 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory)
679 gtk_object_remove_data_by_id (link->data, quark_item_factory);
681 g_slist_free (ifactory->items);
682 ifactory->items = NULL;
684 parent_class->destroy (object);
688 gtk_item_factory_finalize (GtkObject *object)
690 GtkItemFactory *ifactory;
692 g_return_if_fail (object != NULL);
693 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
695 ifactory = GTK_ITEM_FACTORY (object);
697 gtk_accel_group_unref (ifactory->accel_group);
698 g_free (ifactory->path);
699 g_assert (ifactory->widget == NULL);
701 if (ifactory->translate_notify)
702 ifactory->translate_notify (ifactory->translate_data);
704 parent_class->finalize (object);
708 gtk_item_factory_from_widget (GtkWidget *widget)
710 g_return_val_if_fail (widget != NULL, NULL);
711 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
713 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
717 gtk_item_factory_path_from_widget (GtkWidget *widget)
719 g_return_val_if_fail (widget != NULL, NULL);
720 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
722 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
726 gtk_item_factory_foreach (gpointer hash_key,
730 GtkItemFactoryItem *item;
734 gchar comment_prefix[2] = "\000\000";
739 if (data->pspec && !gtk_pattern_match_string (data->pspec, item->path))
742 comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];
744 name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
745 string = g_strconcat (item->modified ? "" : comment_prefix,
754 data->print_func (data->func_data, string);
760 gtk_item_factory_dump_items (GtkPatternSpec *path_pspec,
761 gboolean modified_only,
762 GtkPrintFunc print_func,
767 g_return_if_fail (print_func != NULL);
769 if (!gtk_item_factory_class)
770 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
772 data.print_func = print_func;
773 data.func_data = func_data;
774 data.modified_only = (modified_only != FALSE);
775 data.pspec = path_pspec;
777 g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
781 gtk_item_factory_print_func (gpointer FILE_pointer,
784 FILE *f_out = FILE_pointer;
786 g_return_if_fail (FILE_pointer != NULL);
787 g_return_if_fail (string != NULL);
789 fputs (string, f_out);
794 gtk_item_factory_dump_rc (const gchar *file_name,
795 GtkPatternSpec *path_pspec,
796 gboolean modified_only)
800 g_return_if_fail (file_name != NULL);
802 f_out = fopen (file_name, "w");
807 if (g_get_prgname ())
808 fputs (g_get_prgname (), f_out);
809 fputs (" GtkItemFactory rc-file -*- scheme -*-\n", f_out);
810 fputs ("; this file is an automated menu-path dump\n", f_out);
811 fputs (";\n", f_out);
813 gtk_item_factory_dump_items (path_pspec,
815 gtk_item_factory_print_func,
822 gtk_item_factory_create_items (GtkItemFactory *ifactory,
824 GtkItemFactoryEntry *entries,
825 gpointer callback_data)
827 gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
831 gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
833 GtkItemFactoryEntry *entries,
834 gpointer callback_data,
839 g_return_if_fail (ifactory != NULL);
840 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
841 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
846 g_return_if_fail (entries != NULL);
848 for (i = 0; i < n_entries; i++)
849 gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
853 gtk_item_factory_get_widget (GtkItemFactory *ifactory,
856 GtkItemFactoryClass *class;
857 GtkItemFactoryItem *item;
859 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
860 g_return_val_if_fail (path != NULL, NULL);
862 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
865 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
870 fpath = g_strconcat (ifactory->path, path, NULL);
871 item = g_hash_table_lookup (class->item_ht, fpath);
879 for (slist = item->widgets; slist; slist = slist->next)
881 if (gtk_item_factory_from_widget (slist->data) == ifactory)
890 gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
895 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
897 for (slist = ifactory->items; slist; slist = slist->next)
899 GtkItemFactoryItem *item = slist->data;
902 for (link = item->widgets; link; link = link->next)
903 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
904 gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
912 gtk_item_factory_get_item (GtkItemFactory *ifactory,
917 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
918 g_return_val_if_fail (path != NULL, NULL);
920 widget = gtk_item_factory_get_widget (ifactory, path);
922 if (GTK_IS_MENU (widget))
923 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
925 return GTK_IS_ITEM (widget) ? widget : NULL;
929 gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
934 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
936 widget = gtk_item_factory_get_widget_by_action (ifactory, action);
938 if (GTK_IS_MENU (widget))
939 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
941 return GTK_IS_ITEM (widget) ? widget : NULL;
945 gtk_item_factory_parse_path (GtkItemFactory *ifactory,
954 *path = g_strdup (str);
967 *parent_path = g_strdup (*path);
968 p = strrchr (*parent_path, '/');
971 g_warning ("GtkItemFactory: invalid entry path `%s'", str);
976 if (ifactory->translate_func)
977 translation = ifactory->translate_func (str, ifactory->translate_data);
981 p = strrchr (translation, '/');
987 *item = g_strdup (p);
993 gtk_item_factory_create_item (GtkItemFactory *ifactory,
994 GtkItemFactoryEntry *entry,
995 gpointer callback_data,
998 GtkOptionMenu *option_menu = NULL;
1001 GSList *radio_group;
1008 gchar *item_type_path;
1010 g_return_if_fail (ifactory != NULL);
1011 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1012 g_return_if_fail (entry != NULL);
1013 g_return_if_fail (entry->path != NULL);
1014 g_return_if_fail (entry->path[0] == '/');
1015 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
1017 if (!entry->item_type ||
1018 entry->item_type[0] == 0)
1020 item_type_path = "<Item>";
1021 type_id = quark_type_item;
1025 item_type_path = entry->item_type;
1026 type_id = gtk_object_data_try_key (item_type_path);
1030 if (type_id == quark_type_item)
1031 type = GTK_TYPE_MENU_ITEM;
1032 else if (type_id == quark_type_title)
1033 type = GTK_TYPE_MENU_ITEM;
1034 else if (type_id == quark_type_radio_item)
1035 type = GTK_TYPE_RADIO_MENU_ITEM;
1036 else if (type_id == quark_type_check_item)
1037 type = GTK_TYPE_CHECK_MENU_ITEM;
1038 else if (type_id == quark_type_tearoff_item)
1039 type = GTK_TYPE_TEAROFF_MENU_ITEM;
1040 else if (type_id == quark_type_toggle_item)
1041 type = GTK_TYPE_CHECK_MENU_ITEM;
1042 else if (type_id == quark_type_separator_item)
1043 type = GTK_TYPE_MENU_ITEM;
1044 else if (type_id == quark_type_branch)
1045 type = GTK_TYPE_MENU_ITEM;
1046 else if (type_id == quark_type_last_branch)
1047 type = GTK_TYPE_MENU_ITEM;
1050 GtkWidget *radio_link;
1052 radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
1053 if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
1055 type = GTK_TYPE_RADIO_MENU_ITEM;
1056 radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
1060 g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
1067 if (!gtk_item_factory_parse_path (ifactory, entry->path,
1068 &path, &parent_path, &name))
1071 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1074 GtkItemFactoryEntry pentry;
1077 ppath = g_strdup (entry->path);
1078 p = strrchr (ppath, '/');
1079 g_return_if_fail (p != NULL);
1081 pentry.path = ppath;
1082 pentry.accelerator = NULL;
1083 pentry.callback = NULL;
1084 pentry.callback_action = 0;
1085 pentry.item_type = "<Branch>";
1087 gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1090 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1091 g_return_if_fail (parent != NULL);
1093 g_free (parent_path);
1095 if (GTK_IS_OPTION_MENU (parent))
1097 option_menu = GTK_OPTION_MENU (parent);
1098 if (!option_menu->menu)
1099 gtk_option_menu_set_menu (option_menu, gtk_widget_new (GTK_TYPE_MENU, NULL));
1100 parent = option_menu->menu;
1103 g_return_if_fail (GTK_IS_CONTAINER (parent));
1105 widget = gtk_widget_new (type,
1106 "GtkWidget::visible", TRUE,
1107 "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
1108 type_id != quark_type_title),
1109 "GtkWidget::parent", parent,
1111 if (option_menu && !option_menu->menu_item)
1112 gtk_option_menu_set_history (option_menu, 0);
1114 if (type == GTK_TYPE_RADIO_MENU_ITEM)
1115 gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
1116 if (GTK_IS_CHECK_MENU_ITEM (widget))
1117 gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1119 /* install underline accelerators for this item
1121 if (type_id != quark_type_separator_item &&
1122 type_id != quark_type_tearoff_item &&
1127 label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
1128 "GtkWidget::visible", TRUE,
1129 "GtkWidget::parent", widget,
1130 "GtkAccelLabel::accel_widget", widget,
1131 "GtkMisc::xalign", 0.0,
1134 accel_key = gtk_label_parse_uline (GTK_LABEL (label), name);
1136 if (accel_key != GDK_VoidSymbol)
1138 if (GTK_IS_MENU_BAR (parent))
1139 gtk_widget_add_accelerator (widget,
1141 ifactory->accel_group,
1142 accel_key, GDK_MOD1_MASK,
1145 if (GTK_IS_MENU (parent))
1146 gtk_widget_add_accelerator (widget,
1148 gtk_menu_ensure_uline_accel_group (GTK_MENU (parent)),
1156 if (type_id == quark_type_branch ||
1157 type_id == quark_type_last_branch)
1159 if (entry->callback)
1160 g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
1163 if (type_id == quark_type_last_branch)
1164 gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1167 widget = gtk_widget_new (GTK_TYPE_MENU,
1170 gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
1173 gtk_item_factory_add_item (ifactory,
1174 path, entry->accelerator,
1175 (type_id == quark_type_branch ||
1176 type_id == quark_type_last_branch) ?
1177 (GtkItemFactoryCallback) NULL : entry->callback,
1178 entry->callback_action, callback_data,
1187 gtk_item_factory_create_menu_entries (guint n_entries,
1188 GtkMenuEntry *entries)
1190 static GtkPatternSpec pspec_separator = { 42, 0 };
1191 static GtkPatternSpec pspec_check = { 42, 0 };
1196 g_return_if_fail (entries != NULL);
1198 if (pspec_separator.pattern_length == 0)
1200 gtk_pattern_spec_init (&pspec_separator, "*<separator>*");
1201 gtk_pattern_spec_init (&pspec_check, "*<check>*");
1204 for (i = 0; i < n_entries; i++)
1206 GtkItemFactory *ifactory;
1207 GtkItemFactoryEntry entry;
1211 path = entries[i].path;
1212 ifactory = gtk_item_factory_from_path (path);
1215 g_warning ("gtk_item_factory_create_menu_entries(): "
1216 "entry[%u] refers to unknown item factory: \"%s\"",
1217 i, entries[i].path);
1221 while (*path != '>')
1227 entry.accelerator = entries[i].accelerator;
1228 entry.callback = entries[i].callback;
1229 entry.callback_action = 0;
1230 if (gtk_pattern_match_string (&pspec_separator, path))
1231 entry.item_type = "<Separator>";
1232 else if (!gtk_pattern_match_string (&pspec_check, path))
1233 entry.item_type = NULL;
1236 gboolean in_brace = FALSE;
1239 cpath = g_new (gchar, strlen (path));
1245 else if (*path == '>')
1252 entry.item_type = "<ToggleItem>";
1256 gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
1257 entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1263 gtk_item_factories_path_delete (const gchar *ifactory_path,
1266 GtkItemFactoryClass *class;
1267 GtkItemFactoryItem *item;
1269 g_return_if_fail (path != NULL);
1271 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1274 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
1279 g_return_if_fail (ifactory_path != NULL);
1281 fpath = g_strconcat (ifactory_path, path, NULL);
1282 item = g_hash_table_lookup (class->item_ht, fpath);
1288 GSList *widget_list;
1292 for (slist = item->widgets; slist; slist = slist->next)
1296 widget = slist->data;
1297 widget_list = g_slist_prepend (widget_list, widget);
1298 gtk_widget_ref (widget);
1301 for (slist = widget_list; slist; slist = slist->next)
1305 widget = slist->data;
1306 gtk_widget_destroy (widget);
1307 gtk_widget_unref (widget);
1309 g_slist_free (widget_list);
1314 gtk_item_factory_delete_item (GtkItemFactory *ifactory,
1317 GtkItemFactoryClass *class;
1318 GtkItemFactoryItem *item;
1321 g_return_if_fail (ifactory != NULL);
1322 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1323 g_return_if_fail (path != NULL);
1325 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
1327 fpath = g_strconcat (ifactory->path, path, NULL);
1328 item = g_hash_table_lookup (class->item_ht, fpath);
1333 GtkWidget *widget = NULL;
1336 for (slist = item->widgets; slist; slist = slist->next)
1338 widget = slist->data;
1340 if (gtk_item_factory_from_widget (widget) == ifactory)
1345 gtk_widget_destroy (widget);
1350 gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
1351 GtkItemFactoryEntry *entry)
1353 g_return_if_fail (ifactory != NULL);
1354 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1355 g_return_if_fail (entry != NULL);
1357 gtk_item_factory_delete_item (ifactory, entry->path);
1361 gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
1363 GtkItemFactoryEntry *entries)
1367 g_return_if_fail (ifactory != NULL);
1368 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1370 g_return_if_fail (entries != NULL);
1372 for (i = 0; i < n_entries; i++)
1373 gtk_item_factory_delete_item (ifactory, (entries + i)->path);
1383 gtk_item_factory_menu_pos (GtkMenu *menu,
1388 MenuPos *mpos = func_data;
1395 gtk_item_factory_popup_data_from_widget (GtkWidget *widget)
1397 GtkItemFactory *ifactory;
1399 g_return_val_if_fail (widget != NULL, NULL);
1400 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1402 ifactory = gtk_item_factory_from_widget (widget);
1404 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1410 gtk_item_factory_popup_data (GtkItemFactory *ifactory)
1412 g_return_val_if_fail (ifactory != NULL, NULL);
1413 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
1415 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1419 ifactory_delete_popup_data (GtkObject *object,
1420 GtkItemFactory *ifactory)
1422 gtk_signal_disconnect_by_func (object,
1423 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1425 gtk_object_remove_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1429 gtk_item_factory_popup (GtkItemFactory *ifactory,
1435 gtk_item_factory_popup_with_data (ifactory, NULL, NULL, x, y, mouse_button, time);
1439 gtk_item_factory_popup_with_data (GtkItemFactory *ifactory,
1440 gpointer popup_data,
1441 GtkDestroyNotify destroy,
1449 g_return_if_fail (ifactory != NULL);
1450 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1451 g_return_if_fail (GTK_IS_MENU (ifactory->widget));
1453 mpos = gtk_object_get_data_by_id (GTK_OBJECT (ifactory->widget), quark_if_menu_pos);
1457 mpos = g_new0 (MenuPos, 1);
1458 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory->widget),
1467 if (popup_data != NULL)
1469 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory),
1473 gtk_signal_connect (GTK_OBJECT (ifactory->widget),
1475 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1479 gtk_menu_popup (GTK_MENU (ifactory->widget),
1481 gtk_item_factory_menu_pos, mpos,
1482 mouse_button, time);
1486 gtk_item_factory_parse_menu_path (GScanner *scanner,
1487 GtkItemFactoryClass *class)
1489 GtkItemFactoryItem *item;
1491 g_scanner_get_next_token (scanner);
1492 if (scanner->token != G_TOKEN_STRING)
1493 return G_TOKEN_STRING;
1495 g_scanner_peek_next_token (scanner);
1496 if (scanner->next_token != G_TOKEN_STRING)
1498 g_scanner_get_next_token (scanner);
1499 return G_TOKEN_STRING;
1502 item = g_hash_table_lookup (class->item_ht, scanner->value.v_string);
1505 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
1507 item->path = g_strdup (scanner->value.v_string);
1508 item->accelerator_key = 0;
1509 item->accelerator_mods = 0;
1510 item->modified = TRUE;
1511 item->in_propagation = FALSE;
1513 item->widgets = NULL;
1515 g_hash_table_insert (class->item_ht, item->path, item);
1517 g_scanner_get_next_token (scanner);
1519 if (!item->in_propagation)
1524 old_keyval = item->accelerator_key;
1525 old_mods = item->accelerator_mods;
1526 gtk_accelerator_parse (scanner->value.v_string,
1527 &item->accelerator_key,
1528 &item->accelerator_mods);
1529 if (old_keyval != item->accelerator_key ||
1530 old_mods != item->accelerator_mods)
1532 item->modified = TRUE;
1533 gtk_item_factory_propagate_accelerator (item, NULL);
1537 g_scanner_get_next_token (scanner);
1538 if (scanner->token != ')')
1541 return G_TOKEN_NONE;
1545 gtk_item_factory_parse_statement (GScanner *scanner,
1546 GtkItemFactoryClass *class)
1548 guint expected_token;
1550 g_scanner_get_next_token (scanner);
1552 if (scanner->token == G_TOKEN_SYMBOL)
1554 guint (*parser_func) (GScanner*, GtkItemFactoryClass*);
1556 parser_func = scanner->value.v_symbol;
1558 /* check whether this is a GtkItemFactory symbol.
1560 if (parser_func == gtk_item_factory_parse_menu_path)
1561 expected_token = parser_func (scanner, class);
1563 expected_token = G_TOKEN_SYMBOL;
1566 expected_token = G_TOKEN_SYMBOL;
1568 /* skip rest of statement on errrors
1570 if (expected_token != G_TOKEN_NONE)
1572 register guint level;
1575 if (scanner->token == ')')
1577 if (scanner->token == '(')
1580 while (!g_scanner_eof (scanner) && level > 0)
1582 g_scanner_get_next_token (scanner);
1584 if (scanner->token == '(')
1586 else if (scanner->token == ')')
1593 gtk_item_factory_parse_rc_string (const gchar *rc_string)
1597 g_return_if_fail (rc_string != NULL);
1599 if (!gtk_item_factory_class)
1600 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1602 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1603 scanner = g_scanner_new (&ifactory_scanner_config);
1605 g_scanner_input_text (scanner, rc_string, strlen (rc_string));
1607 gtk_item_factory_parse_rc_scanner (scanner);
1609 g_scanner_destroy (scanner);
1613 gtk_item_factory_parse_rc_scanner (GScanner *scanner)
1615 gpointer saved_symbol;
1617 g_return_if_fail (scanner != NULL);
1619 if (!gtk_item_factory_class)
1620 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1622 saved_symbol = g_scanner_lookup_symbol (scanner, "menu-path");
1623 g_scanner_remove_symbol (scanner, "menu-path");
1624 g_scanner_add_symbol (scanner, "menu-path", gtk_item_factory_parse_menu_path);
1626 g_scanner_peek_next_token (scanner);
1628 while (scanner->next_token == '(')
1630 g_scanner_get_next_token (scanner);
1632 gtk_item_factory_parse_statement (scanner, gtk_item_factory_class);
1634 g_scanner_peek_next_token (scanner);
1637 g_scanner_remove_symbol (scanner, "menu-path");
1638 g_scanner_add_symbol (scanner, "menu-path", saved_symbol);
1642 gtk_item_factory_parse_rc (const gchar *file_name)
1647 g_return_if_fail (file_name != NULL);
1649 if (!S_ISREG (g_scanner_stat_mode (file_name)))
1652 fd = open (file_name, O_RDONLY);
1656 if (!gtk_item_factory_class)
1657 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1659 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1660 scanner = g_scanner_new (&ifactory_scanner_config);
1662 g_scanner_input_file (scanner, fd);
1664 gtk_item_factory_parse_rc_scanner (scanner);
1666 g_scanner_destroy (scanner);
1672 gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
1673 GtkTranslateFunc func,
1675 GtkDestroyNotify notify)
1677 g_return_if_fail (ifactory != NULL);
1679 if (ifactory->translate_notify)
1680 ifactory->translate_notify (ifactory->translate_data);
1682 ifactory->translate_func = func;
1683 ifactory->translate_data = data;
1684 ifactory->translate_notify = notify;