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