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 "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;
317 if (gdk_keymap_get_entries_for_keyval (keymap, key->accel_key,
318 &keys, &n_keys) == 0)
322 switch (key->accel_key) {
325 realkey = kRightArrowCharCode;
329 realkey = kLeftArrowCharCode;
333 realkey = kUpArrowCharCode;
337 realkey = kDownArrowCharCode;
344 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
346 add_modifiers = TRUE;
350 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
351 true, keys[0].keycode);
353 add_modifiers = TRUE;
358 UInt8 modifiers = 0; /* implies Command key */
364 if (key->accel_mods & GDK_SHIFT_MASK) {
365 modifiers |= kMenuShiftModifier;
368 /* gdk/quartz maps Alt/Option to Mod1 */
370 if (key->accel_mods & (GDK_MOD1_MASK)) {
371 modifiers |= kMenuOptionModifier;
374 if (key->accel_mods & GDK_CONTROL_MASK) {
375 modifiers |= kMenuControlModifier;
378 /* gdk/quartz maps Command to Meta */
380 if (key->accel_mods & GDK_META_MASK) {
386 modifiers |= kMenuNoCommandModifier;
388 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
396 /* otherwise, clear the menu shortcut */
397 SetMenuItemModifiers (carbon_item->menu, carbon_item->index,
398 kMenuNoModifiers | kMenuNoCommandModifier);
399 ChangeMenuItemAttributes (carbon_item->menu, carbon_item->index,
400 0, kMenuItemAttrUseVirtualKey);
401 SetMenuItemCommandKey (carbon_item->menu, carbon_item->index,
406 carbon_menu_item_accel_changed (GtkAccelGroup *accel_group,
408 GdkModifierType modifier,
409 GClosure *accel_closure,
412 CarbonMenuItem *carbon_item = carbon_menu_item_get (widget);
415 get_menu_label_text (widget, &label);
417 if (GTK_IS_ACCEL_LABEL (label) &&
418 GTK_ACCEL_LABEL (label)->accel_closure == accel_closure)
419 carbon_menu_item_update_accelerator (carbon_item, widget);
423 carbon_menu_item_update_accel_closure (CarbonMenuItem *carbon_item,
426 GtkAccelGroup *group;
429 get_menu_label_text (widget, &label);
431 if (carbon_item->accel_closure)
433 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
435 g_signal_handlers_disconnect_by_func (group,
436 carbon_menu_item_accel_changed,
439 g_closure_unref (carbon_item->accel_closure);
440 carbon_item->accel_closure = NULL;
443 if (GTK_IS_ACCEL_LABEL (label))
444 carbon_item->accel_closure = GTK_ACCEL_LABEL (label)->accel_closure;
446 if (carbon_item->accel_closure)
448 g_closure_ref (carbon_item->accel_closure);
450 group = gtk_accel_group_from_accel_closure (carbon_item->accel_closure);
452 g_signal_connect_object (group, "accel-changed",
453 G_CALLBACK (carbon_menu_item_accel_changed),
457 carbon_menu_item_update_accelerator (carbon_item, widget);
461 carbon_menu_item_notify (GObject *object,
463 CarbonMenuItem *carbon_item)
465 if (!strcmp (pspec->name, "sensitive") ||
466 !strcmp (pspec->name, "visible"))
468 carbon_menu_item_update_state (carbon_item, GTK_WIDGET (object));
470 else if (!strcmp (pspec->name, "active"))
472 carbon_menu_item_update_active (carbon_item, GTK_WIDGET (object));
474 else if (!strcmp (pspec->name, "submenu"))
476 carbon_menu_item_update_submenu (carbon_item, GTK_WIDGET (object));
481 carbon_menu_item_notify_label (GObject *object,
485 CarbonMenuItem *carbon_item = carbon_menu_item_get (GTK_WIDGET (object));
487 if (!strcmp (pspec->name, "label"))
489 carbon_menu_item_update_label (carbon_item,
490 GTK_WIDGET (object));
492 else if (!strcmp (pspec->name, "accel-closure"))
494 carbon_menu_item_update_accel_closure (carbon_item,
495 GTK_WIDGET (object));
499 static CarbonMenuItem *
500 carbon_menu_item_connect (GtkWidget *menu_item,
505 CarbonMenuItem *carbon_item = carbon_menu_item_get (menu_item);
509 carbon_item = carbon_menu_item_new ();
511 g_object_set_qdata_full (G_OBJECT (menu_item), carbon_menu_item_quark,
513 (GDestroyNotify) carbon_menu_item_free);
515 g_signal_connect (menu_item, "notify",
516 G_CALLBACK (carbon_menu_item_notify),
520 g_signal_connect_swapped (label, "notify::label",
521 G_CALLBACK (carbon_menu_item_notify_label),
525 carbon_item->menu = menu;
526 carbon_item->index = index;
533 * carbon event handler
537 menu_event_handler_func (EventHandlerCallRef event_handler_call_ref,
541 UInt32 event_class = GetEventClass (event_ref);
542 UInt32 event_kind = GetEventKind (event_ref);
547 case kEventClassCommand:
548 /* This is called when activating (is that the right GTK+ term?)
551 if (event_kind == kEventCommandProcess)
556 /*g_printerr ("Menu: kEventClassCommand/kEventCommandProcess\n");*/
558 err = GetEventParameter (event_ref, kEventParamDirectObject,
560 sizeof (command), 0, &command);
564 GtkWidget *widget = NULL;
566 /* Get any GtkWidget associated with the item. */
567 err = GetMenuItemProperty (command.menu.menuRef,
568 command.menu.menuItemIndex,
569 IGE_QUARTZ_MENU_CREATOR,
570 IGE_QUARTZ_ITEM_WIDGET,
571 sizeof (widget), 0, &widget);
572 if (err == noErr && GTK_IS_WIDGET (widget))
574 gtk_menu_item_activate (GTK_MENU_ITEM (widget));
581 case kEventClassMenu:
582 GetEventParameter (event_ref,
583 kEventParamDirectObject,
592 case kEventMenuTargetItem:
593 /* This is called when an item is selected (what is the
594 * GTK+ term? prelight?)
596 /*g_printerr ("kEventClassMenu/kEventMenuTargetItem\n");*/
599 case kEventMenuOpening:
600 /* Is it possible to dynamically build the menu here? We
601 * can at least set visibility/sensitivity.
603 /*g_printerr ("kEventClassMenu/kEventMenuOpening\n");*/
606 case kEventMenuClosed:
607 /*g_printerr ("kEventClassMenu/kEventMenuClosed\n");*/
620 return CallNextEventHandler (event_handler_call_ref, event_ref);
624 setup_menu_event_handler (void)
626 EventHandlerUPP menu_event_handler_upp;
627 EventHandlerRef menu_event_handler_ref;
628 const EventTypeSpec menu_events[] = {
629 { kEventClassCommand, kEventCommandProcess },
630 { kEventClassMenu, kEventMenuTargetItem },
631 { kEventClassMenu, kEventMenuOpening },
632 { kEventClassMenu, kEventMenuClosed }
635 /* FIXME: We might have to install one per window? */
637 menu_event_handler_upp = NewEventHandlerUPP (menu_event_handler_func);
638 InstallEventHandler (GetApplicationEventTarget (), menu_event_handler_upp,
639 GetEventTypeCount (menu_events), menu_events, 0,
640 &menu_event_handler_ref);
643 /* FIXME: Remove the handler with: */
644 RemoveEventHandler(menu_event_handler_ref);
645 DisposeEventHandlerUPP(menu_event_handler_upp);
650 sync_menu_shell (GtkMenuShell *menu_shell,
657 MenuItemIndex carbon_index = 1;
660 g_printerr ("%s: syncing shell %p\n", G_STRFUNC, menu_shell);
662 carbon_menu_connect (GTK_WIDGET (menu_shell), carbon_menu);
664 children = gtk_container_get_children (GTK_CONTAINER (menu_shell));
666 for (l = children; l; l = l->next)
668 GtkWidget *menu_item = l->data;
669 CarbonMenuItem *carbon_item;
671 if (GTK_IS_TEAROFF_MENU_ITEM (menu_item))
674 if (toplevel && g_object_get_data (G_OBJECT (menu_item),
675 "gtk-empty-menu-item"))
678 carbon_item = carbon_menu_item_get (menu_item);
681 g_printerr ("%s: carbon_item %d for menu_item %d (%s, %s)\n",
682 G_STRFUNC, carbon_item ? carbon_item->index : -1,
683 carbon_index, get_menu_label_text (menu_item, NULL),
684 g_type_name (G_TYPE_FROM_INSTANCE (menu_item)));
686 if (carbon_item && carbon_item->index != carbon_index)
689 g_printerr ("%s: -> not matching, deleting\n", G_STRFUNC);
691 DeleteMenuItem (carbon_item->menu, carbon_index);
697 GtkWidget *label = NULL;
698 const gchar *label_text;
699 CFStringRef cfstr = NULL;
700 MenuItemAttributes attributes = 0;
703 g_printerr ("%s: -> creating new\n", G_STRFUNC);
705 label_text = get_menu_label_text (menu_item, &label);
707 cfstr = CFStringCreateWithCString (NULL, label_text,
708 kCFStringEncodingUTF8);
710 if (GTK_IS_SEPARATOR_MENU_ITEM (menu_item))
711 attributes |= kMenuItemAttrSeparator;
713 if (!GTK_WIDGET_IS_SENSITIVE (menu_item))
714 attributes |= kMenuItemAttrDisabled;
716 if (!GTK_WIDGET_VISIBLE (menu_item))
717 attributes |= kMenuItemAttrHidden;
719 InsertMenuItemTextWithCFString (carbon_menu, cfstr,
722 SetMenuItemProperty (carbon_menu, carbon_index,
723 IGE_QUARTZ_MENU_CREATOR,
724 IGE_QUARTZ_ITEM_WIDGET,
725 sizeof (menu_item), &menu_item);
730 carbon_item = carbon_menu_item_connect (menu_item, label,
734 if (GTK_IS_CHECK_MENU_ITEM (menu_item))
735 carbon_menu_item_update_active (carbon_item, menu_item);
737 carbon_menu_item_update_accel_closure (carbon_item, menu_item);
739 if (gtk_menu_item_get_submenu (GTK_MENU_ITEM (menu_item)))
740 carbon_menu_item_update_submenu (carbon_item, menu_item);
746 g_list_free (children);
750 static gulong emission_hook_id = 0;
753 parent_set_emission_hook (GSignalInvocationHint *ihint,
754 guint n_param_values,
755 const GValue *param_values,
758 GtkWidget *instance = g_value_get_object (param_values);
760 if (GTK_IS_MENU_ITEM (instance))
762 GtkWidget *previous_parent = g_value_get_object (param_values + 1);
763 GtkWidget *menu_shell = NULL;
765 if (GTK_IS_MENU_SHELL (previous_parent))
767 menu_shell = previous_parent;
769 else if (GTK_IS_MENU_SHELL (instance->parent))
771 menu_shell = instance->parent;
776 CarbonMenu *carbon_menu = carbon_menu_get (menu_shell);
781 g_printerr ("%s: item %s %p (%s, %s)\n", G_STRFUNC,
782 previous_parent ? "removed from" : "added to",
784 get_menu_label_text (instance, NULL),
785 g_type_name (G_TYPE_FROM_INSTANCE (instance)));
788 sync_menu_shell (GTK_MENU_SHELL (menu_shell),
790 carbon_menu->menu == (MenuRef) data,
800 parent_set_emission_hook_remove (GtkWidget *widget,
803 g_signal_remove_emission_hook (g_signal_lookup ("parent-set",
814 ige_mac_menu_set_menu_bar (GtkMenuShell *menu_shell)
816 MenuRef carbon_menubar;
818 g_return_if_fail (GTK_IS_MENU_SHELL (menu_shell));
820 if (carbon_menu_quark == 0)
821 carbon_menu_quark = g_quark_from_static_string ("CarbonMenu");
823 if (carbon_menu_item_quark == 0)
824 carbon_menu_item_quark = g_quark_from_static_string ("CarbonMenuItem");
826 CreateNewMenu (0 /*id*/, 0 /*options*/, &carbon_menubar);
827 SetRootMenu (carbon_menubar);
829 setup_menu_event_handler ();
832 g_signal_add_emission_hook (g_signal_lookup ("parent-set",
835 parent_set_emission_hook,
836 carbon_menubar, NULL);
838 g_signal_connect (menu_shell, "destroy",
839 G_CALLBACK (parent_set_emission_hook_remove),
842 sync_menu_shell (menu_shell, carbon_menubar, TRUE, FALSE);
846 ige_mac_menu_set_quit_menu_item (GtkMenuItem *menu_item)
851 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
853 if (GetIndMenuItemWithCommandID (NULL, kHICommandQuit, 1,
854 &appmenu, &index) == noErr)
856 SetMenuItemCommandID (appmenu, index, 0);
857 SetMenuItemProperty (appmenu, index,
858 IGE_QUARTZ_MENU_CREATOR,
859 IGE_QUARTZ_ITEM_WIDGET,
860 sizeof (menu_item), &menu_item);
862 gtk_widget_hide (GTK_WIDGET (menu_item));
867 struct _IgeMacMenuGroup
872 static GList *app_menu_groups = NULL;
875 ige_mac_menu_add_app_menu_group (void)
877 IgeMacMenuGroup *group = g_slice_new0 (IgeMacMenuGroup);
879 app_menu_groups = g_list_append (app_menu_groups, group);
885 ige_mac_menu_add_app_menu_item (IgeMacMenuGroup *group,
886 GtkMenuItem *menu_item,
893 g_return_if_fail (group != NULL);
894 g_return_if_fail (GTK_IS_MENU_ITEM (menu_item));
896 if (GetIndMenuItemWithCommandID (NULL, kHICommandHide, 1,
897 &appmenu, NULL) != noErr)
899 g_warning ("%s: retrieving app menu failed",
904 for (list = app_menu_groups; list; list = g_list_next (list))
906 IgeMacMenuGroup *list_group = list->data;
908 index += g_list_length (list_group->items);
910 /* adjust index for the separator between groups, but not
911 * before the first group
913 if (list_group->items && list->prev)
916 if (group == list_group)
920 /* add a separator before adding the first item, but not
921 * for the first group
923 if (!group->items && list->prev)
925 InsertMenuItemTextWithCFString (appmenu, NULL, index,
926 kMenuItemAttrSeparator, 0);
931 label = get_menu_label_text (GTK_WIDGET (menu_item), NULL);
933 cfstr = CFStringCreateWithCString (NULL, label,
934 kCFStringEncodingUTF8);
936 InsertMenuItemTextWithCFString (appmenu, cfstr, index, 0, 0);
937 SetMenuItemProperty (appmenu, index + 1,
938 IGE_QUARTZ_MENU_CREATOR,
939 IGE_QUARTZ_ITEM_WIDGET,
940 sizeof (menu_item), &menu_item);
944 gtk_widget_hide (GTK_WIDGET (menu_item));
946 group->items = g_list_append (group->items, menu_item);
953 g_warning ("%s: app menu group %p does not exist",