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