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;
241 gtk_item_factory_new (GtkType container_type,
243 GtkAccelGroup *accel_group)
245 GtkItemFactory *ifactory;
247 g_return_val_if_fail (path != NULL, NULL);
249 ifactory = gtk_type_new (GTK_TYPE_ITEM_FACTORY);
250 gtk_item_factory_construct (ifactory, container_type, path, accel_group);
256 gtk_item_factory_callback_marshal (GtkWidget *widget,
263 if (data->callback_type == 1)
265 GtkItemFactoryCallback1 func1 = (GtkItemFactoryCallback1) data->func;
266 func1 (data->func_data, data->callback_action, widget);
268 else if (data->callback_type == 2)
270 GtkItemFactoryCallback2 func2 = (GtkItemFactoryCallback2) data->func;
271 func2 (widget, data->func_data, data->callback_action);
276 gtk_item_factory_propagate_accelerator (GtkItemFactoryItem *item,
282 if (item->in_propagation)
285 item->in_propagation = TRUE;
288 for (slist = item->widgets; slist; slist = slist->next)
292 widget = slist->data;
294 if (widget != exclude)
296 gtk_widget_ref (widget);
297 widget_list = g_slist_prepend (widget_list, widget);
301 for (slist = widget_list; slist; slist = slist->next)
304 GtkAccelGroup *accel_group;
307 widget = slist->data;
309 accel_group = gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_accel_group);
311 signal_id = gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget));
312 if (signal_id && accel_group)
314 if (item->accelerator_key)
315 gtk_widget_add_accelerator (widget,
318 item->accelerator_key,
319 item->accelerator_mods,
325 work = gtk_accel_group_entries_from_object (GTK_OBJECT (widget));
328 GtkAccelEntry *ac_entry;
330 ac_entry = work->data;
332 if (ac_entry->accel_flags & GTK_ACCEL_VISIBLE &&
333 ac_entry->accel_group == accel_group &&
334 ac_entry->signal_id == signal_id)
335 gtk_widget_remove_accelerator (GTK_WIDGET (widget),
336 ac_entry->accel_group,
337 ac_entry->accelerator_key,
338 ac_entry->accelerator_mods);
343 gtk_widget_unref (widget);
346 g_slist_free (widget_list);
348 item->in_propagation = FALSE;
352 gtk_item_factory_item_add_accelerator (GtkWidget *widget,
353 guint accel_signal_id,
354 GtkAccelGroup *accel_group,
357 GtkAccelFlags accel_flags,
358 GtkItemFactoryItem *item)
360 if (!item->in_propagation &&
361 g_slist_find (item->widgets, widget) &&
362 accel_signal_id == gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (widget)))
364 item->accelerator_key = accel_key;
365 item->accelerator_mods = accel_mods;
366 item->modified = TRUE;
368 gtk_item_factory_propagate_accelerator (item, widget);
375 gtk_item_factory_item_remove_accelerator (GtkWidget *widget,
376 GtkAccelGroup *accel_group,
379 GtkItemFactoryItem *item)
381 if (!item->in_propagation &&
382 g_slist_find (item->widgets, widget) &&
383 item->accelerator_key == accel_key &&
384 item->accelerator_mods == accel_mods)
386 item->accelerator_key = 0;
387 item->accelerator_mods = 0;
388 item->modified = TRUE;
390 gtk_item_factory_propagate_accelerator (item, widget);
395 gtk_item_factory_item_remove_widget (GtkWidget *widget,
396 GtkItemFactoryItem *item)
398 item->widgets = g_slist_remove (item->widgets, widget);
399 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_factory);
400 gtk_object_remove_data_by_id (GTK_OBJECT (widget), quark_item_path);
404 gtk_item_factory_add_foreign (GtkWidget *accel_widget,
405 const gchar *full_path,
406 GtkAccelGroup *accel_group,
408 GdkModifierType modifiers)
410 GtkItemFactoryClass *class;
411 GtkItemFactoryItem *item;
413 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
414 g_return_if_fail (full_path != NULL);
416 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
418 keyval = keyval != GDK_VoidSymbol ? keyval : 0;
420 item = g_hash_table_lookup (class->item_ht, full_path);
423 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
425 item->path = g_strdup (full_path);
426 item->accelerator_key = keyval;
427 item->accelerator_mods = modifiers;
428 item->modified = FALSE;
429 item->in_propagation = FALSE;
431 item->widgets = NULL;
433 g_hash_table_insert (class->item_ht, item->path, item);
436 item->widgets = g_slist_prepend (item->widgets, accel_widget);
437 gtk_signal_connect (GTK_OBJECT (accel_widget),
439 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_widget),
442 /* set the item path for the widget
444 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_item_path, item->path);
445 gtk_widget_set_name (accel_widget, item->path);
448 gtk_accel_group_ref (accel_group);
449 gtk_object_set_data_by_id_full (GTK_OBJECT (accel_widget),
452 (GtkDestroyNotify) gtk_accel_group_unref);
455 gtk_object_set_data_by_id (GTK_OBJECT (accel_widget), quark_accel_group, NULL);
457 /* install defined accelerators
459 if (gtk_signal_lookup ("activate", GTK_OBJECT_TYPE (accel_widget)))
461 if (item->accelerator_key && accel_group)
462 gtk_widget_add_accelerator (accel_widget,
465 item->accelerator_key,
466 item->accelerator_mods,
469 gtk_widget_remove_accelerators (accel_widget,
474 /* keep track of accelerator changes
476 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
478 GTK_SIGNAL_FUNC (gtk_item_factory_item_add_accelerator),
480 gtk_signal_connect_after (GTK_OBJECT (accel_widget),
481 "remove-accelerator",
482 GTK_SIGNAL_FUNC (gtk_item_factory_item_remove_accelerator),
487 ifactory_cb_data_free (gpointer mem)
489 g_mem_chunk_free (ifactory_cb_data_chunks, mem);
493 gtk_item_factory_add_item (GtkItemFactory *ifactory,
495 const gchar *accelerator,
496 GtkItemFactoryCallback callback,
497 guint callback_action,
498 gpointer callback_data,
503 GtkItemFactoryClass *class;
504 GtkItemFactoryItem *item;
508 g_return_if_fail (widget != NULL);
509 g_return_if_fail (item_type != NULL);
511 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
513 /* set accelerator group on menu widgets
515 if (GTK_IS_MENU (widget))
516 gtk_menu_set_accel_group ((GtkMenu*) widget, ifactory->accel_group);
518 /* connect callback if neccessary
524 data = g_chunk_new (GtkIFCBData, ifactory_cb_data_chunks);
525 data->func = callback;
526 data->callback_type = callback_type;
527 data->func_data = callback_data;
528 data->callback_action = callback_action;
530 gtk_object_weakref (GTK_OBJECT (widget),
531 ifactory_cb_data_free,
533 gtk_signal_connect (GTK_OBJECT (widget),
535 GTK_SIGNAL_FUNC (gtk_item_factory_callback_marshal),
539 /* link the widget into its item-entry
540 * and keep back pointer on both the item factory and the widget
542 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_action, GUINT_TO_POINTER (callback_action));
543 gtk_object_set_data_by_id (GTK_OBJECT (widget), quark_item_factory, ifactory);
545 gtk_accelerator_parse (accelerator, &keyval, &mods);
551 fpath = g_strconcat (ifactory->path, path, NULL);
552 gtk_item_factory_add_foreign (widget, fpath, ifactory->accel_group, keyval, mods);
553 item = g_hash_table_lookup (class->item_ht, fpath);
556 g_return_if_fail (item != NULL);
558 if (!g_slist_find (ifactory->items, item))
559 ifactory->items = g_slist_prepend (ifactory->items, item);
563 gtk_item_factory_construct (GtkItemFactory *ifactory,
564 GtkType container_type,
566 GtkAccelGroup *accel_group)
570 g_return_if_fail (ifactory != NULL);
571 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
572 g_return_if_fail (ifactory->accel_group == NULL);
573 g_return_if_fail (path != NULL);
574 if (!gtk_type_is_a (container_type, GTK_TYPE_OPTION_MENU))
575 g_return_if_fail (gtk_type_is_a (container_type, GTK_TYPE_MENU_SHELL));
579 if (path[0] != '<' && path[len - 1] != '>')
581 g_warning ("GtkItemFactory: invalid factory path `%s'", path);
587 ifactory->accel_group = accel_group;
588 gtk_accel_group_ref (ifactory->accel_group);
591 ifactory->accel_group = gtk_accel_group_new ();
593 ifactory->path = g_strdup (path);
595 gtk_widget_new (container_type,
596 "GtkObject::signal::destroy", gtk_widget_destroyed, &ifactory->widget,
598 gtk_object_ref (GTK_OBJECT (ifactory));
599 gtk_object_sink (GTK_OBJECT (ifactory));
601 gtk_item_factory_add_item (ifactory,
609 gtk_item_factory_from_path (const gchar *path)
611 GtkItemFactoryClass *class;
612 GtkItemFactoryItem *item;
616 g_return_val_if_fail (path != NULL, NULL);
617 g_return_val_if_fail (path[0] == '<', NULL);
619 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
622 while (path[i] && path[i] != '>')
626 g_warning ("gtk_item_factory_from_path(): invalid factory path \"%s\"",
630 fname = g_new (gchar, i + 2);
631 g_memmove (fname, path, i + 1);
634 item = g_hash_table_lookup (class->item_ht, fname);
638 if (item && item->widgets)
639 return gtk_item_factory_from_widget (item->widgets->data);
645 gtk_item_factory_destroy (GtkObject *object)
647 GtkItemFactory *ifactory;
650 g_return_if_fail (object != NULL);
651 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
653 ifactory = (GtkItemFactory*) object;
655 if (ifactory->widget)
659 dobj = GTK_OBJECT (ifactory->widget);
661 gtk_object_ref (dobj);
662 gtk_object_sink (dobj);
663 gtk_object_destroy (dobj);
664 gtk_object_unref (dobj);
666 ifactory->widget = NULL;
669 for (slist = ifactory->items; slist; slist = slist->next)
671 GtkItemFactoryItem *item = slist->data;
674 for (link = item->widgets; link; link = link->next)
675 if (gtk_object_get_data_by_id (link->data, quark_item_factory))
676 gtk_object_remove_data_by_id (link->data, quark_item_factory);
678 g_slist_free (ifactory->items);
679 ifactory->items = NULL;
681 parent_class->destroy (object);
685 gtk_item_factory_finalize (GtkObject *object)
687 GtkItemFactory *ifactory;
689 g_return_if_fail (object != NULL);
690 g_return_if_fail (GTK_IS_ITEM_FACTORY (object));
692 ifactory = GTK_ITEM_FACTORY (object);
694 gtk_accel_group_unref (ifactory->accel_group);
695 g_free (ifactory->path);
696 g_assert (ifactory->widget == NULL);
698 if (ifactory->translate_data && ifactory->translate_notify)
699 ifactory->translate_notify (ifactory->translate_data);
701 parent_class->finalize (object);
705 gtk_item_factory_from_widget (GtkWidget *widget)
707 g_return_val_if_fail (widget != NULL, NULL);
708 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
710 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_factory);
714 gtk_item_factory_path_from_widget (GtkWidget *widget)
716 g_return_val_if_fail (widget != NULL, NULL);
717 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
719 return gtk_object_get_data_by_id (GTK_OBJECT (widget), quark_item_path);
723 gtk_item_factory_foreach (gpointer hash_key,
727 GtkItemFactoryItem *item;
731 gchar comment_prefix[2] = "\000\000";
736 if (data->pspec && !gtk_pattern_match_string (data->pspec, item->path))
739 comment_prefix[0] = gtk_item_factory_class->cpair_comment_single[0];
741 name = gtk_accelerator_name (item->accelerator_key, item->accelerator_mods);
742 string = g_strconcat (item->modified ? "" : comment_prefix,
751 data->print_func (data->func_data, string);
757 gtk_item_factory_dump_items (GtkPatternSpec *path_pspec,
758 gboolean modified_only,
759 GtkPrintFunc print_func,
764 g_return_if_fail (print_func != NULL);
766 if (!gtk_item_factory_class)
767 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
769 data.print_func = print_func;
770 data.func_data = func_data;
771 data.modified_only = (modified_only != FALSE);
772 data.pspec = path_pspec;
774 g_hash_table_foreach (gtk_item_factory_class->item_ht, gtk_item_factory_foreach, &data);
778 gtk_item_factory_print_func (gpointer FILE_pointer,
781 FILE *f_out = FILE_pointer;
783 g_return_if_fail (FILE_pointer != NULL);
784 g_return_if_fail (string != NULL);
786 fputs (string, f_out);
791 gtk_item_factory_dump_rc (const gchar *file_name,
792 GtkPatternSpec *path_pspec,
793 gboolean modified_only)
797 g_return_if_fail (file_name != NULL);
799 f_out = fopen (file_name, "w");
804 if (g_get_prgname ())
805 fputs (g_get_prgname (), f_out);
806 fputs (" GtkItemFactory rc-file -*- scheme -*-\n", f_out);
807 fputs ("; this file is an automated menu-path dump\n", f_out);
808 fputs (";\n", f_out);
810 gtk_item_factory_dump_items (path_pspec,
812 gtk_item_factory_print_func,
819 gtk_item_factory_create_items (GtkItemFactory *ifactory,
821 GtkItemFactoryEntry *entries,
822 gpointer callback_data)
824 gtk_item_factory_create_items_ac (ifactory, n_entries, entries, callback_data, 1);
828 gtk_item_factory_create_items_ac (GtkItemFactory *ifactory,
830 GtkItemFactoryEntry *entries,
831 gpointer callback_data,
836 g_return_if_fail (ifactory != NULL);
837 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
838 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
843 g_return_if_fail (entries != NULL);
845 for (i = 0; i < n_entries; i++)
846 gtk_item_factory_create_item (ifactory, entries + i, callback_data, callback_type);
850 gtk_item_factory_get_widget (GtkItemFactory *ifactory,
853 GtkItemFactoryClass *class;
854 GtkItemFactoryItem *item;
856 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
857 g_return_val_if_fail (path != NULL, NULL);
859 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
862 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
867 fpath = g_strconcat (ifactory->path, path, NULL);
868 item = g_hash_table_lookup (class->item_ht, fpath);
876 for (slist = item->widgets; slist; slist = slist->next)
878 if (gtk_item_factory_from_widget (slist->data) == ifactory)
887 gtk_item_factory_get_widget_by_action (GtkItemFactory *ifactory,
892 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
894 for (slist = ifactory->items; slist; slist = slist->next)
896 GtkItemFactoryItem *item = slist->data;
899 for (link = item->widgets; link; link = link->next)
900 if (gtk_object_get_data_by_id (link->data, quark_item_factory) == ifactory &&
901 gtk_object_get_data_by_id (link->data, quark_action) == GUINT_TO_POINTER (action))
909 gtk_item_factory_get_item (GtkItemFactory *ifactory,
914 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
915 g_return_val_if_fail (path != NULL, NULL);
917 widget = gtk_item_factory_get_widget (ifactory, path);
919 if (GTK_IS_MENU (widget))
920 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
922 return GTK_IS_ITEM (widget) ? widget : NULL;
926 gtk_item_factory_get_item_by_action (GtkItemFactory *ifactory,
931 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
933 widget = gtk_item_factory_get_widget_by_action (ifactory, action);
935 if (GTK_IS_MENU (widget))
936 widget = gtk_menu_get_attach_widget (GTK_MENU (widget));
938 return GTK_IS_ITEM (widget) ? widget : NULL;
942 gtk_item_factory_parse_path (GtkItemFactory *ifactory,
951 *path = g_strdup (str);
964 *parent_path = g_strdup (*path);
965 p = strrchr (*parent_path, '/');
968 g_warning ("GtkItemFactory: invalid entry path `%s'", str);
973 if (ifactory->translate_func)
974 translation = ifactory->translate_func (str, ifactory->translate_data);
978 p = strrchr (translation, '/');
981 *item = g_strdup (p);
987 gtk_item_factory_create_item (GtkItemFactory *ifactory,
988 GtkItemFactoryEntry *entry,
989 gpointer callback_data,
1001 gchar *item_type_path;
1003 g_return_if_fail (ifactory != NULL);
1004 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1005 g_return_if_fail (entry != NULL);
1006 g_return_if_fail (entry->path != NULL);
1007 g_return_if_fail (entry->path[0] == '/');
1008 g_return_if_fail (callback_type >= 1 && callback_type <= 2);
1010 if (!entry->item_type ||
1011 entry->item_type[0] == 0)
1013 item_type_path = "<Item>";
1014 type_id = quark_type_item;
1018 item_type_path = entry->item_type;
1019 type_id = gtk_object_data_try_key (item_type_path);
1023 if (type_id == quark_type_item)
1024 type = GTK_TYPE_MENU_ITEM;
1025 else if (type_id == quark_type_title)
1026 type = GTK_TYPE_MENU_ITEM;
1027 else if (type_id == quark_type_radio_item)
1028 type = GTK_TYPE_RADIO_MENU_ITEM;
1029 else if (type_id == quark_type_check_item)
1030 type = GTK_TYPE_CHECK_MENU_ITEM;
1031 else if (type_id == quark_type_tearoff_item)
1032 type = GTK_TYPE_TEAROFF_MENU_ITEM;
1033 else if (type_id == quark_type_toggle_item)
1034 type = GTK_TYPE_CHECK_MENU_ITEM;
1035 else if (type_id == quark_type_separator_item)
1036 type = GTK_TYPE_MENU_ITEM;
1037 else if (type_id == quark_type_branch)
1038 type = GTK_TYPE_MENU_ITEM;
1039 else if (type_id == quark_type_last_branch)
1040 type = GTK_TYPE_MENU_ITEM;
1043 GtkWidget *radio_link;
1045 radio_link = gtk_item_factory_get_widget (ifactory, item_type_path);
1046 if (radio_link && GTK_IS_RADIO_MENU_ITEM (radio_link))
1048 type = GTK_TYPE_RADIO_MENU_ITEM;
1049 radio_group = gtk_radio_menu_item_group (GTK_RADIO_MENU_ITEM (radio_link));
1053 g_warning ("GtkItemFactory: entry path `%s' has invalid type `%s'",
1060 if (!gtk_item_factory_parse_path (ifactory, entry->path,
1061 &path, &parent_path, &name))
1064 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1067 GtkItemFactoryEntry pentry;
1070 ppath = g_strdup (entry->path);
1071 p = strrchr (ppath, '/');
1072 g_return_if_fail (p != NULL);
1074 pentry.path = ppath;
1075 pentry.accelerator = NULL;
1076 pentry.callback = NULL;
1077 pentry.callback_action = 0;
1078 pentry.item_type = "<Branch>";
1080 gtk_item_factory_create_item (ifactory, &pentry, NULL, 1);
1083 parent = gtk_item_factory_get_widget (ifactory, parent_path);
1084 g_return_if_fail (parent != NULL);
1086 g_free (parent_path);
1088 g_return_if_fail (GTK_IS_CONTAINER (parent));
1090 widget = gtk_widget_new (type,
1091 "GtkWidget::visible", TRUE,
1092 "GtkWidget::sensitive", (type_id != quark_type_separator_item &&
1093 type_id != quark_type_title),
1094 "GtkWidget::parent", parent,
1097 if (type == GTK_TYPE_RADIO_MENU_ITEM)
1098 gtk_radio_menu_item_set_group (GTK_RADIO_MENU_ITEM (widget), radio_group);
1099 if (GTK_IS_CHECK_MENU_ITEM (widget))
1100 gtk_check_menu_item_set_show_toggle (GTK_CHECK_MENU_ITEM (widget), TRUE);
1102 /* install underline accelerators for this item
1104 if (type_id != quark_type_separator_item &&
1105 type_id != quark_type_tearoff_item &&
1110 label = gtk_widget_new (GTK_TYPE_ACCEL_LABEL,
1111 "GtkWidget::visible", TRUE,
1112 "GtkWidget::parent", widget,
1113 "GtkAccelLabel::accel_widget", widget,
1114 "GtkMisc::xalign", 0.0,
1117 accel_key = gtk_label_parse_uline (GTK_LABEL (label), name);
1119 if (accel_key != GDK_VoidSymbol)
1121 if (GTK_IS_MENU_BAR (parent))
1122 gtk_widget_add_accelerator (widget,
1124 ifactory->accel_group,
1125 accel_key, GDK_MOD1_MASK,
1128 if (GTK_IS_MENU (parent))
1129 gtk_widget_add_accelerator (widget,
1131 gtk_menu_ensure_uline_accel_group (GTK_MENU (parent)),
1139 if (type_id == quark_type_branch ||
1140 type_id == quark_type_last_branch)
1142 if (entry->callback)
1143 g_warning ("gtk_item_factory_create_item(): Can't specify a callback on a branch: \"%s\"",
1146 if (type_id == quark_type_last_branch)
1147 gtk_menu_item_right_justify (GTK_MENU_ITEM (widget));
1150 widget = gtk_widget_new (GTK_TYPE_MENU,
1153 gtk_menu_item_set_submenu (GTK_MENU_ITEM (parent), widget);
1156 gtk_item_factory_add_item (ifactory,
1157 path, entry->accelerator,
1158 (type_id == quark_type_branch ||
1159 type_id == quark_type_last_branch) ?
1160 (GtkItemFactoryCallback) NULL : entry->callback,
1161 entry->callback_action, callback_data,
1170 gtk_item_factory_create_menu_entries (guint n_entries,
1171 GtkMenuEntry *entries)
1173 static GtkPatternSpec pspec_separator = { 42, 0 };
1174 static GtkPatternSpec pspec_check = { 42, 0 };
1179 g_return_if_fail (entries != NULL);
1181 if (pspec_separator.pattern_length == 0)
1183 gtk_pattern_spec_init (&pspec_separator, "*<separator>*");
1184 gtk_pattern_spec_init (&pspec_check, "*<check>*");
1187 for (i = 0; i < n_entries; i++)
1189 GtkItemFactory *ifactory;
1190 GtkItemFactoryEntry entry;
1194 path = entries[i].path;
1195 ifactory = gtk_item_factory_from_path (path);
1198 g_warning ("gtk_item_factory_create_menu_entries(): "
1199 "entry[%u] refers to unknown item factory: \"%s\"",
1200 i, entries[i].path);
1204 while (*path != '>')
1210 entry.accelerator = entries[i].accelerator;
1211 entry.callback = entries[i].callback;
1212 entry.callback_action = 0;
1213 if (gtk_pattern_match_string (&pspec_separator, path))
1214 entry.item_type = "<Separator>";
1215 else if (!gtk_pattern_match_string (&pspec_check, path))
1216 entry.item_type = NULL;
1219 gboolean in_brace = FALSE;
1222 cpath = g_new (gchar, strlen (path));
1228 else if (*path == '>')
1235 entry.item_type = "<ToggleItem>";
1239 gtk_item_factory_create_item (ifactory, &entry, entries[i].callback_data, 2);
1240 entries[i].widget = gtk_item_factory_get_widget (ifactory, entries[i].path);
1246 gtk_item_factories_path_delete (const gchar *ifactory_path,
1249 GtkItemFactoryClass *class;
1250 GtkItemFactoryItem *item;
1252 g_return_if_fail (path != NULL);
1254 class = gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1257 item = g_hash_table_lookup (class->item_ht, (gpointer) path);
1262 g_return_if_fail (ifactory_path != NULL);
1264 fpath = g_strconcat (ifactory_path, path, NULL);
1265 item = g_hash_table_lookup (class->item_ht, fpath);
1271 GSList *widget_list;
1275 for (slist = item->widgets; slist; slist = slist->next)
1279 widget = slist->data;
1280 widget_list = g_slist_prepend (widget_list, widget);
1281 gtk_widget_ref (widget);
1284 for (slist = widget_list; slist; slist = slist->next)
1288 widget = slist->data;
1289 gtk_widget_destroy (widget);
1290 gtk_widget_unref (widget);
1292 g_slist_free (widget_list);
1297 gtk_item_factory_delete_item (GtkItemFactory *ifactory,
1300 GtkItemFactoryClass *class;
1301 GtkItemFactoryItem *item;
1304 g_return_if_fail (ifactory != NULL);
1305 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1306 g_return_if_fail (path != NULL);
1308 class = GTK_ITEM_FACTORY_CLASS (GTK_OBJECT (ifactory)->klass);
1310 fpath = g_strconcat (ifactory->path, path, NULL);
1311 item = g_hash_table_lookup (class->item_ht, fpath);
1316 GtkWidget *widget = NULL;
1319 for (slist = item->widgets; slist; slist = slist->next)
1321 widget = slist->data;
1323 if (gtk_item_factory_from_widget (widget) == ifactory)
1328 gtk_widget_destroy (widget);
1333 gtk_item_factory_delete_entry (GtkItemFactory *ifactory,
1334 GtkItemFactoryEntry *entry)
1336 g_return_if_fail (ifactory != NULL);
1337 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1338 g_return_if_fail (entry != NULL);
1340 gtk_item_factory_delete_item (ifactory, entry->path);
1344 gtk_item_factory_delete_entries (GtkItemFactory *ifactory,
1346 GtkItemFactoryEntry *entries)
1350 g_return_if_fail (ifactory != NULL);
1351 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1353 g_return_if_fail (entries != NULL);
1355 for (i = 0; i < n_entries; i++)
1356 gtk_item_factory_delete_item (ifactory, (entries + i)->path);
1366 gtk_item_factory_menu_pos (GtkMenu *menu,
1371 MenuPos *mpos = func_data;
1378 gtk_item_factory_popup_data_from_widget (GtkWidget *widget)
1380 GtkItemFactory *ifactory;
1382 g_return_val_if_fail (widget != NULL, NULL);
1383 g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
1385 ifactory = gtk_item_factory_from_widget (widget);
1387 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1393 gtk_item_factory_popup_data (GtkItemFactory *ifactory)
1395 g_return_val_if_fail (ifactory != NULL, NULL);
1396 g_return_val_if_fail (GTK_IS_ITEM_FACTORY (ifactory), NULL);
1398 return gtk_object_get_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1402 ifactory_delete_popup_data (GtkObject *object,
1403 GtkItemFactory *ifactory)
1405 gtk_signal_disconnect_by_func (object,
1406 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1408 gtk_object_remove_data_by_id (GTK_OBJECT (ifactory), quark_popup_data);
1412 gtk_item_factory_popup (GtkItemFactory *ifactory,
1418 gtk_item_factory_popup_with_data (ifactory, NULL, NULL, x, y, mouse_button, time);
1422 gtk_item_factory_popup_with_data (GtkItemFactory *ifactory,
1423 gpointer popup_data,
1424 GtkDestroyNotify destroy,
1430 g_return_if_fail (ifactory != NULL);
1431 g_return_if_fail (GTK_IS_ITEM_FACTORY (ifactory));
1432 g_return_if_fail (GTK_IS_MENU (ifactory->widget));
1434 if (!GTK_WIDGET_VISIBLE (ifactory->widget))
1438 mpos = gtk_object_get_data_by_id (GTK_OBJECT (ifactory->widget), quark_if_menu_pos);
1442 mpos = g_new0 (MenuPos, 1);
1443 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory->widget),
1452 if (popup_data != NULL)
1454 gtk_object_set_data_by_id_full (GTK_OBJECT (ifactory),
1458 gtk_signal_connect (GTK_OBJECT (ifactory->widget),
1460 GTK_SIGNAL_FUNC (ifactory_delete_popup_data),
1464 gtk_menu_popup (GTK_MENU (ifactory->widget),
1466 gtk_item_factory_menu_pos, mpos,
1467 mouse_button, time);
1472 gtk_item_factory_parse_menu_path (GScanner *scanner,
1473 GtkItemFactoryClass *class)
1475 GtkItemFactoryItem *item;
1477 g_scanner_get_next_token (scanner);
1478 if (scanner->token != G_TOKEN_STRING)
1479 return G_TOKEN_STRING;
1481 g_scanner_peek_next_token (scanner);
1482 if (scanner->next_token != G_TOKEN_STRING)
1484 g_scanner_get_next_token (scanner);
1485 return G_TOKEN_STRING;
1488 item = g_hash_table_lookup (class->item_ht, scanner->value.v_string);
1491 item = g_chunk_new (GtkItemFactoryItem, ifactory_item_chunks);
1493 item->path = g_strdup (scanner->value.v_string);
1494 item->accelerator_key = 0;
1495 item->accelerator_mods = 0;
1496 item->modified = TRUE;
1497 item->in_propagation = FALSE;
1499 item->widgets = NULL;
1501 g_hash_table_insert (class->item_ht, item->path, item);
1503 g_scanner_get_next_token (scanner);
1505 if (!item->in_propagation)
1510 old_keyval = item->accelerator_key;
1511 old_mods = item->accelerator_mods;
1512 gtk_accelerator_parse (scanner->value.v_string,
1513 &item->accelerator_key,
1514 &item->accelerator_mods);
1515 if (old_keyval != item->accelerator_key ||
1516 old_mods != item->accelerator_mods)
1518 item->modified = TRUE;
1519 gtk_item_factory_propagate_accelerator (item, NULL);
1523 g_scanner_get_next_token (scanner);
1524 if (scanner->token != ')')
1527 return G_TOKEN_NONE;
1531 gtk_item_factory_parse_statement (GScanner *scanner,
1532 GtkItemFactoryClass *class)
1534 guint expected_token;
1536 g_scanner_get_next_token (scanner);
1538 if (scanner->token == G_TOKEN_SYMBOL)
1540 guint (*parser_func) (GScanner*, GtkItemFactoryClass*);
1542 parser_func = scanner->value.v_symbol;
1544 /* check whether this is a GtkItemFactory symbol.
1546 if (parser_func == gtk_item_factory_parse_menu_path)
1547 expected_token = parser_func (scanner, class);
1549 expected_token = G_TOKEN_SYMBOL;
1552 expected_token = G_TOKEN_SYMBOL;
1554 /* skip rest of statement on errrors
1556 if (expected_token != G_TOKEN_NONE)
1558 register guint level;
1561 if (scanner->token == ')')
1563 if (scanner->token == '(')
1566 while (!g_scanner_eof (scanner) && level > 0)
1568 g_scanner_get_next_token (scanner);
1570 if (scanner->token == '(')
1572 else if (scanner->token == ')')
1579 gtk_item_factory_parse_rc_string (const gchar *rc_string)
1583 g_return_if_fail (rc_string != NULL);
1585 if (!gtk_item_factory_class)
1586 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1588 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1589 scanner = g_scanner_new (&ifactory_scanner_config);
1591 g_scanner_input_text (scanner, rc_string, strlen (rc_string));
1593 gtk_item_factory_parse_rc_scanner (scanner);
1595 g_scanner_destroy (scanner);
1599 gtk_item_factory_parse_rc_scanner (GScanner *scanner)
1601 gpointer saved_symbol;
1603 g_return_if_fail (scanner != NULL);
1605 if (!gtk_item_factory_class)
1606 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1608 saved_symbol = g_scanner_lookup_symbol (scanner, "menu-path");
1609 g_scanner_remove_symbol (scanner, "menu-path");
1610 g_scanner_add_symbol (scanner, "menu-path", gtk_item_factory_parse_menu_path);
1612 g_scanner_peek_next_token (scanner);
1614 while (scanner->next_token == '(')
1616 g_scanner_get_next_token (scanner);
1618 gtk_item_factory_parse_statement (scanner, gtk_item_factory_class);
1620 g_scanner_peek_next_token (scanner);
1623 g_scanner_remove_symbol (scanner, "menu-path");
1624 g_scanner_add_symbol (scanner, "menu-path", saved_symbol);
1628 gtk_item_factory_parse_rc (const gchar *file_name)
1633 g_return_if_fail (file_name != NULL);
1635 if (!S_ISREG (g_scanner_stat_mode (file_name)))
1639 fd = open (file_name, O_RDONLY);
1641 fd = open (file_name, O_RDONLY | O_TEXT);
1646 if (!gtk_item_factory_class)
1647 gtk_type_class (GTK_TYPE_ITEM_FACTORY);
1649 ifactory_scanner_config.cpair_comment_single = gtk_item_factory_class->cpair_comment_single;
1650 scanner = g_scanner_new (&ifactory_scanner_config);
1652 g_scanner_input_file (scanner, fd);
1654 gtk_item_factory_parse_rc_scanner (scanner);
1656 g_scanner_destroy (scanner);
1662 gtk_item_factory_set_translate_func (GtkItemFactory *ifactory,
1663 GtkTranslateFunc func,
1665 GtkDestroyNotify notify)
1667 g_return_if_fail (ifactory != NULL);
1669 if (ifactory->translate_data && ifactory->translate_notify)
1670 ifactory->translate_notify (ifactory->translate_data);
1672 ifactory->translate_func = func;
1673 ifactory->translate_data = data;
1674 ifactory->translate_notify = notify;