1 /* GTK+ Integration for the Mac OS X Menubar.
3 * Copyright (C) 2007 Pioneer Research Center USA, Inc.
4 * Copyright (C) 2007 Imendio AB
6 * For further information, see:
7 * http://developer.imendio.com/projects/gtk-macosx/menubar
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; version 2.1
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
26 #include <gdk/gdkkeysyms.h>
28 #include <Carbon/Carbon.h>
30 #include <gtkmm2ext/sync-menu.h>
35 * - Sync adding/removing/reordering items
36 * - Create on demand? (can this be done with gtk+? ie fill in menu
37 items when the menu is opened)
38 * - Figure out what to do per app/window...
42 #define IGE_QUARTZ_MENU_CREATOR 'IGEC'
43 #define IGE_QUARTZ_ITEM_WIDGET 'IWID'
46 static void sync_menu_shell (GtkMenuShell *menu_shell,
57 find_menu_label (GtkWidget *widget)
59 GtkWidget *label = NULL;
61 if (GTK_IS_LABEL (widget))
64 if (GTK_IS_CONTAINER (widget))
69 children = gtk_container_get_children (GTK_CONTAINER (widget));
71 for (l = children; l; l = l->next)
73 label = find_menu_label (l->data);
78 g_list_free (children);
85 get_menu_label_text (GtkWidget *menu_item,
90 my_label = find_menu_label (menu_item);
95 return gtk_label_get_text (GTK_LABEL (my_label));
101 accel_find_func (GtkAccelKey *key,
105 return (GClosure *) data == closure;
110 * CarbonMenu functions
118 static GQuark carbon_menu_quark = 0;
121 carbon_menu_new (void)
123 return g_slice_new0 (CarbonMenu);
127 carbon_menu_free (CarbonMenu *menu)
129 g_slice_free (CarbonMenu, menu);
133 carbon_menu_get (GtkWidget *widget)
135 return g_object_get_qdata (G_OBJECT (widget), carbon_menu_quark);
139 carbon_menu_connect (GtkWidget *menu,
142 CarbonMenu *carbon_menu = carbon_menu_get (menu);
146 carbon_menu = carbon_menu_new ();
148 g_object_set_qdata_full (G_OBJECT (menu), carbon_menu_quark,
150 (GDestroyNotify) carbon_menu_free);
153 carbon_menu->menu = menuRef;
158 * CarbonMenuItem functions
166 GClosure *accel_closure;
169 static GQuark carbon_menu_item_quark = 0;
171 static CarbonMenuItem *
172 carbon_menu_item_new (void)
174 return g_slice_new0 (CarbonMenuItem);
178 carbon_menu_item_free (CarbonMenuItem *menu_item)
180 if (menu_item->accel_closure)
181 g_closure_unref (menu_item->accel_closure);
183 g_slice_free (CarbonMenuItem, menu_item);
186 static CarbonMenuItem *
187 carbon_menu_item_get (GtkWidget *widget)
189 return g_object_get_qdata (G_OBJECT (widget), carbon_menu_item_quark);
193 carbon_menu_item_update_state (CarbonMenuItem *carbon_item,
198 UInt32 set_attrs = 0;
199 UInt32 clear_attrs = 0;
201 g_object_get (widget,
202 "sensitive", &sensitive,
207 set_attrs |= kMenuItemAttrDisabled;
209 clear_attrs |= kMenuItemAttrDisabled;
212 set_attrs |= kMenuItemAttrHidden;
214 clear_attrs |= kMenuItemAttrHidden;
216 ChangeMenuItemAttributes (carbon_item->menu, carbon_item->index,
217 set_attrs, clear_attrs);
221 carbon_menu_item_update_active (CarbonMenuItem *carbon_item,
226 g_object_get (widget,
230 CheckMenuItem (carbon_item->menu, carbon_item->index,
235 carbon_menu_item_update_submenu (CarbonMenuItem *carbon_item,
240 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
244 const gchar *label_text;
245 CFStringRef cfstr = NULL;
247 label_text = get_menu_label_text (widget, NULL);
249 cfstr = CFStringCreateWithCString (NULL, label_text,
250 kCFStringEncodingUTF8);
252 CreateNewMenu (0, 0, &carbon_item->submenu);
253 SetMenuTitleWithCFString (carbon_item->submenu, cfstr);
254 SetMenuItemHierarchicalMenu (carbon_item->menu, carbon_item->index,
255 carbon_item->submenu);
257 sync_menu_shell (GTK_MENU_SHELL (submenu), carbon_item->submenu, FALSE, FALSE);
264 SetMenuItemHierarchicalMenu (carbon_item->menu, carbon_item->index,
266 carbon_item->submenu = NULL;
271 carbon_menu_item_update_label (CarbonMenuItem *carbon_item,
274 const gchar *label_text;
275 CFStringRef cfstr = NULL;
277 label_text = get_menu_label_text (widget, NULL);
279 cfstr = CFStringCreateWithCString (NULL, label_text,
280 kCFStringEncodingUTF8);
282 SetMenuItemTextWithCFString (carbon_item->menu, carbon_item->index,
290 carbon_menu_item_update_accelerator (CarbonMenuItem *carbon_item,
295 get_menu_label_text (widget, &label);
297 if (GTK_IS_ACCEL_LABEL (label) &&
298 GTK_ACCEL_LABEL (label)->accel_closure)
302 key = gtk_accel_group_find (GTK_ACCEL_LABEL (label)->accel_group,
304 GTK_ACCEL_LABEL (label)->accel_closure);
308 key->accel_flags & GTK_ACCEL_VISIBLE)
310 GdkDisplay *display = gtk_widget_get_display (widget);
311 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
315 gboolean add_modifiers = FALSE;
316 UInt8 modifiers = 0; /* implies Command key */
318 if (gdk_keymap_get_entries_for_keyval (keymap, key->accel_key,
319 &keys, &n_keys) == 0)
323 switch (key->accel_key) {
326 realkey = kRightArrowCharCode;
330 realkey = kLeftArrowCharCode;
334 realkey = kUpArrowCharCode;
338 realkey = kDownArrowCharCode;
345 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
347 add_modifiers = TRUE;
352 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index, true, keys[0].keycode);
353 if (keys[0].level == 1)
355 /* regular key, but it needs shift to make it work */
356 modifiers |= kMenuShiftModifier;
360 add_modifiers = TRUE;
369 if (key->accel_mods & GDK_SHIFT_MASK) {
370 modifiers |= kMenuShiftModifier;
373 /* gdk/quartz maps Alt/Option to Mod1 */
375 if (key->accel_mods & (GDK_MOD1_MASK)) {
376 modifiers |= kMenuOptionModifier;
379 if (key->accel_mods & GDK_CONTROL_MASK) {
380 modifiers |= kMenuControlModifier;
383 /* gdk/quartz maps Command to Meta */
385 if (key->accel_mods & GDK_META_MASK) {
391 modifiers |= kMenuNoCommandModifier;
393 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
400 /* otherwise, clear the menu shortcut */
401 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
402 kMenuNoModifiers | kMenuNoCommandModifier);
403 ChangeMenuItemAttributes (carbon_item->menu, carbon_item->index,
404 0, kMenuItemAttrUseVirtualKey);
405 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
410 carbon_menu_item_accel_changed (GtkAccelGroup *accel_group,
412 GdkModifierType modifier,
413 GClosure *accel_closure,
416 CarbonMenuItem *carbon_item = carbon_menu_item_get (widget);
419 get_menu_label_text (widget, &label);
421 if (GTK_IS_ACCEL_LABEL (label) &&
422 GTK_ACCEL_LABEL (label)->accel_closure == accel_closure)
423 carbon_menu_item_update_accelerator (carbon_item, widget);
427 carbon_menu_item_update_accel_closure (CarbonMenuItem *carbon_item,
430 GtkAccelGroup *group;
433 get_menu_label_text (widget, &label);
435 if (carbon_item->accel_closure)
437 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
439 g_signal_handlers_disconnect_by_func (group,
440 carbon_menu_item_accel_changed,
443 g_closure_unref (carbon_item->accel_closure);
444 carbon_item->accel_closure = NULL;
447 if (GTK_IS_ACCEL_LABEL (label))
448 carbon_item->accel_closure = GTK_ACCEL_LABEL (label)->accel_closure;
450 if (carbon_item->accel_closure)
452 g_closure_ref (carbon_item->accel_closure);
454 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
456 g_signal_connect_object (group, "accel-changed",
457 G_CALLBACK (carbon_menu_item_accel_changed),
461 carbon_menu_item_update_accelerator (carbon_item, widget);
465 carbon_menu_item_notify (GObject *object,
467 CarbonMenuItem *carbon_item)
469 if (!strcmp (pspec->name, "sensitive") ||
470 !strcmp (pspec->name, "visible"))
472 carbon_menu_item_update_state (carbon_item, GTK_WIDGET (object));
474 else if (!strcmp (pspec->name, "active"))
476 carbon_menu_item_update_active (carbon_item, GTK_WIDGET (object));
478 else if (!strcmp (pspec->name, "submenu"))
480 carbon_menu_item_update_submenu (carbon_item, GTK_WIDGET (object));
485 carbon_menu_item_notify_label (GObject *object,
489 CarbonMenuItem *carbon_item = carbon_menu_item_get (GTK_WIDGET (object));
491 if (!strcmp (pspec->name, "label"))
493 carbon_menu_item_update_label (carbon_item,
494 GTK_WIDGET (object));
496 else if (!strcmp (pspec->name, "accel-closure"))
498 carbon_menu_item_update_accel_closure (carbon_item,
499 GTK_WIDGET (object));
503 static CarbonMenuItem *
504 carbon_menu_item_connect (GtkWidget *menu_item,
509 CarbonMenuItem *carbon_item = carbon_menu_item_get (menu_item);
513 carbon_item = carbon_menu_item_new ();
515 g_object_set_qdata_full (G_OBJECT (menu_item), carbon_menu_item_quark,
517 (GDestroyNotify) carbon_menu_item_free);
519 g_signal_connect (menu_item, "notify",
520 G_CALLBACK (carbon_menu_item_notify),
524 g_signal_connect_swapped (label, "notify::label",
525 G_CALLBACK (carbon_menu_item_notify_label),
529 carbon_item->menu = menu;
530 carbon_item->index = index;
537 * carbon event handler
540 static int _in_carbon_menu_event_handler = 0;
543 gdk_quartz_in_carbon_menu_event_handler ()
545 return _in_carbon_menu_event_handler;
549 dummy_gtk_menu_item_activate (gpointer *arg)
551 gtk_menu_item_activate (GTK_MENU_ITEM(arg));
556 menu_event_handler_func (EventHandlerCallRef event_handler_call_ref,
560 UInt32 event_class = GetEventClass (event_ref);
561 UInt32 event_kind = GetEventKind (event_ref);
565 _in_carbon_menu_event_handler = 1;
569 case kEventClassCommand:
570 /* This is called when activating (is that the right GTK+ term?)
573 if (event_kind == kEventCommandProcess)
578 /*g_printerr ("Menu: kEventClassCommand/kEventCommandProcess\n");*/
580 err = GetEventParameter (event_ref, kEventParamDirectObject,
582 sizeof (command), 0, &command);
586 GtkWidget *widget = NULL;
588 /* Get any GtkWidget associated with the item. */
589 err = GetMenuItemProperty (command.menu.menuRef,
590 command.menu.menuItemIndex,
591 IGE_QUARTZ_MENU_CREATOR,
592 IGE_QUARTZ_ITEM_WIDGET,
593 sizeof (widget), 0, &widget);
594 if (err == noErr && GTK_IS_WIDGET (widget))
596 g_idle_add ((GSourceFunc) dummy_gtk_menu_item_activate, widget);
597 // gtk_menu_item_activate (GTK_MENU_ITEM (widget));
598 _in_carbon_menu_event_handler = 0;
605 case kEventClassMenu:
606 GetEventParameter (event_ref,
607 kEventParamDirectObject,
616 case kEventMenuTargetItem:
617 /* This is called when an item is selected (what is the
618 * GTK+ term? prelight?)
620 /*g_printerr ("kEventClassMenu/kEventMenuTargetItem\n");*/
623 case kEventMenuOpening:
624 /* Is it possible to dynamically build the menu here? We
625 * can at least set visibility/sensitivity.
627 /*g_printerr ("kEventClassMenu/kEventMenuOpening\n");*/
630 case kEventMenuClosed:
631 /*g_printerr ("kEventClassMenu/kEventMenuClosed\n");*/
644 ret = CallNextEventHandler (event_handler_call_ref, event_ref);
645 _in_carbon_menu_event_handler = 0;
650 setup_menu_event_handler (void)
652 EventHandlerUPP menu_event_handler_upp;
653 EventHandlerRef menu_event_handler_ref;
654 const EventTypeSpec menu_events[] = {
655 { kEventClassCommand, kEventCommandProcess },
656 { kEventClassMenu, kEventMenuTargetItem },
657 { kEventClassMenu, kEventMenuOpening },
658 { kEventClassMenu, kEventMenuClosed }
661 /* FIXME: We might have to install one per window? */
663 menu_event_handler_upp = NewEventHandlerUPP (menu_event_handler_func);
664 InstallEventHandler (GetApplicationEventTarget (), menu_event_handler_upp,
665 GetEventTypeCount (menu_events), menu_events, 0,
666 &menu_event_handler_ref);
669 /* FIXME: Remove the handler with: */
670 RemoveEventHandler(menu_event_handler_ref);
671 DisposeEventHandlerUPP(menu_event_handler_upp);
676 sync_menu_shell (GtkMenuShell *menu_shell,
683 MenuItemIndex carbon_index = 1;
686 g_printerr ("%s: syncing shell %p\n", G_STRFUNC, menu_shell);
688 carbon_menu_connect (GTK_WIDGET (menu_shell), carbon_menu);
690 children = gtk_container_get_children (GTK_CONTAINER (menu_shell));
692 for (l = children; l; l = l->next)
694 GtkWidget *menu_item = l->data;
695 CarbonMenuItem *carbon_item;
697 if (GTK_IS_TEAROFF_MENU_ITEM (menu_item))
700 if (toplevel && g_object_get_data (G_OBJECT (menu_item),
701 "gtk-empty-menu-item"))
704 carbon_item = carbon_menu_item_get (menu_item);
707 g_printerr ("%s: carbon_item %d for menu_item %d (%s, %s)\n",
708 G_STRFUNC, carbon_item ? carbon_item->index : -1,
709 carbon_index, get_menu_label_text (menu_item, NULL),
710 g_type_name (G_TYPE_FROM_INSTANCE (menu_item)));
712 if (carbon_item && carbon_item->index != carbon_index)
715 g_printerr ("%s: -> not matching, deleting\n", G_STRFUNC);
717 DeleteMenuItem (carbon_item->menu, carbon_index);
723 GtkWidget *label = NULL;
724 const gchar *label_text;
725 CFStringRef cfstr = NULL;
726 MenuItemAttributes attributes = 0;
729 g_printerr ("%s: -> creating new\n", G_STRFUNC);
731 label_text = get_menu_label_text (menu_item, &label);
733 cfstr = CFStringCreateWithCString (NULL, label_text,
734 kCFStringEncodingUTF8);
736 if (GTK_IS_SEPARATOR_MENU_ITEM (menu_item))
737 attributes |= kMenuItemAttrSeparator;
739 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
740 attributes |= kMenuItemAttrDisabled;
742 if (!GTK_WIDGET_VISIBLE (menu_item))
743 attributes |= kMenuItemAttrHidden;
745 InsertMenuItemTextWithCFString (carbon_menu, cfstr,
748 SetMenuItemProperty (carbon_menu, carbon_index,
749 IGE_QUARTZ_MENU_CREATOR,
750 IGE_QUARTZ_ITEM_WIDGET,
751 sizeof (menu_item), &menu_item);
756 carbon_item = carbon_menu_item_connect (menu_item, label,
760 if (GTK_IS_CHECK_MENU_ITEM (menu_item))
761 carbon_menu_item_update_active (carbon_item, menu_item);
763 carbon_menu_item_update_accel_closure (carbon_item, menu_item);
765 if (gtk_menu_item_get_submenu (GTK_MENU_ITEM (menu_item)))
766 carbon_menu_item_update_submenu (carbon_item, menu_item);
772 g_list_free (children);
776 static gulong emission_hook_id = 0;
779 parent_set_emission_hook (GSignalInvocationHint *ihint,
780 guint n_param_values,
781 const GValue *param_values,
784 GtkWidget *instance = g_value_get_object (param_values);
786 if (GTK_IS_MENU_ITEM (instance))
788 GtkWidget *previous_parent = g_value_get_object (param_values + 1);
789 GtkWidget *menu_shell = NULL;
791 if (GTK_IS_MENU_SHELL (previous_parent))
793 menu_shell = previous_parent;
795 else if (GTK_IS_MENU_SHELL (instance->parent))
797 menu_shell = instance->parent;
802 CarbonMenu *carbon_menu = carbon_menu_get (menu_shell);
807 g_printerr ("%s: item %s %p (%s, %s)\n", G_STRFUNC,
808 previous_parent ? "removed from" : "added to",
810 get_menu_label_text (instance, NULL),
811 g_type_name (G_TYPE_FROM_INSTANCE (instance)));
814 sync_menu_shell (GTK_MENU_SHELL (menu_shell),
816 carbon_menu->menu == (MenuRef) data,
826 parent_set_emission_hook_remove (GtkWidget *widget,
829 g_signal_remove_emission_hook (g_signal_lookup ("parent-set",
840 ige_mac_menu_set_menu_bar (GtkMenuShell *menu_shell)
842 MenuRef carbon_menubar;
844 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
846 if (carbon_menu_quark == 0)
847 carbon_menu_quark = g_quark_from_static_string ("CarbonMenu");
849 if (carbon_menu_item_quark == 0)
850 carbon_menu_item_quark = g_quark_from_static_string ("CarbonMenuItem");
852 CreateNewMenu (0 /*id*/, 0 /*options*/, &carbon_menubar);
853 SetRootMenu (carbon_menubar);
855 setup_menu_event_handler ();
858 g_signal_add_emission_hook (g_signal_lookup ("parent-set",
861 parent_set_emission_hook,
862 carbon_menubar, NULL);
864 g_signal_connect (menu_shell, "destroy",
865 G_CALLBACK (parent_set_emission_hook_remove),
868 sync_menu_shell (menu_shell, carbon_menubar, TRUE, FALSE);
872 ige_mac_menu_set_quit_menu_item (GtkMenuItem *menu_item)
877 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
879 if (GetIndMenuItemWithCommandID (NULL, kHICommandQuit, 1,
880 &appmenu, &index) == noErr)
882 SetMenuItemCommandID (appmenu, index, 0);
883 SetMenuItemProperty (appmenu, index,
884 IGE_QUARTZ_MENU_CREATOR,
885 IGE_QUARTZ_ITEM_WIDGET,
886 sizeof (menu_item), &menu_item);
888 gtk_widget_hide (GTK_WIDGET (menu_item));
893 struct _IgeMacMenuGroup
898 static GList *app_menu_groups = NULL;
901 ige_mac_menu_add_app_menu_group (void)
903 IgeMacMenuGroup *group = g_slice_new0 (IgeMacMenuGroup);
905 app_menu_groups = g_list_append (app_menu_groups, group);
911 ige_mac_menu_add_app_menu_item (IgeMacMenuGroup *group,
912 GtkMenuItem *menu_item,
919 g_return_if_fail (group != NULL);
920 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
922 if (GetIndMenuItemWithCommandID (NULL, kHICommandHide, 1,
923 &appmenu, NULL) != noErr)
925 g_warning ("%s: retrieving app menu failed",
930 for (list = app_menu_groups; list; list = g_list_next (list))
932 IgeMacMenuGroup *list_group = list->data;
934 index += g_list_length (list_group->items);
936 /* adjust index for the separator between groups, but not
937 * before the first group
939 if (list_group->items && list->prev)
942 if (group == list_group)
946 /* add a separator before adding the first item, but not
947 * for the first group
949 if (!group->items && list->prev)
951 InsertMenuItemTextWithCFString (appmenu, NULL, index,
952 kMenuItemAttrSeparator, 0);
957 label = get_menu_label_text (GTK_WIDGET (menu_item), NULL);
959 cfstr = CFStringCreateWithCString (NULL, label,
960 kCFStringEncodingUTF8);
962 InsertMenuItemTextWithCFString (appmenu, cfstr, index, 0, 0);
963 SetMenuItemProperty (appmenu, index + 1,
964 IGE_QUARTZ_MENU_CREATOR,
965 IGE_QUARTZ_ITEM_WIDGET,
966 sizeof (menu_item), &menu_item);
970 gtk_widget_hide (GTK_WIDGET (menu_item));
972 group->items = g_list_append (group->items, menu_item);
979 g_warning ("%s: app menu group %p does not exist",