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 "ige-mac-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);
316 if (gdk_keymap_get_entries_for_keyval (keymap, key->accel_key,
319 UInt8 modifiers = 0; /* implies Command key */
321 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
322 true, keys[0].keycode);
330 if (key->accel_mods & GDK_SHIFT_MASK) {
331 modifiers |= kMenuShiftModifier;
334 if (key->accel_mods & (GDK_MOD1_MASK)) {
335 modifiers |= kMenuOptionModifier;
338 if (key->accel_mods & GDK_CONTROL_MASK) {
339 modifiers |= kMenuControlModifier;
342 if (key->accel_mods & GDK_MOD5_MASK) {
343 /* Mod5 is what ardour's binding file uses to mean "Command"
344 Nothing needs to be set in modifiers, but we need to notice
345 that there *is* an implicit modifier
352 modifiers |= kMenuNoCommandModifier;
354 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
362 /* otherwise, clear the menu shortcut */
363 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
364 kMenuNoModifiers | kMenuNoCommandModifier);
365 ChangeMenuItemAttributes (carbon_item->menu, carbon_item->index,
366 0, kMenuItemAttrUseVirtualKey);
367 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
372 carbon_menu_item_accel_changed (GtkAccelGroup *accel_group,
374 GdkModifierType modifier,
375 GClosure *accel_closure,
378 CarbonMenuItem *carbon_item = carbon_menu_item_get (widget);
381 get_menu_label_text (widget, &label);
383 if (GTK_IS_ACCEL_LABEL (label) &&
384 GTK_ACCEL_LABEL (label)->accel_closure == accel_closure)
385 carbon_menu_item_update_accelerator (carbon_item, widget);
389 carbon_menu_item_update_accel_closure (CarbonMenuItem *carbon_item,
392 GtkAccelGroup *group;
395 get_menu_label_text (widget, &label);
397 if (carbon_item->accel_closure)
399 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
401 g_signal_handlers_disconnect_by_func (group,
402 carbon_menu_item_accel_changed,
405 g_closure_unref (carbon_item->accel_closure);
406 carbon_item->accel_closure = NULL;
409 if (GTK_IS_ACCEL_LABEL (label))
410 carbon_item->accel_closure = GTK_ACCEL_LABEL (label)->accel_closure;
412 if (carbon_item->accel_closure)
414 g_closure_ref (carbon_item->accel_closure);
416 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
418 g_signal_connect_object (group, "accel-changed",
419 G_CALLBACK (carbon_menu_item_accel_changed),
423 carbon_menu_item_update_accelerator (carbon_item, widget);
427 carbon_menu_item_notify (GObject *object,
429 CarbonMenuItem *carbon_item)
431 if (!strcmp (pspec->name, "sensitive") ||
432 !strcmp (pspec->name, "visible"))
434 carbon_menu_item_update_state (carbon_item, GTK_WIDGET (object));
436 else if (!strcmp (pspec->name, "active"))
438 carbon_menu_item_update_active (carbon_item, GTK_WIDGET (object));
440 else if (!strcmp (pspec->name, "submenu"))
442 carbon_menu_item_update_submenu (carbon_item, GTK_WIDGET (object));
447 carbon_menu_item_notify_label (GObject *object,
451 CarbonMenuItem *carbon_item = carbon_menu_item_get (GTK_WIDGET (object));
453 if (!strcmp (pspec->name, "label"))
455 carbon_menu_item_update_label (carbon_item,
456 GTK_WIDGET (object));
458 else if (!strcmp (pspec->name, "accel-closure"))
460 carbon_menu_item_update_accel_closure (carbon_item,
461 GTK_WIDGET (object));
465 static CarbonMenuItem *
466 carbon_menu_item_connect (GtkWidget *menu_item,
471 CarbonMenuItem *carbon_item = carbon_menu_item_get (menu_item);
475 carbon_item = carbon_menu_item_new ();
477 g_object_set_qdata_full (G_OBJECT (menu_item), carbon_menu_item_quark,
479 (GDestroyNotify) carbon_menu_item_free);
481 g_signal_connect (menu_item, "notify",
482 G_CALLBACK (carbon_menu_item_notify),
486 g_signal_connect_swapped (label, "notify::label",
487 G_CALLBACK (carbon_menu_item_notify_label),
491 carbon_item->menu = menu;
492 carbon_item->index = index;
499 * carbon event handler
503 menu_event_handler_func (EventHandlerCallRef event_handler_call_ref,
507 UInt32 event_class = GetEventClass (event_ref);
508 UInt32 event_kind = GetEventKind (event_ref);
513 case kEventClassCommand:
514 /* This is called when activating (is that the right GTK+ term?)
517 if (event_kind == kEventCommandProcess)
522 /*g_printerr ("Menu: kEventClassCommand/kEventCommandProcess\n");*/
524 err = GetEventParameter (event_ref, kEventParamDirectObject,
526 sizeof (command), 0, &command);
530 GtkWidget *widget = NULL;
532 /* Get any GtkWidget associated with the item. */
533 err = GetMenuItemProperty (command.menu.menuRef,
534 command.menu.menuItemIndex,
535 IGE_QUARTZ_MENU_CREATOR,
536 IGE_QUARTZ_ITEM_WIDGET,
537 sizeof (widget), 0, &widget);
538 if (err == noErr && GTK_IS_WIDGET (widget))
540 gtk_menu_item_activate (GTK_MENU_ITEM (widget));
547 case kEventClassMenu:
548 GetEventParameter (event_ref,
549 kEventParamDirectObject,
558 case kEventMenuTargetItem:
559 /* This is called when an item is selected (what is the
560 * GTK+ term? prelight?)
562 /*g_printerr ("kEventClassMenu/kEventMenuTargetItem\n");*/
565 case kEventMenuOpening:
566 /* Is it possible to dynamically build the menu here? We
567 * can at least set visibility/sensitivity.
569 /*g_printerr ("kEventClassMenu/kEventMenuOpening\n");*/
572 case kEventMenuClosed:
573 /*g_printerr ("kEventClassMenu/kEventMenuClosed\n");*/
586 return CallNextEventHandler (event_handler_call_ref, event_ref);
590 setup_menu_event_handler (void)
592 EventHandlerUPP menu_event_handler_upp;
593 EventHandlerRef menu_event_handler_ref;
594 const EventTypeSpec menu_events[] = {
595 { kEventClassCommand, kEventCommandProcess },
596 { kEventClassMenu, kEventMenuTargetItem },
597 { kEventClassMenu, kEventMenuOpening },
598 { kEventClassMenu, kEventMenuClosed }
601 /* FIXME: We might have to install one per window? */
603 menu_event_handler_upp = NewEventHandlerUPP (menu_event_handler_func);
604 InstallEventHandler (GetApplicationEventTarget (), menu_event_handler_upp,
605 GetEventTypeCount (menu_events), menu_events, 0,
606 &menu_event_handler_ref);
609 /* FIXME: Remove the handler with: */
610 RemoveEventHandler(menu_event_handler_ref);
611 DisposeEventHandlerUPP(menu_event_handler_upp);
616 sync_menu_shell (GtkMenuShell *menu_shell,
623 MenuItemIndex carbon_index = 1;
626 g_printerr ("%s: syncing shell %p\n", G_STRFUNC, menu_shell);
628 carbon_menu_connect (GTK_WIDGET (menu_shell), carbon_menu);
630 children = gtk_container_get_children (GTK_CONTAINER (menu_shell));
632 for (l = children; l; l = l->next)
634 GtkWidget *menu_item = l->data;
635 CarbonMenuItem *carbon_item;
637 if (GTK_IS_TEAROFF_MENU_ITEM (menu_item))
640 if (toplevel && g_object_get_data (G_OBJECT (menu_item),
641 "gtk-empty-menu-item"))
644 carbon_item = carbon_menu_item_get (menu_item);
647 g_printerr ("%s: carbon_item %d for menu_item %d (%s, %s)\n",
648 G_STRFUNC, carbon_item ? carbon_item->index : -1,
649 carbon_index, get_menu_label_text (menu_item, NULL),
650 g_type_name (G_TYPE_FROM_INSTANCE (menu_item)));
652 if (carbon_item && carbon_item->index != carbon_index)
655 g_printerr ("%s: -> not matching, deleting\n", G_STRFUNC);
657 DeleteMenuItem (carbon_item->menu, carbon_index);
663 GtkWidget *label = NULL;
664 const gchar *label_text;
665 CFStringRef cfstr = NULL;
666 MenuItemAttributes attributes = 0;
669 g_printerr ("%s: -> creating new\n", G_STRFUNC);
671 label_text = get_menu_label_text (menu_item, &label);
673 cfstr = CFStringCreateWithCString (NULL, label_text,
674 kCFStringEncodingUTF8);
676 if (GTK_IS_SEPARATOR_MENU_ITEM (menu_item))
677 attributes |= kMenuItemAttrSeparator;
679 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
680 attributes |= kMenuItemAttrDisabled;
682 if (!GTK_WIDGET_VISIBLE (menu_item))
683 attributes |= kMenuItemAttrHidden;
685 InsertMenuItemTextWithCFString (carbon_menu, cfstr,
688 SetMenuItemProperty (carbon_menu, carbon_index,
689 IGE_QUARTZ_MENU_CREATOR,
690 IGE_QUARTZ_ITEM_WIDGET,
691 sizeof (menu_item), &menu_item);
696 carbon_item = carbon_menu_item_connect (menu_item, label,
700 if (GTK_IS_CHECK_MENU_ITEM (menu_item))
701 carbon_menu_item_update_active (carbon_item, menu_item);
703 carbon_menu_item_update_accel_closure (carbon_item, menu_item);
705 if (gtk_menu_item_get_submenu (GTK_MENU_ITEM (menu_item)))
706 carbon_menu_item_update_submenu (carbon_item, menu_item);
712 g_list_free (children);
716 static gulong emission_hook_id = 0;
719 parent_set_emission_hook (GSignalInvocationHint *ihint,
720 guint n_param_values,
721 const GValue *param_values,
724 GtkWidget *instance = g_value_get_object (param_values);
726 if (GTK_IS_MENU_ITEM (instance))
728 GtkWidget *previous_parent = g_value_get_object (param_values + 1);
729 GtkWidget *menu_shell = NULL;
731 if (GTK_IS_MENU_SHELL (previous_parent))
733 menu_shell = previous_parent;
735 else if (GTK_IS_MENU_SHELL (instance->parent))
737 menu_shell = instance->parent;
742 CarbonMenu *carbon_menu = carbon_menu_get (menu_shell);
747 g_printerr ("%s: item %s %p (%s, %s)\n", G_STRFUNC,
748 previous_parent ? "removed from" : "added to",
750 get_menu_label_text (instance, NULL),
751 g_type_name (G_TYPE_FROM_INSTANCE (instance)));
754 sync_menu_shell (GTK_MENU_SHELL (menu_shell),
756 carbon_menu->menu == (MenuRef) data,
766 parent_set_emission_hook_remove (GtkWidget *widget,
769 g_signal_remove_emission_hook (g_signal_lookup ("parent-set",
780 ige_mac_menu_set_menu_bar (GtkMenuShell *menu_shell)
782 MenuRef carbon_menubar;
784 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
786 if (carbon_menu_quark == 0)
787 carbon_menu_quark = g_quark_from_static_string ("CarbonMenu");
789 if (carbon_menu_item_quark == 0)
790 carbon_menu_item_quark = g_quark_from_static_string ("CarbonMenuItem");
792 CreateNewMenu (0 /*id*/, 0 /*options*/, &carbon_menubar);
793 SetRootMenu (carbon_menubar);
795 setup_menu_event_handler ();
798 g_signal_add_emission_hook (g_signal_lookup ("parent-set",
801 parent_set_emission_hook,
802 carbon_menubar, NULL);
804 g_signal_connect (menu_shell, "destroy",
805 G_CALLBACK (parent_set_emission_hook_remove),
808 sync_menu_shell (menu_shell, carbon_menubar, TRUE, FALSE);
812 ige_mac_menu_set_quit_menu_item (GtkMenuItem *menu_item)
817 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
819 if (GetIndMenuItemWithCommandID (NULL, kHICommandQuit, 1,
820 &appmenu, &index) == noErr)
822 SetMenuItemCommandID (appmenu, index, 0);
823 SetMenuItemProperty (appmenu, index,
824 IGE_QUARTZ_MENU_CREATOR,
825 IGE_QUARTZ_ITEM_WIDGET,
826 sizeof (menu_item), &menu_item);
828 gtk_widget_hide (GTK_WIDGET (menu_item));
833 struct _IgeMacMenuGroup
838 static GList *app_menu_groups = NULL;
841 ige_mac_menu_add_app_menu_group (void)
843 IgeMacMenuGroup *group = g_slice_new0 (IgeMacMenuGroup);
845 app_menu_groups = g_list_append (app_menu_groups, group);
851 ige_mac_menu_add_app_menu_item (IgeMacMenuGroup *group,
852 GtkMenuItem *menu_item,
859 g_return_if_fail (group != NULL);
860 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
862 if (GetIndMenuItemWithCommandID (NULL, kHICommandHide, 1,
863 &appmenu, NULL) != noErr)
865 g_warning ("%s: retrieving app menu failed",
870 for (list = app_menu_groups; list; list = g_list_next (list))
872 IgeMacMenuGroup *list_group = list->data;
874 index += g_list_length (list_group->items);
876 /* adjust index for the separator between groups, but not
877 * before the first group
879 if (list_group->items && list->prev)
882 if (group == list_group)
886 /* add a separator before adding the first item, but not
887 * for the first group
889 if (!group->items && list->prev)
891 InsertMenuItemTextWithCFString (appmenu, NULL, index,
892 kMenuItemAttrSeparator, 0);
897 label = get_menu_label_text (GTK_WIDGET (menu_item), NULL);
899 cfstr = CFStringCreateWithCString (NULL, label,
900 kCFStringEncodingUTF8);
902 InsertMenuItemTextWithCFString (appmenu, cfstr, index, 0, 0);
903 SetMenuItemProperty (appmenu, index + 1,
904 IGE_QUARTZ_MENU_CREATOR,
905 IGE_QUARTZ_ITEM_WIDGET,
906 sizeof (menu_item), &menu_item);
910 gtk_widget_hide (GTK_WIDGET (menu_item));
912 group->items = g_list_append (group->items, menu_item);
919 g_warning ("%s: app menu group %p does not exist",