]> git.saurik.com Git - wxWidgets.git/blob - src/gtk/menu.cpp
projects / wxWidgets.git / blob
? search:


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