Fix Unicode key code for Ctrl-letter in wxGTK.
[wxWidgets.git] / src / gtk / menu.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/menu.cpp
3 // Purpose: implementation of wxMenuBar and wxMenu classes for wxGTK
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
12
13 #if wxUSE_MENUS
14
15 #include "wx/menu.h"
16
17 #ifndef WX_PRECOMP
18 #include "wx/intl.h"
19 #include "wx/log.h"
20 #include "wx/frame.h"
21 #include "wx/bitmap.h"
22 #include "wx/app.h"
23 #endif
24
25 #include "wx/accel.h"
26 #include "wx/stockitem.h"
27 #include "wx/gtk/private.h"
28 #include "wx/gtk/private/mnemonics.h"
29
30 // we use normal item but with a special id for the menu title
31 static const int wxGTK_TITLE_ID = -3;
32
33 // forward declare it as it's used by wxMenuBar too when using Hildon
34 extern "C"
35 {
36 static void menuitem_activate(GtkWidget*, wxMenuItem* item);
37 }
38
39 #if wxUSE_ACCEL
40 static void wxGetGtkAccel(const wxMenuItem*, guint*, GdkModifierType*);
41 #endif
42
43 static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
44 {
45 event.SetEventObject( menu );
46
47 wxEvtHandler* handler = menu->GetEventHandler();
48 if (handler && handler->SafelyProcessEvent(event))
49 return;
50
51 wxWindow *win = menu->GetWindow();
52 wxCHECK_RET( win, "event for a menu without associated window?" );
53
54 win->HandleWindowEvent( event );
55 }
56
57 //-----------------------------------------------------------------------------
58 // wxMenuBar
59 //-----------------------------------------------------------------------------
60
61 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
62 {
63 #if wxUSE_LIBHILDON || wxUSE_LIBHILDON2
64 // Hildon window uses a single menu instead of a menu bar, so wxMenuBar is
65 // the same as menu in this case
66 m_widget =
67 m_menubar = gtk_menu_new();
68 #else // !wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
69 if (!PreCreation( NULL, wxDefaultPosition, wxDefaultSize ) ||
70 !CreateBase( NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
71 {
72 wxFAIL_MSG( wxT("wxMenuBar creation failed") );
73 return;
74 }
75
76 m_menubar = gtk_menu_bar_new();
77
78 if (style & wxMB_DOCKABLE)
79 {
80 m_widget = gtk_handle_box_new();
81 gtk_container_add(GTK_CONTAINER(m_widget), m_menubar);
82 gtk_widget_show(m_menubar);
83 }
84 else
85 {
86 m_widget = m_menubar;
87 }
88
89 PostCreation();
90
91 GTKApplyWidgetStyle();
92 #endif // wxUSE_LIBHILDON || wxUSE_LIBHILDON2/!wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
93
94 g_object_ref(m_widget);
95
96 for (size_t i = 0; i < n; ++i )
97 Append(menus[i], titles[i]);
98 }
99
100 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)
101 {
102 Init(n, menus, titles, style);
103 }
104
105 wxMenuBar::wxMenuBar(long style)
106 {
107 Init(0, NULL, NULL, style);
108 }
109
110 wxMenuBar::wxMenuBar()
111 {
112 Init(0, NULL, NULL, 0);
113 }
114
115 // recursive helpers for wxMenuBar::Attach() and Detach(): they are called to
116 // associate the menus with the frame they belong to or dissociate them from it
117 namespace
118 {
119
120 void
121 DetachFromFrame(wxMenu* menu, wxFrame* frame)
122 {
123 // support for native hot keys
124 if (menu->m_accel)
125 {
126 // Note that wxGetTopLevelParent() is really needed because this frame
127 // can be an MDI child frame which is a fake frame and not a TLW at all
128 GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
129 if (g_slist_find(menu->m_accel->acceleratables, tlw))
130 gtk_window_remove_accel_group(tlw, menu->m_accel);
131 }
132
133 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
134 while (node)
135 {
136 wxMenuItem *menuitem = node->GetData();
137 if (menuitem->IsSubMenu())
138 DetachFromFrame(menuitem->GetSubMenu(), frame);
139 node = node->GetNext();
140 }
141 }
142
143 void
144 AttachToFrame(wxMenu* menu, wxFrame* frame)
145 {
146 // support for native hot keys
147 if (menu->m_accel)
148 {
149 GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
150 if (!g_slist_find(menu->m_accel->acceleratables, tlw))
151 gtk_window_add_accel_group(tlw, menu->m_accel);
152 }
153
154 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
155 while (node)
156 {
157 wxMenuItem *menuitem = node->GetData();
158 if (menuitem->IsSubMenu())
159 AttachToFrame(menuitem->GetSubMenu(), frame);
160 node = node->GetNext();
161 }
162 }
163
164 } // anonymous namespace
165
166 void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir)
167 {
168 if ( dir == wxLayout_Default )
169 {
170 const wxWindow *const frame = GetFrame();
171 if ( frame )
172 {
173 // inherit layout from frame.
174 dir = frame->GetLayoutDirection();
175 }
176 else // use global layout
177 {
178 dir = wxTheApp->GetLayoutDirection();
179 }
180 }
181
182 if ( dir == wxLayout_Default )
183 return;
184
185 GTKSetLayout(m_menubar, dir);
186
187 // also set the layout of all menus we already have (new ones will inherit
188 // the current layout)
189 for ( wxMenuList::compatibility_iterator node = m_menus.GetFirst();
190 node;
191 node = node->GetNext() )
192 {
193 wxMenu *const menu = node->GetData();
194 menu->SetLayoutDirection(dir);
195 }
196 }
197
198 wxLayoutDirection wxMenuBar::GetLayoutDirection() const
199 {
200 return GTKGetLayout(m_menubar);
201 }
202
203 void wxMenuBar::Attach(wxFrame *frame)
204 {
205 wxMenuBarBase::Attach(frame);
206
207 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
208 while (node)
209 {
210 wxMenu *menu = node->GetData();
211 AttachToFrame( menu, frame );
212 node = node->GetNext();
213 }
214
215 SetLayoutDirection(wxLayout_Default);
216 }
217
218 void wxMenuBar::Detach()
219 {
220 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
221 while (node)
222 {
223 wxMenu *menu = node->GetData();
224 DetachFromFrame( menu, m_menuBarFrame );
225 node = node->GetNext();
226 }
227
228 wxMenuBarBase::Detach();
229 }
230
231 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
232 {
233 if (wxMenuBarBase::Append(menu, title))
234 {
235 GtkAppend(menu, title);
236 return true;
237 }
238 return false;
239 }
240
241 void wxMenuBar::GtkAppend(wxMenu* menu, const wxString& title, int pos)
242 {
243 menu->SetLayoutDirection(GetLayoutDirection());
244
245 #if wxUSE_LIBHILDON || wxUSE_LIBHILDON2
246 // if the menu has only one item, append it directly to the top level menu
247 // instead of inserting a useless submenu
248 if ( menu->GetMenuItemCount() == 1 )
249 {
250 wxMenuItem * const item = menu->FindItemByPosition(0);
251
252 // remove both mnemonics and accelerator: neither is useful under Maemo
253 const wxString str(wxStripMenuCodes(item->GetItemLabel()));
254
255 if ( item->IsSubMenu() )
256 {
257 GtkAppend(item->GetSubMenu(), str, pos);
258 return;
259 }
260
261 menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
262
263 g_signal_connect(menu->m_owner, "activate",
264 G_CALLBACK(menuitem_activate), item);
265 item->SetMenuItem(menu->m_owner);
266 }
267 else
268 #endif // wxUSE_LIBHILDON || wxUSE_LIBHILDON2 /!wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
269 {
270 const wxString str(wxConvertMnemonicsToGTK(title));
271
272 // This doesn't have much effect right now.
273 menu->SetTitle( str );
274
275 // The "m_owner" is the "menu item"
276 menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
277
278 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
279 }
280
281 gtk_widget_show( menu->m_owner );
282
283 if (pos == -1)
284 gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
285 else
286 gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
287
288 if ( m_menuBarFrame )
289 AttachToFrame( menu, m_menuBarFrame );
290 }
291
292 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
293 {
294 if (wxMenuBarBase::Insert(pos, menu, title))
295 {
296 GtkAppend(menu, title, int(pos));
297 return true;
298 }
299 return false;
300 }
301
302 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
303 {
304 // remove the old item and insert a new one
305 wxMenu *menuOld = Remove(pos);
306 if ( menuOld && !Insert(pos, menu, title) )
307 {
308 return NULL;
309 }
310
311 // either Insert() succeeded or Remove() failed and menuOld is NULL
312 return menuOld;
313 }
314
315 wxMenu *wxMenuBar::Remove(size_t pos)
316 {
317 wxMenu *menu = wxMenuBarBase::Remove(pos);
318 if ( !menu )
319 return NULL;
320
321 gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
322 gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
323
324 gtk_widget_destroy( menu->m_owner );
325 menu->m_owner = NULL;
326
327 DetachFromFrame( menu, m_menuBarFrame );
328
329 return menu;
330 }
331
332 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
333 {
334 if (wxMenuItem::GetLabelText(menu->GetTitle()) == wxMenuItem::GetLabelText(menuString))
335 {
336 int res = menu->FindItem( itemString );
337 if (res != wxNOT_FOUND)
338 return res;
339 }
340
341 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
342 while (node)
343 {
344 wxMenuItem *item = node->GetData();
345 if (item->IsSubMenu())
346 return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
347
348 node = node->GetNext();
349 }
350
351 return wxNOT_FOUND;
352 }
353
354 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
355 {
356 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
357 while (node)
358 {
359 wxMenu *menu = node->GetData();
360 int res = FindMenuItemRecursive( menu, menuString, itemString);
361 if (res != -1)
362 return res;
363 node = node->GetNext();
364 }
365
366 return wxNOT_FOUND;
367 }
368
369 // Find a wxMenuItem using its id. Recurses down into sub-menus
370 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
371 {
372 wxMenuItem* result = menu->FindChildItem(id);
373
374 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
375 while ( node && result == NULL )
376 {
377 wxMenuItem *item = node->GetData();
378 if (item->IsSubMenu())
379 {
380 result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
381 }
382 node = node->GetNext();
383 }
384
385 return result;
386 }
387
388 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
389 {
390 wxMenuItem* result = 0;
391 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
392 while (node && result == 0)
393 {
394 wxMenu *menu = node->GetData();
395 result = FindMenuItemByIdRecursive( menu, id );
396 node = node->GetNext();
397 }
398
399 if ( menuForItem )
400 {
401 *menuForItem = result ? result->GetMenu() : NULL;
402 }
403
404 return result;
405 }
406
407 void wxMenuBar::EnableTop( size_t pos, bool flag )
408 {
409 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
410
411 wxCHECK_RET( node, wxT("menu not found") );
412
413 wxMenu* menu = node->GetData();
414
415 if (menu->m_owner)
416 gtk_widget_set_sensitive( menu->m_owner, flag );
417 }
418
419 wxString wxMenuBar::GetMenuLabel( size_t pos ) const
420 {
421 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
422
423 wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
424
425 wxMenu* menu = node->GetData();
426
427 return menu->GetTitle();
428 }
429
430 void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
431 {
432 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
433
434 wxCHECK_RET( node, wxT("menu not found") );
435
436 wxMenu* menu = node->GetData();
437
438 const wxString str(wxConvertMnemonicsToGTK(label));
439
440 menu->SetTitle( str );
441
442 if (menu->m_owner)
443 gtk_label_set_text_with_mnemonic(GTK_LABEL(gtk_bin_get_child(GTK_BIN(menu->m_owner))), wxGTK_CONV(str));
444 }
445
446 //-----------------------------------------------------------------------------
447 // "activate"
448 //-----------------------------------------------------------------------------
449
450 extern "C" {
451 static void menuitem_activate(GtkWidget*, wxMenuItem* item)
452 {
453 if (!item->IsEnabled())
454 return;
455
456 int id = item->GetId();
457 if (id == wxGTK_TITLE_ID)
458 {
459 // ignore events from the menu title
460 return;
461 }
462
463 if (item->IsCheckable())
464 {
465 bool isReallyChecked = item->IsChecked(),
466 isInternallyChecked = item->wxMenuItemBase::IsChecked();
467
468 // ensure that the internal state is always consistent with what is
469 // shown on the screen
470 item->wxMenuItemBase::Check(isReallyChecked);
471
472 // we must not report the events for the radio button going up nor the
473 // events resulting from the calls to wxMenuItem::Check()
474 if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
475 (isInternallyChecked == isReallyChecked) )
476 {
477 return;
478 }
479 }
480
481 wxMenu* menu = item->GetMenu();
482 menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
483 }
484 }
485
486 //-----------------------------------------------------------------------------
487 // "select"
488 //-----------------------------------------------------------------------------
489
490 extern "C" {
491 static void menuitem_select(GtkWidget*, wxMenuItem* item)
492 {
493 if (!item->IsEnabled())
494 return;
495
496 wxMenuEvent event(wxEVT_MENU_HIGHLIGHT, item->GetId());
497 DoCommonMenuCallbackCode(item->GetMenu(), event);
498 }
499 }
500
501 //-----------------------------------------------------------------------------
502 // "deselect"
503 //-----------------------------------------------------------------------------
504
505 extern "C" {
506 static void menuitem_deselect(GtkWidget*, wxMenuItem* item)
507 {
508 if (!item->IsEnabled())
509 return;
510
511 wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
512 DoCommonMenuCallbackCode(item->GetMenu(), event);
513 }
514 }
515
516 //-----------------------------------------------------------------------------
517 // wxMenuItem
518 //-----------------------------------------------------------------------------
519
520 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
521 int id,
522 const wxString& name,
523 const wxString& help,
524 wxItemKind kind,
525 wxMenu *subMenu)
526 {
527 return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
528 }
529
530 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
531 int id,
532 const wxString& text,
533 const wxString& help,
534 wxItemKind kind,
535 wxMenu *subMenu)
536 : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
537 {
538 m_menuItem = NULL;
539 }
540
541 #if WXWIN_COMPATIBILITY_2_8
542 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
543 int id,
544 const wxString& text,
545 const wxString& help,
546 bool isCheckable,
547 wxMenu *subMenu)
548 : wxMenuItemBase(parentMenu, id, text, help,
549 isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
550 {
551 m_menuItem = NULL;
552 }
553 #endif
554
555 wxMenuItem::~wxMenuItem()
556 {
557 // don't delete menu items, the menus take care of that
558 }
559
560 void wxMenuItem::SetItemLabel( const wxString& str )
561 {
562 #if wxUSE_ACCEL
563 if (m_menuItem)
564 {
565 // remove old accelerator
566 guint accel_key;
567 GdkModifierType accel_mods;
568 wxGetGtkAccel(this, &accel_key, &accel_mods);
569 if (accel_key)
570 {
571 gtk_widget_remove_accelerator(
572 m_menuItem, m_parentMenu->m_accel, accel_key, accel_mods);
573 }
574 }
575 #endif // wxUSE_ACCEL
576 wxMenuItemBase::SetItemLabel(str);
577 if (m_menuItem)
578 SetGtkLabel();
579 }
580
581 void wxMenuItem::SetGtkLabel()
582 {
583 const wxString text = wxConvertMnemonicsToGTK(m_text.BeforeFirst('\t'));
584 GtkLabel* label = GTK_LABEL(gtk_bin_get_child(GTK_BIN(m_menuItem)));
585 gtk_label_set_text_with_mnemonic(label, wxGTK_CONV_SYS(text));
586 #if wxUSE_ACCEL
587 guint accel_key;
588 GdkModifierType accel_mods;
589 wxGetGtkAccel(this, &accel_key, &accel_mods);
590 if (accel_key)
591 {
592 gtk_widget_add_accelerator(
593 m_menuItem, "activate", m_parentMenu->m_accel,
594 accel_key, accel_mods, GTK_ACCEL_VISIBLE);
595 }
596 #endif // wxUSE_ACCEL
597 }
598
599 void wxMenuItem::SetBitmap(const wxBitmap& bitmap)
600 {
601 if (m_kind == wxITEM_NORMAL)
602 m_bitmap = bitmap;
603 else
604 {
605 wxFAIL_MSG("only normal menu items can have bitmaps");
606 }
607 }
608
609 void wxMenuItem::Check( bool check )
610 {
611 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
612
613 if (check == m_isChecked)
614 return;
615
616 wxMenuItemBase::Check( check );
617
618 switch ( GetKind() )
619 {
620 case wxITEM_CHECK:
621 case wxITEM_RADIO:
622 gtk_check_menu_item_set_active( (GtkCheckMenuItem*)m_menuItem, (gint)check );
623 break;
624
625 default:
626 wxFAIL_MSG( wxT("can't check this item") );
627 }
628 }
629
630 void wxMenuItem::Enable( bool enable )
631 {
632 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
633
634 gtk_widget_set_sensitive( m_menuItem, enable );
635 wxMenuItemBase::Enable( enable );
636 }
637
638 bool wxMenuItem::IsChecked() const
639 {
640 wxCHECK_MSG( m_menuItem, false, wxT("invalid menu item") );
641
642 wxCHECK_MSG( IsCheckable(), false,
643 wxT("can't get state of uncheckable item!") );
644
645 return gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(m_menuItem)) != 0;
646 }
647
648 //-----------------------------------------------------------------------------
649 // wxMenu
650 //-----------------------------------------------------------------------------
651
652 extern "C" {
653 // "map" from m_menu
654 static void menu_map(GtkWidget*, wxMenu* menu)
655 {
656 wxMenuEvent event(wxEVT_MENU_OPEN, menu->m_popupShown ? -1 : 0, menu);
657 DoCommonMenuCallbackCode(menu, event);
658 }
659
660 // "hide" from m_menu
661 static void menu_hide(GtkWidget*, wxMenu* menu)
662 {
663 wxMenuEvent event(wxEVT_MENU_CLOSE, menu->m_popupShown ? -1 : 0, menu);
664 menu->m_popupShown = false;
665 DoCommonMenuCallbackCode(menu, event);
666 }
667 }
668
669 // "can_activate_accel" from menu item
670 extern "C" {
671 static gboolean can_activate_accel(GtkWidget*, guint, wxMenu* menu)
672 {
673 menu->UpdateUI();
674 // always allow our "activate" handler to be called
675 return true;
676 }
677 }
678
679 void wxMenu::Init()
680 {
681 m_popupShown = false;
682
683 m_accel = gtk_accel_group_new();
684 m_menu = gtk_menu_new();
685 // NB: keep reference to the menu so that it is not destroyed behind
686 // our back by GTK+ e.g. when it is removed from menubar:
687 g_object_ref_sink(m_menu);
688
689 m_owner = NULL;
690
691 // Tearoffs are entries, just like separators. So if we want this
692 // menu to be a tear-off one, we just append a tearoff entry
693 // immediately.
694 if ( m_style & wxMENU_TEAROFF )
695 {
696 GtkWidget *tearoff = gtk_tearoff_menu_item_new();
697
698 gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
699 }
700
701 // append the title as the very first entry if we have it
702 if ( !m_title.empty() )
703 {
704 Append(wxGTK_TITLE_ID, m_title);
705 AppendSeparator();
706 }
707
708 // "show" occurs for sub-menus which are not showing, so use "map" instead
709 g_signal_connect(m_menu, "map", G_CALLBACK(menu_map), this);
710 g_signal_connect(m_menu, "hide", G_CALLBACK(menu_hide), this);
711 }
712
713 wxMenu::~wxMenu()
714 {
715 // Destroying a menu generates a "hide" signal even if it's not shown
716 // currently, so disconnect it to avoid dummy wxEVT_MENU_CLOSE events
717 // generation.
718 g_signal_handlers_disconnect_by_func(m_menu, (gpointer)menu_hide, this);
719
720 // see wxMenu::Init
721 g_object_unref(m_menu);
722
723 // if the menu is inserted in another menu at this time, there was
724 // one more reference to it:
725 if (m_owner)
726 gtk_widget_destroy(m_menu);
727
728 g_object_unref(m_accel);
729 }
730
731 void wxMenu::SetLayoutDirection(const wxLayoutDirection dir)
732 {
733 if ( m_owner )
734 wxWindow::GTKSetLayout(m_owner, dir);
735 //else: will be called later by wxMenuBar again
736 }
737
738 wxLayoutDirection wxMenu::GetLayoutDirection() const
739 {
740 return wxWindow::GTKGetLayout(m_owner);
741 }
742
743 wxString wxMenu::GetTitle() const
744 {
745 return wxConvertMnemonicsFromGTK(wxMenuBase::GetTitle());
746 }
747
748 void wxMenu::GtkAppend(wxMenuItem* mitem, int pos)
749 {
750 GtkWidget *menuItem;
751 switch (mitem->GetKind())
752 {
753 case wxITEM_SEPARATOR:
754 menuItem = gtk_separator_menu_item_new();
755 break;
756 case wxITEM_CHECK:
757 menuItem = gtk_check_menu_item_new_with_label("");
758 break;
759 case wxITEM_RADIO:
760 {
761 // See if we need to create a new radio group for this item or
762 // add it to an existing one.
763 wxMenuItem* radioGroupItem = NULL;
764
765 const size_t numItems = GetMenuItemCount();
766 const size_t n = pos == -1 ? numItems - 1 : size_t(pos);
767
768 if (n != 0)
769 {
770 wxMenuItem* const itemPrev = FindItemByPosition(n - 1);
771 if ( itemPrev->GetKind() == wxITEM_RADIO )
772 {
773 // Appending an item after an existing radio item puts
774 // it into the same radio group.
775 radioGroupItem = itemPrev;
776 }
777 }
778
779 if (radioGroupItem == NULL && n != numItems - 1)
780 {
781 wxMenuItem* const itemNext = FindItemByPosition(n + 1);
782 if ( itemNext->GetKind() == wxITEM_RADIO )
783 {
784 // Inserting an item before an existing radio item
785 // also puts it into the existing radio group.
786 radioGroupItem = itemNext;
787 }
788 }
789
790 GSList* group = NULL;
791 if ( radioGroupItem )
792 {
793 group = gtk_radio_menu_item_get_group(
794 GTK_RADIO_MENU_ITEM(radioGroupItem->GetMenuItem())
795 );
796 }
797
798 menuItem = gtk_radio_menu_item_new_with_label(group, "");
799 }
800 break;
801 default:
802 wxFAIL_MSG("unexpected menu item kind");
803 // fall through
804 case wxITEM_NORMAL:
805 const wxBitmap& bitmap = mitem->GetBitmap();
806 const char* stockid;
807 if (bitmap.IsOk())
808 {
809 // always use pixbuf, because pixmap mask does not
810 // work with disabled images in some themes
811 GtkWidget* image = gtk_image_new_from_pixbuf(bitmap.GetPixbuf());
812 menuItem = gtk_image_menu_item_new_with_label("");
813 gtk_widget_show(image);
814 gtk_image_menu_item_set_image(GTK_IMAGE_MENU_ITEM(menuItem), image);
815 }
816 else if ((stockid = wxGetStockGtkID(mitem->GetId())) != NULL)
817 // use stock bitmap for this item if available on the assumption
818 // that it never hurts to follow GTK+ conventions more closely
819 menuItem = gtk_image_menu_item_new_from_stock(stockid, NULL);
820 else
821 menuItem = gtk_menu_item_new_with_label("");
822 break;
823 }
824 mitem->SetMenuItem(menuItem);
825
826 gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
827
828 gtk_widget_show( menuItem );
829
830 if ( !mitem->IsSeparator() )
831 {
832 mitem->SetGtkLabel();
833 g_signal_connect (menuItem, "select",
834 G_CALLBACK(menuitem_select), mitem);
835 g_signal_connect (menuItem, "deselect",
836 G_CALLBACK(menuitem_deselect), mitem);
837
838 if ( mitem->IsSubMenu() && mitem->GetKind() != wxITEM_RADIO && mitem->GetKind() != wxITEM_CHECK )
839 {
840 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
841
842 gtk_widget_show( mitem->GetSubMenu()->m_menu );
843 }
844 else
845 {
846 g_signal_connect(menuItem, "can_activate_accel",
847 G_CALLBACK(can_activate_accel), this);
848 g_signal_connect (menuItem, "activate",
849 G_CALLBACK(menuitem_activate),
850 mitem);
851 }
852 }
853 }
854
855 wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
856 {
857 if (wxMenuBase::DoAppend(mitem))
858 {
859 GtkAppend(mitem);
860 return mitem;
861 }
862 return NULL;
863 }
864
865 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
866 {
867 if (wxMenuBase::DoInsert(pos, item))
868 {
869 GtkAppend(item, int(pos));
870 return item;
871 }
872 return NULL;
873 }
874
875 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
876 {
877 if ( !wxMenuBase::DoRemove(item) )
878 return NULL;
879
880 GtkWidget * const mitem = item->GetMenuItem();
881 if (!gtk_check_version(2,12,0))
882 {
883 // gtk_menu_item_remove_submenu() is deprecated since 2.12, but
884 // gtk_menu_item_set_submenu() can now be used with NULL submenu now so
885 // just do use it.
886 gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
887 }
888 else // GTK+ < 2.12
889 {
890 // In 2.10 calling gtk_menu_item_set_submenu() with NULL submenu
891 // results in critical GTK+ error messages so use the old function
892 // instead.
893 gtk_menu_item_remove_submenu(GTK_MENU_ITEM(mitem));
894 }
895
896 gtk_widget_destroy(mitem);
897 item->SetMenuItem(NULL);
898
899 return item;
900 }
901
902 void wxMenu::Attach(wxMenuBarBase *menubar)
903 {
904 wxMenuBase::Attach(menubar);
905
906 // inherit layout direction from menubar.
907 SetLayoutDirection(menubar->GetLayoutDirection());
908 }
909
910 // ----------------------------------------------------------------------------
911 // helpers
912 // ----------------------------------------------------------------------------
913
914 #if wxUSE_ACCEL
915
916 static wxString GetGtkHotKey( const wxMenuItem& item )
917 {
918 wxString hotkey;
919
920 wxAcceleratorEntry *accel = item.GetAccel();
921 if ( accel )
922 {
923 int flags = accel->GetFlags();
924 if ( flags & wxACCEL_ALT )
925 hotkey += wxT("<alt>");
926 if ( flags & wxACCEL_CTRL )
927 hotkey += wxT("<control>");
928 if ( flags & wxACCEL_SHIFT )
929 hotkey += wxT("<shift>");
930
931 int code = accel->GetKeyCode();
932 switch ( code )
933 {
934 case WXK_F1:
935 case WXK_F2:
936 case WXK_F3:
937 case WXK_F4:
938 case WXK_F5:
939 case WXK_F6:
940 case WXK_F7:
941 case WXK_F8:
942 case WXK_F9:
943 case WXK_F10:
944 case WXK_F11:
945 case WXK_F12:
946 case WXK_F13:
947 case WXK_F14:
948 case WXK_F15:
949 case WXK_F16:
950 case WXK_F17:
951 case WXK_F18:
952 case WXK_F19:
953 case WXK_F20:
954 case WXK_F21:
955 case WXK_F22:
956 case WXK_F23:
957 case WXK_F24:
958 hotkey += wxString::Format(wxT("F%d"), code - WXK_F1 + 1);
959 break;
960
961 // TODO: we should use gdk_keyval_name() (a.k.a.
962 // XKeysymToString) here as well as hardcoding the keysym
963 // names this might be not portable
964 case WXK_INSERT:
965 hotkey << wxT("Insert" );
966 break;
967 case WXK_DELETE:
968 hotkey << wxT("Delete" );
969 break;
970 case WXK_UP:
971 hotkey << wxT("Up" );
972 break;
973 case WXK_DOWN:
974 hotkey << wxT("Down" );
975 break;
976 case WXK_PAGEUP:
977 hotkey << wxT("Page_Up" );
978 break;
979 case WXK_PAGEDOWN:
980 hotkey << wxT("Page_Down" );
981 break;
982 case WXK_LEFT:
983 hotkey << wxT("Left" );
984 break;
985 case WXK_RIGHT:
986 hotkey << wxT("Right" );
987 break;
988 case WXK_HOME:
989 hotkey << wxT("Home" );
990 break;
991 case WXK_END:
992 hotkey << wxT("End" );
993 break;
994 case WXK_RETURN:
995 hotkey << wxT("Return" );
996 break;
997 case WXK_BACK:
998 hotkey << wxT("BackSpace" );
999 break;
1000 case WXK_TAB:
1001 hotkey << wxT("Tab" );
1002 break;
1003 case WXK_ESCAPE:
1004 hotkey << wxT("Esc" );
1005 break;
1006 case WXK_SPACE:
1007 hotkey << wxT("space" );
1008 break;
1009 case WXK_MULTIPLY:
1010 hotkey << wxT("Multiply" );
1011 break;
1012 case WXK_ADD:
1013 hotkey << wxT("Add" );
1014 break;
1015 case WXK_SEPARATOR:
1016 hotkey << wxT("Separator" );
1017 break;
1018 case WXK_SUBTRACT:
1019 hotkey << wxT("Subtract" );
1020 break;
1021 case WXK_DECIMAL:
1022 hotkey << wxT("Decimal" );
1023 break;
1024 case WXK_DIVIDE:
1025 hotkey << wxT("Divide" );
1026 break;
1027 case WXK_CANCEL:
1028 hotkey << wxT("Cancel" );
1029 break;
1030 case WXK_CLEAR:
1031 hotkey << wxT("Clear" );
1032 break;
1033 case WXK_MENU:
1034 hotkey << wxT("Menu" );
1035 break;
1036 case WXK_PAUSE:
1037 hotkey << wxT("Pause" );
1038 break;
1039 case WXK_CAPITAL:
1040 hotkey << wxT("Capital" );
1041 break;
1042 case WXK_SELECT:
1043 hotkey << wxT("Select" );
1044 break;
1045 case WXK_PRINT:
1046 hotkey << wxT("Print" );
1047 break;
1048 case WXK_EXECUTE:
1049 hotkey << wxT("Execute" );
1050 break;
1051 case WXK_SNAPSHOT:
1052 hotkey << wxT("Snapshot" );
1053 break;
1054 case WXK_HELP:
1055 hotkey << wxT("Help" );
1056 break;
1057 case WXK_NUMLOCK:
1058 hotkey << wxT("Num_Lock" );
1059 break;
1060 case WXK_SCROLL:
1061 hotkey << wxT("Scroll_Lock" );
1062 break;
1063 case WXK_NUMPAD_INSERT:
1064 hotkey << wxT("KP_Insert" );
1065 break;
1066 case WXK_NUMPAD_DELETE:
1067 hotkey << wxT("KP_Delete" );
1068 break;
1069 case WXK_NUMPAD_SPACE:
1070 hotkey << wxT("KP_Space" );
1071 break;
1072 case WXK_NUMPAD_TAB:
1073 hotkey << wxT("KP_Tab" );
1074 break;
1075 case WXK_NUMPAD_ENTER:
1076 hotkey << wxT("KP_Enter" );
1077 break;
1078 case WXK_NUMPAD_F1: case WXK_NUMPAD_F2: case WXK_NUMPAD_F3:
1079 case WXK_NUMPAD_F4:
1080 hotkey += wxString::Format(wxT("KP_F%d"), code - WXK_NUMPAD_F1 + 1);
1081 break;
1082 case WXK_NUMPAD_HOME:
1083 hotkey << wxT("KP_Home" );
1084 break;
1085 case WXK_NUMPAD_LEFT:
1086 hotkey << wxT("KP_Left" );
1087 break;
1088 case WXK_NUMPAD_UP:
1089 hotkey << wxT("KP_Up" );
1090 break;
1091 case WXK_NUMPAD_RIGHT:
1092 hotkey << wxT("KP_Right" );
1093 break;
1094 case WXK_NUMPAD_DOWN:
1095 hotkey << wxT("KP_Down" );
1096 break;
1097 case WXK_NUMPAD_PAGEUP:
1098 hotkey << wxT("KP_Page_Up" );
1099 break;
1100 case WXK_NUMPAD_PAGEDOWN:
1101 hotkey << wxT("KP_Page_Down" );
1102 break;
1103 case WXK_NUMPAD_END:
1104 hotkey << wxT("KP_End" );
1105 break;
1106 case WXK_NUMPAD_BEGIN:
1107 hotkey << wxT("KP_Begin" );
1108 break;
1109 case WXK_NUMPAD_EQUAL:
1110 hotkey << wxT("KP_Equal" );
1111 break;
1112 case WXK_NUMPAD_MULTIPLY:
1113 hotkey << wxT("KP_Multiply" );
1114 break;
1115 case WXK_NUMPAD_ADD:
1116 hotkey << wxT("KP_Add" );
1117 break;
1118 case WXK_NUMPAD_SEPARATOR:
1119 hotkey << wxT("KP_Separator" );
1120 break;
1121 case WXK_NUMPAD_SUBTRACT:
1122 hotkey << wxT("KP_Subtract" );
1123 break;
1124 case WXK_NUMPAD_DECIMAL:
1125 hotkey << wxT("KP_Decimal" );
1126 break;
1127 case WXK_NUMPAD_DIVIDE:
1128 hotkey << wxT("KP_Divide" );
1129 break;
1130 case WXK_NUMPAD0: case WXK_NUMPAD1: case WXK_NUMPAD2:
1131 case WXK_NUMPAD3: case WXK_NUMPAD4: case WXK_NUMPAD5:
1132 case WXK_NUMPAD6: case WXK_NUMPAD7: case WXK_NUMPAD8: case WXK_NUMPAD9:
1133 hotkey += wxString::Format(wxT("KP_%d"), code - WXK_NUMPAD0);
1134 break;
1135 case WXK_WINDOWS_LEFT:
1136 hotkey << wxT("Super_L" );
1137 break;
1138 case WXK_WINDOWS_RIGHT:
1139 hotkey << wxT("Super_R" );
1140 break;
1141 case WXK_WINDOWS_MENU:
1142 hotkey << wxT("Menu" );
1143 break;
1144 case WXK_COMMAND:
1145 hotkey << wxT("Command" );
1146 break;
1147 /* These probably wouldn't work as there is no SpecialX in gdk/keynames.txt
1148 case WXK_SPECIAL1: case WXK_SPECIAL2: case WXK_SPECIAL3: case WXK_SPECIAL4:
1149 case WXK_SPECIAL5: case WXK_SPECIAL6: case WXK_SPECIAL7: case WXK_SPECIAL8:
1150 case WXK_SPECIAL9: case WXK_SPECIAL10: case WXK_SPECIAL11: case WXK_SPECIAL12:
1151 case WXK_SPECIAL13: case WXK_SPECIAL14: case WXK_SPECIAL15: case WXK_SPECIAL16:
1152 case WXK_SPECIAL17: case WXK_SPECIAL18: case WXK_SPECIAL19: case WXK_SPECIAL20:
1153 hotkey += wxString::Format(wxT("Special%d"), code - WXK_SPECIAL1 + 1);
1154 break;
1155 */
1156 // if there are any other keys wxAcceleratorEntry::Create() may
1157 // return, we should process them here
1158
1159 default:
1160 if ( code < 127 )
1161 {
1162 const wxString
1163 name = wxGTK_CONV_BACK_SYS(gdk_keyval_name((guint)code));
1164 if ( !name.empty() )
1165 {
1166 hotkey << name;
1167 break;
1168 }
1169 }
1170
1171 wxFAIL_MSG( wxT("unknown keyboard accel") );
1172 }
1173
1174 delete accel;
1175 }
1176
1177 return hotkey;
1178 }
1179
1180 static void
1181 wxGetGtkAccel(const wxMenuItem* item, guint* accel_key, GdkModifierType* accel_mods)
1182 {
1183 *accel_key = 0;
1184 const wxString string = GetGtkHotKey(*item);
1185 if (!string.empty())
1186 gtk_accelerator_parse(wxGTK_CONV_SYS(string), accel_key, accel_mods);
1187 else
1188 {
1189 GtkStockItem stock_item;
1190 const char* stockid = wxGetStockGtkID(item->GetId());
1191 if (stockid && gtk_stock_lookup(stockid, &stock_item))
1192 {
1193 *accel_key = stock_item.keyval;
1194 *accel_mods = stock_item.modifier;
1195 }
1196 }
1197 }
1198 #endif // wxUSE_ACCEL
1199
1200 const char *wxGetStockGtkID(wxWindowID id)
1201 {
1202 #define STOCKITEM(wx,gtk) \
1203 case wx: \
1204 return gtk;
1205
1206 #if GTK_CHECK_VERSION(2,6,0)
1207 #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
1208 #else
1209 #define STOCKITEM_26(wx,gtk)
1210 #endif
1211
1212 #if GTK_CHECK_VERSION(2,8,0)
1213 #define STOCKITEM_28(wx,gtk) STOCKITEM(wx,gtk)
1214 #else
1215 #define STOCKITEM_28(wx,gtk)
1216 #endif
1217
1218 #if GTK_CHECK_VERSION(2,10,0)
1219 #define STOCKITEM_210(wx,gtk) STOCKITEM(wx,gtk)
1220 #else
1221 #define STOCKITEM_210(wx,gtk)
1222 #endif
1223
1224
1225 switch (id)
1226 {
1227 STOCKITEM_26(wxID_ABOUT, GTK_STOCK_ABOUT)
1228 STOCKITEM(wxID_ADD, GTK_STOCK_ADD)
1229 STOCKITEM(wxID_APPLY, GTK_STOCK_APPLY)
1230 STOCKITEM(wxID_BACKWARD, GTK_STOCK_GO_BACK)
1231 STOCKITEM(wxID_BOLD, GTK_STOCK_BOLD)
1232 STOCKITEM(wxID_BOTTOM, GTK_STOCK_GOTO_BOTTOM)
1233 STOCKITEM(wxID_CANCEL, GTK_STOCK_CANCEL)
1234 STOCKITEM(wxID_CDROM, GTK_STOCK_CDROM)
1235 STOCKITEM(wxID_CLEAR, GTK_STOCK_CLEAR)
1236 STOCKITEM(wxID_CLOSE, GTK_STOCK_CLOSE)
1237 STOCKITEM(wxID_CONVERT, GTK_STOCK_CONVERT)
1238 STOCKITEM(wxID_COPY, GTK_STOCK_COPY)
1239 STOCKITEM(wxID_CUT, GTK_STOCK_CUT)
1240 STOCKITEM(wxID_DELETE, GTK_STOCK_DELETE)
1241 STOCKITEM(wxID_DOWN, GTK_STOCK_GO_DOWN)
1242 STOCKITEM_26(wxID_EDIT, GTK_STOCK_EDIT)
1243 STOCKITEM(wxID_EXECUTE, GTK_STOCK_EXECUTE)
1244 STOCKITEM(wxID_EXIT, GTK_STOCK_QUIT)
1245 STOCKITEM_26(wxID_FILE, GTK_STOCK_FILE)
1246 STOCKITEM(wxID_FIND, GTK_STOCK_FIND)
1247 STOCKITEM(wxID_FIRST, GTK_STOCK_GOTO_FIRST)
1248 STOCKITEM(wxID_FLOPPY, GTK_STOCK_FLOPPY)
1249 STOCKITEM(wxID_FORWARD, GTK_STOCK_GO_FORWARD)
1250 STOCKITEM(wxID_HARDDISK, GTK_STOCK_HARDDISK)
1251 STOCKITEM(wxID_HELP, GTK_STOCK_HELP)
1252 STOCKITEM(wxID_HOME, GTK_STOCK_HOME)
1253 STOCKITEM(wxID_INDENT, GTK_STOCK_INDENT)
1254 STOCKITEM(wxID_INDEX, GTK_STOCK_INDEX)
1255 STOCKITEM_28(wxID_INFO, GTK_STOCK_INFO)
1256 STOCKITEM(wxID_ITALIC, GTK_STOCK_ITALIC)
1257 STOCKITEM(wxID_JUMP_TO, GTK_STOCK_JUMP_TO)
1258 STOCKITEM(wxID_JUSTIFY_CENTER, GTK_STOCK_JUSTIFY_CENTER)
1259 STOCKITEM(wxID_JUSTIFY_FILL, GTK_STOCK_JUSTIFY_FILL)
1260 STOCKITEM(wxID_JUSTIFY_LEFT, GTK_STOCK_JUSTIFY_LEFT)
1261 STOCKITEM(wxID_JUSTIFY_RIGHT, GTK_STOCK_JUSTIFY_RIGHT)
1262 STOCKITEM(wxID_LAST, GTK_STOCK_GOTO_LAST)
1263 STOCKITEM(wxID_NETWORK, GTK_STOCK_NETWORK)
1264 STOCKITEM(wxID_NEW, GTK_STOCK_NEW)
1265 STOCKITEM(wxID_NO, GTK_STOCK_NO)
1266 STOCKITEM(wxID_OK, GTK_STOCK_OK)
1267 STOCKITEM(wxID_OPEN, GTK_STOCK_OPEN)
1268 STOCKITEM(wxID_PASTE, GTK_STOCK_PASTE)
1269 STOCKITEM(wxID_PREFERENCES, GTK_STOCK_PREFERENCES)
1270 STOCKITEM(wxID_PREVIEW, GTK_STOCK_PRINT_PREVIEW)
1271 STOCKITEM(wxID_PRINT, GTK_STOCK_PRINT)
1272 STOCKITEM(wxID_PROPERTIES, GTK_STOCK_PROPERTIES)
1273 STOCKITEM(wxID_REDO, GTK_STOCK_REDO)
1274 STOCKITEM(wxID_REFRESH, GTK_STOCK_REFRESH)
1275 STOCKITEM(wxID_REMOVE, GTK_STOCK_REMOVE)
1276 STOCKITEM(wxID_REPLACE, GTK_STOCK_FIND_AND_REPLACE)
1277 STOCKITEM(wxID_REVERT_TO_SAVED, GTK_STOCK_REVERT_TO_SAVED)
1278 STOCKITEM(wxID_SAVE, GTK_STOCK_SAVE)
1279 STOCKITEM(wxID_SAVEAS, GTK_STOCK_SAVE_AS)
1280 STOCKITEM_210(wxID_SELECTALL, GTK_STOCK_SELECT_ALL)
1281 STOCKITEM(wxID_SELECT_COLOR, GTK_STOCK_SELECT_COLOR)
1282 STOCKITEM(wxID_SELECT_FONT, GTK_STOCK_SELECT_FONT)
1283 STOCKITEM(wxID_SORT_ASCENDING, GTK_STOCK_SORT_ASCENDING)
1284 STOCKITEM(wxID_SORT_DESCENDING, GTK_STOCK_SORT_DESCENDING)
1285 STOCKITEM(wxID_SPELL_CHECK, GTK_STOCK_SPELL_CHECK)
1286 STOCKITEM(wxID_STOP, GTK_STOCK_STOP)
1287 STOCKITEM(wxID_STRIKETHROUGH, GTK_STOCK_STRIKETHROUGH)
1288 STOCKITEM(wxID_TOP, GTK_STOCK_GOTO_TOP)
1289 STOCKITEM(wxID_UNDELETE, GTK_STOCK_UNDELETE)
1290 STOCKITEM(wxID_UNDERLINE, GTK_STOCK_UNDERLINE)
1291 STOCKITEM(wxID_UNDO, GTK_STOCK_UNDO)
1292 STOCKITEM(wxID_UNINDENT, GTK_STOCK_UNINDENT)
1293 STOCKITEM(wxID_UP, GTK_STOCK_GO_UP)
1294 STOCKITEM(wxID_YES, GTK_STOCK_YES)
1295 STOCKITEM(wxID_ZOOM_100, GTK_STOCK_ZOOM_100)
1296 STOCKITEM(wxID_ZOOM_FIT, GTK_STOCK_ZOOM_FIT)
1297 STOCKITEM(wxID_ZOOM_IN, GTK_STOCK_ZOOM_IN)
1298 STOCKITEM(wxID_ZOOM_OUT, GTK_STOCK_ZOOM_OUT)
1299
1300 default:
1301 break;
1302 };
1303
1304 #undef STOCKITEM
1305
1306 return NULL;
1307 }
1308
1309 #endif // wxUSE_MENUS