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