Removed a misleading comment
[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
29 #ifdef __WXGTK20__
30 #include <gdk/gdktypes.h>
31 #endif
32
33 // FIXME: is this right? somehow I don't think so (VZ)
34
35 #define gtk_accel_group_attach(g, o) gtk_window_add_accel_group((o), (g))
36 //#define gtk_accel_group_detach(g, o) gtk_window_remove_accel_group((o), (g))
37 //#define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
38
39 #define ACCEL_OBJECT GtkWindow
40 #define ACCEL_OBJECTS(a) (a)->acceleratables
41 #define ACCEL_OBJ_CAST(obj) ((GtkWindow*) obj)
42
43 // we use normal item but with a special id for the menu title
44 static const int wxGTK_TITLE_ID = -3;
45
46 //-----------------------------------------------------------------------------
47 // idle system
48 //-----------------------------------------------------------------------------
49
50 #if wxUSE_ACCEL
51 static wxString GetGtkHotKey( const wxMenuItem& item );
52 #endif
53
54 //-----------------------------------------------------------------------------
55 // idle system
56 //-----------------------------------------------------------------------------
57
58 static wxString wxReplaceUnderscore( const wxString& title )
59 {
60 // GTK 1.2 wants to have "_" instead of "&" for accelerators
61 wxString str;
62
63 for ( wxString::const_iterator pc = title.begin(); pc != title.end(); ++pc )
64 {
65 if ((*pc == wxT('&')) && (pc+1 != title.end()) && (*(pc+1) == wxT('&')))
66 {
67 // "&" is doubled to indicate "&" instead of accelerator
68 ++pc;
69 str << wxT('&');
70 }
71 else if (*pc == wxT('&'))
72 {
73 str << wxT('_');
74 }
75 else
76 {
77 if ( *pc == wxT('_') )
78 {
79 // underscores must be doubled to prevent them from being
80 // interpreted as accelerator character prefix by GTK
81 str << *pc;
82 }
83
84 str << *pc;
85 }
86 }
87
88 // wxPrintf( wxT("before %s after %s\n"), title.c_str(), str.c_str() );
89
90 return str;
91 }
92
93 static wxString wxConvertFromGTKToWXLabel(const wxString& gtkLabel)
94 {
95 wxString label;
96 for ( const wxChar *pc = gtkLabel.c_str(); *pc; pc++ )
97 {
98 // '_' is the escape character for GTK+.
99
100 if ( *pc == wxT('_') && *(pc+1) == wxT('_'))
101 {
102 // An underscore was escaped.
103 label += wxT('_');
104 pc++;
105 }
106 else if ( *pc == wxT('_') )
107 {
108 // Convert GTK+ hotkey symbol to wxWidgets/Windows standard
109 label += wxT('&');
110 }
111 else if ( *pc == wxT('&') )
112 {
113 // Double the ampersand to escape it as far as wxWidgets is concerned
114 label += wxT("&&");
115 }
116 else
117 {
118 // don't remove ampersands '&' since if we have them in the menu title
119 // it means that they were doubled to indicate "&" instead of accelerator
120 label += *pc;
121 }
122 }
123
124 return label;
125 }
126
127 //-----------------------------------------------------------------------------
128 // activate message from GTK
129 //-----------------------------------------------------------------------------
130
131 static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
132 {
133 event.SetEventObject( menu );
134
135 wxEvtHandler* handler = menu->GetEventHandler();
136 if (handler && handler->ProcessEvent(event))
137 return;
138
139 wxWindow *win = menu->GetInvokingWindow();
140 if (win)
141 win->GetEventHandler()->ProcessEvent( event );
142 }
143
144 extern "C" {
145
146 static void gtk_menu_open_callback( GtkWidget *widget, wxMenu *menu )
147 {
148 wxMenuEvent event(wxEVT_MENU_OPEN, -1, menu);
149
150 DoCommonMenuCallbackCode(menu, event);
151 }
152
153 static void gtk_menu_close_callback( GtkWidget *widget, wxMenuBar *menubar )
154 {
155 if ( !menubar->GetMenuCount() )
156 {
157 // if menubar is empty we can't call GetMenu(0) below
158 return;
159 }
160
161 wxMenuEvent event( wxEVT_MENU_CLOSE, -1, NULL );
162
163 DoCommonMenuCallbackCode(menubar->GetMenu(0), event);
164 }
165
166 }
167
168 //-----------------------------------------------------------------------------
169 // wxMenuBar
170 //-----------------------------------------------------------------------------
171
172 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
173
174 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
175 {
176 m_style = style;
177 m_invokingWindow = NULL;
178
179 if (!PreCreation( NULL, wxDefaultPosition, wxDefaultSize ) ||
180 !CreateBase( NULL, -1, wxDefaultPosition, wxDefaultSize, style, wxDefaultValidator, wxT("menubar") ))
181 {
182 wxFAIL_MSG( wxT("wxMenuBar creation failed") );
183 return;
184 }
185
186 m_menubar = gtk_menu_bar_new();
187
188 if (style & wxMB_DOCKABLE)
189 {
190 m_widget = gtk_handle_box_new();
191 gtk_container_add(GTK_CONTAINER(m_widget), m_menubar);
192 gtk_widget_show(m_menubar);
193 }
194 else
195 {
196 m_widget = m_menubar;
197 }
198
199 PostCreation();
200
201 ApplyWidgetStyle();
202
203 for (size_t i = 0; i < n; ++i )
204 Append(menus[i], titles[i]);
205
206 // VZ: for some reason connecting to menus "deactivate" doesn't work (we
207 // don't get it when the menu is dismissed by clicking outside the
208 // toolbar) so we connect to the global one, even if it means that we
209 // can't pass the menu which was closed in wxMenuEvent object
210 g_signal_connect (m_menubar, "deactivate",
211 G_CALLBACK (gtk_menu_close_callback), this);
212
213 }
214
215 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style)
216 {
217 Init(n, menus, titles, style);
218 }
219
220 wxMenuBar::wxMenuBar(long style)
221 {
222 Init(0, NULL, NULL, style);
223 }
224
225 wxMenuBar::wxMenuBar()
226 {
227 Init(0, NULL, NULL, 0);
228 }
229
230 wxMenuBar::~wxMenuBar()
231 {
232 }
233
234 static void wxMenubarUnsetInvokingWindow( wxMenu *menu, wxWindow *win )
235 {
236 menu->SetInvokingWindow( (wxWindow*) NULL );
237
238 wxWindow *top_frame = win;
239 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
240 top_frame = top_frame->GetParent();
241
242 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
243 while (node)
244 {
245 wxMenuItem *menuitem = node->GetData();
246 if (menuitem->IsSubMenu())
247 wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu(), win );
248 node = node->GetNext();
249 }
250 }
251
252 static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win )
253 {
254 menu->SetInvokingWindow( win );
255
256 wxWindow *top_frame = win;
257 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
258 top_frame = top_frame->GetParent();
259
260 // support for native hot keys
261 ACCEL_OBJECT *obj = ACCEL_OBJ_CAST(top_frame->m_widget);
262 if ( !g_slist_find( ACCEL_OBJECTS(menu->m_accel), obj ) )
263 gtk_accel_group_attach( menu->m_accel, obj );
264
265 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
266 while (node)
267 {
268 wxMenuItem *menuitem = node->GetData();
269 if (menuitem->IsSubMenu())
270 wxMenubarSetInvokingWindow( menuitem->GetSubMenu(), win );
271 node = node->GetNext();
272 }
273 }
274
275 void wxMenuBar::SetInvokingWindow( wxWindow *win )
276 {
277 m_invokingWindow = win;
278 wxWindow *top_frame = win;
279 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
280 top_frame = top_frame->GetParent();
281
282 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
283 while (node)
284 {
285 wxMenu *menu = node->GetData();
286 wxMenubarSetInvokingWindow( menu, win );
287 node = node->GetNext();
288 }
289 }
290
291 void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir)
292 {
293 if ( dir == wxLayout_Default )
294 {
295 const wxWindow *const frame = GetFrame();
296 if ( frame )
297 {
298 // inherit layout from frame.
299 dir = frame->GetLayoutDirection();
300 }
301 else // use global layout
302 {
303 dir = wxTheApp->GetLayoutDirection();
304 }
305 }
306
307 if ( dir == wxLayout_Default )
308 return;
309
310 GTKSetLayout(m_menubar, dir);
311
312 // also set the layout of all menus we already have (new ones will inherit
313 // the current layout)
314 for ( wxMenuList::compatibility_iterator node = m_menus.GetFirst();
315 node;
316 node = node->GetNext() )
317 {
318 wxMenu *const menu = node->GetData();
319 menu->SetLayoutDirection(dir);
320 }
321 }
322
323 wxLayoutDirection wxMenuBar::GetLayoutDirection() const
324 {
325 return GTKGetLayout(m_menubar);
326 }
327
328 void wxMenuBar::Attach(wxFrame *frame)
329 {
330 wxMenuBarBase::Attach(frame);
331
332 SetLayoutDirection(wxLayout_Default);
333 }
334
335 void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
336 {
337 m_invokingWindow = (wxWindow*) NULL;
338 wxWindow *top_frame = win;
339 while (top_frame->GetParent() && !(top_frame->IsTopLevel()))
340 top_frame = top_frame->GetParent();
341
342 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
343 while (node)
344 {
345 wxMenu *menu = node->GetData();
346 wxMenubarUnsetInvokingWindow( menu, win );
347 node = node->GetNext();
348 }
349 }
350
351 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
352 {
353 if ( !wxMenuBarBase::Append( menu, title ) )
354 return false;
355
356 return GtkAppend(menu, title);
357 }
358
359 bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
360 {
361 wxString str( wxReplaceUnderscore( title ) );
362
363 // This doesn't have much effect right now.
364 menu->SetTitle( str );
365
366 // The "m_owner" is the "menu item"
367 menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
368 menu->SetLayoutDirection(GetLayoutDirection());
369
370 gtk_widget_show( menu->m_owner );
371
372 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
373
374 if (pos == -1)
375 gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar), menu->m_owner );
376 else
377 gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
378
379 g_signal_connect (menu->m_owner, "activate",
380 G_CALLBACK (gtk_menu_open_callback),
381 menu);
382
383 // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
384 // addings menu later on.
385 if (m_invokingWindow)
386 {
387 wxMenubarSetInvokingWindow( menu, m_invokingWindow );
388
389 // OPTIMISE ME: we should probably cache this, or pass it
390 // directly, but for now this is a minimal
391 // change to validate the new dynamic sizing.
392 // see (and refactor :) similar code in Remove
393 // below.
394
395 wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
396
397 if( frame )
398 frame->UpdateMenuBarSize();
399 }
400
401 return true;
402 }
403
404 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
405 {
406 if ( !wxMenuBarBase::Insert(pos, menu, title) )
407 return false;
408
409 // TODO
410
411 if ( !GtkAppend(menu, title, (int)pos) )
412 return false;
413
414 return true;
415 }
416
417 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
418 {
419 // remove the old item and insert a new one
420 wxMenu *menuOld = Remove(pos);
421 if ( menuOld && !Insert(pos, menu, title) )
422 {
423 return (wxMenu*) NULL;
424 }
425
426 // either Insert() succeeded or Remove() failed and menuOld is NULL
427 return menuOld;
428 }
429
430 wxMenu *wxMenuBar::Remove(size_t pos)
431 {
432 wxMenu *menu = wxMenuBarBase::Remove(pos);
433 if ( !menu )
434 return (wxMenu*) NULL;
435
436 gtk_menu_item_remove_submenu( GTK_MENU_ITEM(menu->m_owner) );
437 gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
438
439 gtk_widget_destroy( menu->m_owner );
440 menu->m_owner = NULL;
441
442 if (m_invokingWindow)
443 {
444 // OPTIMISE ME: see comment in GtkAppend
445 wxFrame *frame = wxDynamicCast( m_invokingWindow, wxFrame );
446
447 if( frame )
448 frame->UpdateMenuBarSize();
449 }
450
451 return menu;
452 }
453
454 static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
455 {
456 if (wxMenuItem::GetLabelText(wxConvertFromGTKToWXLabel(menu->GetTitle())) == wxMenuItem::GetLabelText(menuString))
457 {
458 int res = menu->FindItem( itemString );
459 if (res != wxNOT_FOUND)
460 return res;
461 }
462
463 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
464 while (node)
465 {
466 wxMenuItem *item = node->GetData();
467 if (item->IsSubMenu())
468 return FindMenuItemRecursive(item->GetSubMenu(), menuString, itemString);
469
470 node = node->GetNext();
471 }
472
473 return wxNOT_FOUND;
474 }
475
476 int wxMenuBar::FindMenuItem( const wxString &menuString, const wxString &itemString ) const
477 {
478 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
479 while (node)
480 {
481 wxMenu *menu = node->GetData();
482 int res = FindMenuItemRecursive( menu, menuString, itemString);
483 if (res != -1)
484 return res;
485 node = node->GetNext();
486 }
487
488 return wxNOT_FOUND;
489 }
490
491 // Find a wxMenuItem using its id. Recurses down into sub-menus
492 static wxMenuItem* FindMenuItemByIdRecursive(const wxMenu* menu, int id)
493 {
494 wxMenuItem* result = menu->FindChildItem(id);
495
496 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
497 while ( node && result == NULL )
498 {
499 wxMenuItem *item = node->GetData();
500 if (item->IsSubMenu())
501 {
502 result = FindMenuItemByIdRecursive( item->GetSubMenu(), id );
503 }
504 node = node->GetNext();
505 }
506
507 return result;
508 }
509
510 wxMenuItem* wxMenuBar::FindItem( int id, wxMenu **menuForItem ) const
511 {
512 wxMenuItem* result = 0;
513 wxMenuList::compatibility_iterator node = m_menus.GetFirst();
514 while (node && result == 0)
515 {
516 wxMenu *menu = node->GetData();
517 result = FindMenuItemByIdRecursive( menu, id );
518 node = node->GetNext();
519 }
520
521 if ( menuForItem )
522 {
523 *menuForItem = result ? result->GetMenu() : (wxMenu *)NULL;
524 }
525
526 return result;
527 }
528
529 void wxMenuBar::EnableTop( size_t pos, bool flag )
530 {
531 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
532
533 wxCHECK_RET( node, wxT("menu not found") );
534
535 wxMenu* menu = node->GetData();
536
537 if (menu->m_owner)
538 gtk_widget_set_sensitive( menu->m_owner, flag );
539 }
540
541 wxString wxMenuBar::GetMenuLabel( size_t pos ) const
542 {
543 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
544
545 wxCHECK_MSG( node, wxT("invalid"), wxT("menu not found") );
546
547 wxMenu* menu = node->GetData();
548
549 return wxConvertFromGTKToWXLabel(menu->GetTitle());
550 }
551
552 void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
553 {
554 wxMenuList::compatibility_iterator node = m_menus.Item( pos );
555
556 wxCHECK_RET( node, wxT("menu not found") );
557
558 wxMenu* menu = node->GetData();
559
560 const wxString str( wxReplaceUnderscore( label ) );
561
562 menu->SetTitle( str );
563
564 if (menu->m_owner)
565 gtk_label_set_text_with_mnemonic( GTK_LABEL( GTK_BIN(menu->m_owner)->child), wxGTK_CONV(str) );
566 }
567
568 //-----------------------------------------------------------------------------
569 // "activate"
570 //-----------------------------------------------------------------------------
571
572 extern "C" {
573 static void gtk_menu_clicked_callback( GtkWidget *widget, wxMenu *menu )
574 {
575 int id = menu->FindMenuIdByMenuItem(widget);
576
577 /* should find it for normal (not popup) menu */
578 wxASSERT_MSG( (id != -1) || (menu->GetInvokingWindow() != NULL),
579 _T("menu item not found in gtk_menu_clicked_callback") );
580
581 if (!menu->IsEnabled(id))
582 return;
583
584 wxMenuItem* item = menu->FindChildItem( id );
585 wxCHECK_RET( item, wxT("error in menu item callback") );
586
587 if ( item->GetId() == wxGTK_TITLE_ID )
588 {
589 // ignore events from the menu title
590 return;
591 }
592
593 if (item->IsCheckable())
594 {
595 bool isReallyChecked = item->IsChecked(),
596 isInternallyChecked = item->wxMenuItemBase::IsChecked();
597
598 // ensure that the internal state is always consistent with what is
599 // shown on the screen
600 item->wxMenuItemBase::Check(isReallyChecked);
601
602 // we must not report the events for the radio button going up nor the
603 // events resulting from the calls to wxMenuItem::Check()
604 if ( (item->GetKind() == wxITEM_RADIO && !isReallyChecked) ||
605 (isInternallyChecked == isReallyChecked) )
606 {
607 return;
608 }
609 }
610
611
612 // Is this menu on a menubar? (possibly nested)
613 wxFrame* frame = NULL;
614 if(menu->IsAttached())
615 frame = menu->GetMenuBar()->GetFrame();
616
617 // FIXME: why do we have to call wxFrame::GetEventHandler() directly here?
618 // normally wxMenu::SendEvent() should be enough, if it doesn't work
619 // in wxGTK then we have a bug in wxMenu::GetInvokingWindow() which
620 // should be fixed instead of working around it here...
621 if (frame)
622 {
623 // If it is attached then let the frame send the event.
624 // Don't call frame->ProcessCommand(id) because it toggles
625 // checkable items and we've already done that above.
626 wxCommandEvent commandEvent(wxEVT_COMMAND_MENU_SELECTED, id);
627 commandEvent.SetEventObject(frame);
628 if (item->IsCheckable())
629 commandEvent.SetInt(item->IsChecked());
630 commandEvent.SetEventObject(menu);
631
632 frame->GetEventHandler()->ProcessEvent(commandEvent);
633 }
634 else
635 {
636 // otherwise let the menu have it
637 menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
638 }
639 }
640 }
641
642 //-----------------------------------------------------------------------------
643 // "select"
644 //-----------------------------------------------------------------------------
645
646 extern "C" {
647 static void gtk_menu_hilight_callback( GtkWidget *widget, wxMenu *menu )
648 {
649 int id = menu->FindMenuIdByMenuItem(widget);
650
651 wxASSERT( id != -1 ); // should find it!
652
653 if (!menu->IsEnabled(id))
654 return;
655
656 wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, id );
657 event.SetEventObject( menu );
658
659 wxEvtHandler* handler = menu->GetEventHandler();
660 if (handler && handler->ProcessEvent(event))
661 return;
662
663 wxWindow *win = menu->GetInvokingWindow();
664 if (win) win->GetEventHandler()->ProcessEvent( event );
665 }
666 }
667
668 //-----------------------------------------------------------------------------
669 // "deselect"
670 //-----------------------------------------------------------------------------
671
672 extern "C" {
673 static void gtk_menu_nolight_callback( GtkWidget *widget, wxMenu *menu )
674 {
675 int id = menu->FindMenuIdByMenuItem(widget);
676
677 wxASSERT( id != -1 ); // should find it!
678
679 if (!menu->IsEnabled(id))
680 return;
681
682 wxMenuEvent event( wxEVT_MENU_HIGHLIGHT, -1 );
683 event.SetEventObject( menu );
684
685 wxEvtHandler* handler = menu->GetEventHandler();
686 if (handler && handler->ProcessEvent(event))
687 return;
688
689 wxWindow *win = menu->GetInvokingWindow();
690 if (win)
691 win->GetEventHandler()->ProcessEvent( event );
692 }
693 }
694
695 //-----------------------------------------------------------------------------
696 // wxMenuItem
697 //-----------------------------------------------------------------------------
698
699 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
700
701 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
702 int id,
703 const wxString& name,
704 const wxString& help,
705 wxItemKind kind,
706 wxMenu *subMenu)
707 {
708 return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
709 }
710
711 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
712 int id,
713 const wxString& text,
714 const wxString& help,
715 wxItemKind kind,
716 wxMenu *subMenu)
717 : wxMenuItemBase(parentMenu, id, text, help, kind, subMenu)
718 {
719 Init(text);
720 }
721
722 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
723 int id,
724 const wxString& text,
725 const wxString& help,
726 bool isCheckable,
727 wxMenu *subMenu)
728 : wxMenuItemBase(parentMenu, id, text, help,
729 isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
730 {
731 Init(text);
732 }
733
734 void wxMenuItem::Init(const wxString& text)
735 {
736 m_labelWidget = (GtkWidget *) NULL;
737 m_menuItem = (GtkWidget *) NULL;
738
739 DoSetText(text);
740 }
741
742 wxMenuItem::~wxMenuItem()
743 {
744 // don't delete menu items, the menus take care of that
745 }
746
747 // return the menu item text without any menu accels
748 /* static */
749
750 wxString wxMenuItemBase::GetLabelText(const wxString& text)
751 {
752 // The argument to this function will now always be in wxWidgets standard label
753 // format, not GTK+ format, so we do what the other ports do.
754
755 return wxStripMenuCodes(text);
756
757 #if 0
758 wxString label;
759
760 for ( const wxChar *pc = text.c_str(); *pc; pc++ )
761 {
762 if ( *pc == wxT('\t'))
763 break;
764
765 if ( *pc == wxT('_') )
766 {
767 // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"
768 pc++;
769 label += *pc;
770 continue;
771 }
772
773 if ( *pc == wxT('\\') )
774 {
775 // GTK 2.0 escapes "xxx/xxx" to "xxx\/xxx"
776 pc++;
777 label += *pc;
778 continue;
779 }
780
781 if ( (*pc == wxT('&')) && (*(pc+1) != wxT('&')) )
782 {
783 // wxMSW escapes "&"
784 // "&" is doubled to indicate "&" instead of accelerator
785 continue;
786 }
787
788 label += *pc;
789 }
790
791 // wxPrintf( wxT("GetLabelText(): text %s label %s\n"), text.c_str(), label.c_str() );
792
793 return label;
794 #endif
795 }
796
797 wxString wxMenuItem::GetItemLabel() const
798 {
799 return wxConvertFromGTKToWXLabel(m_text);
800 }
801
802 void wxMenuItem::SetItemLabel( const wxString& str )
803 {
804 // cache some data which must be used later
805 bool isstock = wxIsStockID(GetId());
806 const char *stockid = NULL;
807 if (isstock)
808 stockid = wxGetStockGtkID(GetId());
809
810 // Some optimization to avoid flicker
811 wxString oldLabel = m_text;
812 oldLabel = wxStripMenuCodes(oldLabel);
813 oldLabel.Replace(wxT("_"), wxT(""));
814 wxString label1 = wxStripMenuCodes(str);
815 wxString oldhotkey = GetHotKey(); // Store the old hotkey in Ctrl-foo format
816 wxCharBuffer oldbuf = wxGTK_CONV_SYS( GetGtkHotKey(*this) ); // and as <control>foo
817
818 DoSetText(str);
819
820 if (oldLabel == label1 &&
821 oldhotkey == GetHotKey()) // Make sure we can change a hotkey even if the label is unaltered
822 return;
823
824 if (m_menuItem)
825 {
826 GtkLabel *label;
827 if (m_labelWidget)
828 label = (GtkLabel*) m_labelWidget;
829 else
830 label = GTK_LABEL( GTK_BIN(m_menuItem)->child );
831
832 // stock menu items can have empty labels:
833 wxString text = m_text;
834 if (text.IsEmpty() && !IsSeparator())
835 {
836 wxASSERT_MSG(isstock, wxT("A non-stock menu item with an empty label?"));
837 text = wxGetStockLabel(GetId());
838
839 // need & => _ conversion
840 text = GTKProcessMenuItemLabel(text, NULL);
841 }
842
843 gtk_label_set_text_with_mnemonic( GTK_LABEL(label), wxGTK_CONV_SYS(text) );
844 }
845
846 // remove old accelerator from our parent's accelerator group, if present
847 guint accel_key;
848 GdkModifierType accel_mods;
849 if (oldbuf[(size_t)0] != '\0')
850 {
851 gtk_accelerator_parse( (const char*) oldbuf, &accel_key, &accel_mods);
852 if (accel_key != 0)
853 {
854 gtk_widget_remove_accelerator(m_menuItem,
855 m_parentMenu->m_accel,
856 accel_key,
857 accel_mods );
858 }
859 }
860 else if (isstock)
861 {
862 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
863 if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
864 gtk_widget_remove_accelerator( m_menuItem,
865 m_parentMenu->m_accel,
866 accel_key,
867 accel_mods );
868 }
869
870 // add new accelerator to our parent's accelerator group
871 wxCharBuffer buf = wxGTK_CONV_SYS( GetGtkHotKey(*this) );
872 if (buf[(size_t)0] != '\0')
873 {
874 gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
875 if (accel_key != 0)
876 {
877 gtk_widget_add_accelerator( m_menuItem,
878 "activate",
879 m_parentMenu->m_accel,
880 accel_key,
881 accel_mods,
882 GTK_ACCEL_VISIBLE);
883 }
884 }
885 else if (isstock)
886 {
887 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
888 if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
889 gtk_widget_remove_accelerator( m_menuItem,
890 m_parentMenu->m_accel,
891 accel_key,
892 accel_mods );
893 }
894 }
895
896 // NOTE: this function is different from the similar functions GTKProcessMnemonics()
897 // implemented in control.cpp and from wxMenuItemBase::GetLabelText...
898 // so there's no real code duplication
899 wxString wxMenuItem::GTKProcessMenuItemLabel(const wxString& str, wxString *hotKey)
900 {
901 wxString text;
902
903 // '\t' is the deliminator indicating a hot key
904 wxString::const_iterator pc = str.begin();
905 while ( pc != str.end() && *pc != wxT('\t') )
906 {
907 if (*pc == wxT('&'))
908 {
909 wxString::const_iterator next = pc + 1;
910 if (next != str.end() && *next == wxT('&'))
911 {
912 // "&" is doubled to indicate "&" instead of accelerator
913 ++pc;
914 text << wxT('&');
915 }
916 else
917 {
918 text << wxT('_');
919 }
920 }
921 else if ( *pc == wxT('_') ) // escape underscores
922 {
923 text << wxT("__");
924 }
925 else
926 {
927 text << *pc;
928 }
929 ++pc;
930 }
931
932 if (hotKey)
933 {
934 hotKey->Empty();
935 if(*pc == wxT('\t'))
936 {
937 pc++;
938 hotKey->assign(pc, str.end());
939 }
940 }
941
942 return text;
943 }
944
945 // it's valid for this function to be called even if m_menuItem == NULL
946 void wxMenuItem::DoSetText( const wxString& str )
947 {
948 m_text.Empty();
949 m_text = GTKProcessMenuItemLabel(str, &m_hotKey);
950 }
951
952 #if wxUSE_ACCEL
953
954 wxAcceleratorEntry *wxMenuItem::GetAccel() const
955 {
956 if ( !GetHotKey() )
957 {
958 // nothing
959 return NULL;
960 }
961
962 // accelerator parsing code looks for them after a TAB, so insert a dummy
963 // one here
964 wxString label;
965 label << wxT('\t') << GetHotKey();
966
967 return wxAcceleratorEntry::Create(label);
968 }
969
970 #endif // wxUSE_ACCEL
971
972 void wxMenuItem::Check( bool check )
973 {
974 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
975
976 if (check == m_isChecked)
977 return;
978
979 wxMenuItemBase::Check( check );
980
981 switch ( GetKind() )
982 {
983 case wxITEM_CHECK:
984 case wxITEM_RADIO:
985 gtk_check_menu_item_set_active( (GtkCheckMenuItem*)m_menuItem, (gint)check );
986 break;
987
988 default:
989 wxFAIL_MSG( _T("can't check this item") );
990 }
991 }
992
993 void wxMenuItem::Enable( bool enable )
994 {
995 wxCHECK_RET( m_menuItem, wxT("invalid menu item") );
996
997 gtk_widget_set_sensitive( m_menuItem, enable );
998 wxMenuItemBase::Enable( enable );
999 }
1000
1001 bool wxMenuItem::IsChecked() const
1002 {
1003 wxCHECK_MSG( m_menuItem, false, wxT("invalid menu item") );
1004
1005 wxCHECK_MSG( IsCheckable(), false,
1006 wxT("can't get state of uncheckable item!") );
1007
1008 return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
1009 }
1010
1011 //-----------------------------------------------------------------------------
1012 // wxMenu
1013 //-----------------------------------------------------------------------------
1014
1015 IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
1016
1017 void wxMenu::Init()
1018 {
1019 m_accel = gtk_accel_group_new();
1020 m_menu = gtk_menu_new();
1021 // NB: keep reference to the menu so that it is not destroyed behind
1022 // our back by GTK+ e.g. when it is removed from menubar:
1023 gtk_widget_ref(m_menu);
1024
1025 m_owner = (GtkWidget*) NULL;
1026
1027 // Tearoffs are entries, just like separators. So if we want this
1028 // menu to be a tear-off one, we just append a tearoff entry
1029 // immediately.
1030 if ( m_style & wxMENU_TEAROFF )
1031 {
1032 GtkWidget *tearoff = gtk_tearoff_menu_item_new();
1033
1034 gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
1035 }
1036
1037 m_prevRadio = NULL;
1038
1039 // append the title as the very first entry if we have it
1040 if ( !m_title.empty() )
1041 {
1042 Append(wxGTK_TITLE_ID, m_title);
1043 AppendSeparator();
1044 }
1045 }
1046
1047 wxMenu::~wxMenu()
1048 {
1049 WX_CLEAR_LIST(wxMenuItemList, m_items);
1050
1051 if ( GTK_IS_WIDGET( m_menu ))
1052 {
1053 // see wxMenu::Init
1054 gtk_widget_unref( m_menu );
1055 g_object_unref( m_accel );
1056
1057 // if the menu is inserted in another menu at this time, there was
1058 // one more reference to it:
1059 if ( m_owner )
1060 gtk_widget_destroy( m_menu );
1061 }
1062 }
1063
1064 void wxMenu::SetLayoutDirection(const wxLayoutDirection dir)
1065 {
1066 if ( m_owner )
1067 wxWindow::GTKSetLayout(m_owner, dir);
1068 //else: will be called later by wxMenuBar again
1069 }
1070
1071 wxLayoutDirection wxMenu::GetLayoutDirection() const
1072 {
1073 return wxWindow::GTKGetLayout(m_owner);
1074 }
1075
1076 bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
1077 {
1078 GtkWidget *menuItem;
1079
1080 // cache some data used later
1081 wxString text = mitem->wxMenuItemBase::GetItemLabel();
1082 int id = mitem->GetId();
1083 bool isstock = wxIsStockID(id);
1084 const char *stockid = NULL;
1085 if (isstock)
1086 stockid = wxGetStockGtkID(mitem->GetId());
1087
1088 // stock menu items can have an empty label
1089 if (text.IsEmpty() && !mitem->IsSeparator())
1090 {
1091 wxASSERT_MSG(isstock, wxT("A non-stock menu item with an empty label?"));
1092 text = wxGetStockLabel(id);
1093
1094 // need & => _ conversion
1095 text = wxMenuItem::GTKProcessMenuItemLabel(text, NULL);
1096 }
1097
1098 if ( mitem->IsSeparator() )
1099 {
1100 menuItem = gtk_separator_menu_item_new();
1101 }
1102 else if ( mitem->GetBitmap().Ok() ||
1103 (mitem->GetKind() == wxITEM_NORMAL && isstock) )
1104 {
1105 wxBitmap bitmap(mitem->GetBitmap());
1106
1107 menuItem = gtk_image_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1108
1109 GtkWidget *image;
1110 if ( !bitmap.Ok() )
1111 {
1112 // use stock bitmap for this item if available on the assumption
1113 // that it never hurts to follow GTK+ conventions more closely
1114 image = stockid ? gtk_image_new_from_stock(stockid, GTK_ICON_SIZE_MENU)
1115 : NULL;
1116 }
1117 else // we have a custom bitmap
1118 {
1119 wxASSERT_MSG( mitem->GetKind() == wxITEM_NORMAL,
1120 _T("only normal menu items can have bitmaps") );
1121
1122 if ( bitmap.HasPixbuf() )
1123 {
1124 image = gtk_image_new_from_pixbuf(bitmap.GetPixbuf());
1125 }
1126 else
1127 {
1128 GdkPixmap *gdk_pixmap = bitmap.GetPixmap();
1129 GdkBitmap *gdk_bitmap = bitmap.GetMask() ?
1130 bitmap.GetMask()->GetBitmap() :
1131 (GdkBitmap*) NULL;
1132 image = gtk_image_new_from_pixmap( gdk_pixmap, gdk_bitmap );
1133 }
1134 }
1135
1136 if ( image )
1137 {
1138 gtk_widget_show(image);
1139
1140 gtk_image_menu_item_set_image( GTK_IMAGE_MENU_ITEM(menuItem), image );
1141 }
1142
1143 m_prevRadio = NULL;
1144 }
1145 else // a normal item
1146 {
1147 // NB: 'text' variable has "_" instead of "&" after mitem->SetItemLabel()
1148 // so don't use it
1149
1150 switch ( mitem->GetKind() )
1151 {
1152 case wxITEM_CHECK:
1153 {
1154 menuItem = gtk_check_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1155 m_prevRadio = NULL;
1156 break;
1157 }
1158
1159 case wxITEM_RADIO:
1160 {
1161 GSList *group = NULL;
1162 if ( m_prevRadio == NULL )
1163 {
1164 // start of a new radio group
1165 m_prevRadio = menuItem =
1166 gtk_radio_menu_item_new_with_mnemonic( group, wxGTK_CONV_SYS( text ) );
1167 }
1168 else // continue the radio group
1169 {
1170 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (m_prevRadio));
1171 m_prevRadio = menuItem =
1172 gtk_radio_menu_item_new_with_mnemonic( group, wxGTK_CONV_SYS( text ) );
1173 }
1174 break;
1175 }
1176
1177 default:
1178 wxFAIL_MSG( _T("unexpected menu item kind") );
1179 // fall through
1180
1181 case wxITEM_NORMAL:
1182 {
1183 menuItem = gtk_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text ) );
1184 m_prevRadio = NULL;
1185 break;
1186 }
1187 }
1188
1189 }
1190
1191 guint accel_key;
1192 GdkModifierType accel_mods;
1193 wxCharBuffer buf = wxGTK_CONV_SYS( GetGtkHotKey(*mitem) );
1194
1195 // wxPrintf( wxT("item: %s hotkey %s\n"), mitem->GetItemLabel().c_str(), GetGtkHotKey(*mitem).c_str() );
1196 if (buf[(size_t)0] != '\0')
1197 {
1198 gtk_accelerator_parse( (const char*) buf, &accel_key, &accel_mods);
1199 if (accel_key != 0)
1200 {
1201 gtk_widget_add_accelerator (menuItem,
1202 "activate",
1203 m_accel,
1204 accel_key,
1205 accel_mods,
1206 GTK_ACCEL_VISIBLE);
1207 }
1208 }
1209 else if (isstock)
1210 {
1211 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
1212 if (wxGetStockGtkAccelerator(stockid, &accel_mods, &accel_key))
1213 gtk_widget_add_accelerator( menuItem,
1214 "activate",
1215 m_accel,
1216 accel_key,
1217 accel_mods,
1218 GTK_ACCEL_VISIBLE);
1219 }
1220
1221 if (pos == -1)
1222 gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), menuItem);
1223 else
1224 gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu), menuItem, pos);
1225
1226 gtk_widget_show( menuItem );
1227
1228 if ( !mitem->IsSeparator() )
1229 {
1230 wxASSERT_MSG( menuItem, wxT("invalid menuitem") );
1231
1232 g_signal_connect (menuItem, "select",
1233 G_CALLBACK (gtk_menu_hilight_callback), this);
1234 g_signal_connect (menuItem, "deselect",
1235 G_CALLBACK (gtk_menu_nolight_callback), this);
1236
1237 if ( mitem->IsSubMenu() && mitem->GetKind() != wxITEM_RADIO && mitem->GetKind() != wxITEM_CHECK )
1238 {
1239 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
1240
1241 gtk_widget_show( mitem->GetSubMenu()->m_menu );
1242
1243 // if adding a submenu to a menu already existing in the menu bar, we
1244 // must set invoking window to allow processing events from this
1245 // submenu
1246 if ( m_invokingWindow )
1247 wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
1248 }
1249 else
1250 {
1251 g_signal_connect (menuItem, "activate",
1252 G_CALLBACK (gtk_menu_clicked_callback),
1253 this);
1254 }
1255 }
1256
1257 mitem->SetMenuItem(menuItem);
1258
1259 if (ms_locked)
1260 {
1261 // This doesn't even exist!
1262 // gtk_widget_lock_accelerators(mitem->GetMenuItem());
1263 }
1264
1265 return true;
1266 }
1267
1268 wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
1269 {
1270 if (!GtkAppend(mitem))
1271 return NULL;
1272
1273 return wxMenuBase::DoAppend(mitem);
1274 }
1275
1276 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
1277 {
1278 if ( !wxMenuBase::DoInsert(pos, item) )
1279 return NULL;
1280
1281 // TODO
1282 if ( !GtkAppend(item, (int)pos) )
1283 return NULL;
1284
1285 return item;
1286 }
1287
1288 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
1289 {
1290 if ( !wxMenuBase::DoRemove(item) )
1291 return (wxMenuItem *)NULL;
1292
1293 // TODO: this code doesn't delete the item factory item and this seems
1294 // impossible as of GTK 1.2.6.
1295 gtk_widget_destroy( item->GetMenuItem() );
1296
1297 return item;
1298 }
1299
1300 int wxMenu::FindMenuIdByMenuItem( GtkWidget *menuItem ) const
1301 {
1302 wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
1303 while (node)
1304 {
1305 wxMenuItem *item = node->GetData();
1306 if (item->GetMenuItem() == menuItem)
1307 return item->GetId();
1308 node = node->GetNext();
1309 }
1310
1311 return wxNOT_FOUND;
1312 }
1313
1314 void wxMenu::Attach(wxMenuBarBase *menubar)
1315 {
1316 wxMenuBase::Attach(menubar);
1317
1318 // inherit layout direction from menubar.
1319 SetLayoutDirection(menubar->GetLayoutDirection());
1320 }
1321
1322 // ----------------------------------------------------------------------------
1323 // helpers
1324 // ----------------------------------------------------------------------------
1325
1326 #if wxUSE_ACCEL
1327
1328 static wxString GetGtkHotKey( const wxMenuItem& item )
1329 {
1330 wxString hotkey;
1331
1332 wxAcceleratorEntry *accel = item.GetAccel();
1333 if ( accel )
1334 {
1335 int flags = accel->GetFlags();
1336 if ( flags & wxACCEL_ALT )
1337 hotkey += wxT("<alt>");
1338 if ( flags & wxACCEL_CTRL )
1339 hotkey += wxT("<control>");
1340 if ( flags & wxACCEL_SHIFT )
1341 hotkey += wxT("<shift>");
1342
1343 int code = accel->GetKeyCode();
1344 switch ( code )
1345 {
1346 case WXK_F1:
1347 case WXK_F2:
1348 case WXK_F3:
1349 case WXK_F4:
1350 case WXK_F5:
1351 case WXK_F6:
1352 case WXK_F7:
1353 case WXK_F8:
1354 case WXK_F9:
1355 case WXK_F10:
1356 case WXK_F11:
1357 case WXK_F12:
1358 case WXK_F13:
1359 case WXK_F14:
1360 case WXK_F15:
1361 case WXK_F16:
1362 case WXK_F17:
1363 case WXK_F18:
1364 case WXK_F19:
1365 case WXK_F20:
1366 case WXK_F21:
1367 case WXK_F22:
1368 case WXK_F23:
1369 case WXK_F24:
1370 hotkey += wxString::Format(wxT("F%d"), code - WXK_F1 + 1);
1371 break;
1372
1373 // TODO: we should use gdk_keyval_name() (a.k.a.
1374 // XKeysymToString) here as well as hardcoding the keysym
1375 // names this might be not portable
1376 case WXK_INSERT:
1377 hotkey << wxT("Insert" );
1378 break;
1379 case WXK_DELETE:
1380 hotkey << wxT("Delete" );
1381 break;
1382 case WXK_UP:
1383 hotkey << wxT("Up" );
1384 break;
1385 case WXK_DOWN:
1386 hotkey << wxT("Down" );
1387 break;
1388 case WXK_PAGEUP:
1389 hotkey << wxT("Page_Up" );
1390 break;
1391 case WXK_PAGEDOWN:
1392 hotkey << wxT("Page_Down" );
1393 break;
1394 case WXK_LEFT:
1395 hotkey << wxT("Left" );
1396 break;
1397 case WXK_RIGHT:
1398 hotkey << wxT("Right" );
1399 break;
1400 case WXK_HOME:
1401 hotkey << wxT("Home" );
1402 break;
1403 case WXK_END:
1404 hotkey << wxT("End" );
1405 break;
1406 case WXK_RETURN:
1407 hotkey << wxT("Return" );
1408 break;
1409 case WXK_BACK:
1410 hotkey << wxT("BackSpace" );
1411 break;
1412 case WXK_TAB:
1413 hotkey << wxT("Tab" );
1414 break;
1415 case WXK_ESCAPE:
1416 hotkey << wxT("Esc" );
1417 break;
1418 case WXK_SPACE:
1419 hotkey << wxT("space" );
1420 break;
1421 case WXK_MULTIPLY:
1422 hotkey << wxT("Multiply" );
1423 break;
1424 case WXK_ADD:
1425 hotkey << wxT("Add" );
1426 break;
1427 case WXK_SEPARATOR:
1428 hotkey << wxT("Separator" );
1429 break;
1430 case WXK_SUBTRACT:
1431 hotkey << wxT("Subtract" );
1432 break;
1433 case WXK_DECIMAL:
1434 hotkey << wxT("Decimal" );
1435 break;
1436 case WXK_DIVIDE:
1437 hotkey << wxT("Divide" );
1438 break;
1439 case WXK_CANCEL:
1440 hotkey << wxT("Cancel" );
1441 break;
1442 case WXK_CLEAR:
1443 hotkey << wxT("Clear" );
1444 break;
1445 case WXK_MENU:
1446 hotkey << wxT("Menu" );
1447 break;
1448 case WXK_PAUSE:
1449 hotkey << wxT("Pause" );
1450 break;
1451 case WXK_CAPITAL:
1452 hotkey << wxT("Capital" );
1453 break;
1454 case WXK_SELECT:
1455 hotkey << wxT("Select" );
1456 break;
1457 case WXK_PRINT:
1458 hotkey << wxT("Print" );
1459 break;
1460 case WXK_EXECUTE:
1461 hotkey << wxT("Execute" );
1462 break;
1463 case WXK_SNAPSHOT:
1464 hotkey << wxT("Snapshot" );
1465 break;
1466 case WXK_HELP:
1467 hotkey << wxT("Help" );
1468 break;
1469 case WXK_NUMLOCK:
1470 hotkey << wxT("Num_Lock" );
1471 break;
1472 case WXK_SCROLL:
1473 hotkey << wxT("Scroll_Lock" );
1474 break;
1475 case WXK_NUMPAD_INSERT:
1476 hotkey << wxT("KP_Insert" );
1477 break;
1478 case WXK_NUMPAD_DELETE:
1479 hotkey << wxT("KP_Delete" );
1480 break;
1481 case WXK_NUMPAD_SPACE:
1482 hotkey << wxT("KP_Space" );
1483 break;
1484 case WXK_NUMPAD_TAB:
1485 hotkey << wxT("KP_Tab" );
1486 break;
1487 case WXK_NUMPAD_ENTER:
1488 hotkey << wxT("KP_Enter" );
1489 break;
1490 case WXK_NUMPAD_F1: case WXK_NUMPAD_F2: case WXK_NUMPAD_F3:
1491 case WXK_NUMPAD_F4:
1492 hotkey += wxString::Format(wxT("KP_F%d"), code - WXK_NUMPAD_F1 + 1);
1493 break;
1494 case WXK_NUMPAD_HOME:
1495 hotkey << wxT("KP_Home" );
1496 break;
1497 case WXK_NUMPAD_LEFT:
1498 hotkey << wxT("KP_Left" );
1499 break;
1500 case WXK_NUMPAD_UP:
1501 hotkey << wxT("KP_Up" );
1502 break;
1503 case WXK_NUMPAD_RIGHT:
1504 hotkey << wxT("KP_Right" );
1505 break;
1506 case WXK_NUMPAD_DOWN:
1507 hotkey << wxT("KP_Down" );
1508 break;
1509 case WXK_NUMPAD_PAGEUP:
1510 hotkey << wxT("KP_Page_Up" );
1511 break;
1512 case WXK_NUMPAD_PAGEDOWN:
1513 hotkey << wxT("KP_Page_Down" );
1514 break;
1515 case WXK_NUMPAD_END:
1516 hotkey << wxT("KP_End" );
1517 break;
1518 case WXK_NUMPAD_BEGIN:
1519 hotkey << wxT("KP_Begin" );
1520 break;
1521 case WXK_NUMPAD_EQUAL:
1522 hotkey << wxT("KP_Equal" );
1523 break;
1524 case WXK_NUMPAD_MULTIPLY:
1525 hotkey << wxT("KP_Multiply" );
1526 break;
1527 case WXK_NUMPAD_ADD:
1528 hotkey << wxT("KP_Add" );
1529 break;
1530 case WXK_NUMPAD_SEPARATOR:
1531 hotkey << wxT("KP_Separator" );
1532 break;
1533 case WXK_NUMPAD_SUBTRACT:
1534 hotkey << wxT("KP_Subtract" );
1535 break;
1536 case WXK_NUMPAD_DECIMAL:
1537 hotkey << wxT("KP_Decimal" );
1538 break;
1539 case WXK_NUMPAD_DIVIDE:
1540 hotkey << wxT("KP_Divide" );
1541 break;
1542 case WXK_NUMPAD0: case WXK_NUMPAD1: case WXK_NUMPAD2:
1543 case WXK_NUMPAD3: case WXK_NUMPAD4: case WXK_NUMPAD5:
1544 case WXK_NUMPAD6: case WXK_NUMPAD7: case WXK_NUMPAD8: case WXK_NUMPAD9:
1545 hotkey += wxString::Format(wxT("KP_%d"), code - WXK_NUMPAD0);
1546 break;
1547 case WXK_WINDOWS_LEFT:
1548 hotkey << wxT("Super_L" );
1549 break;
1550 case WXK_WINDOWS_RIGHT:
1551 hotkey << wxT("Super_R" );
1552 break;
1553 case WXK_WINDOWS_MENU:
1554 hotkey << wxT("Menu" );
1555 break;
1556 case WXK_COMMAND:
1557 hotkey << wxT("Command" );
1558 break;
1559 /* These probably wouldn't work as there is no SpecialX in gdk/keynames.txt
1560 case WXK_SPECIAL1: case WXK_SPECIAL2: case WXK_SPECIAL3: case WXK_SPECIAL4:
1561 case WXK_SPECIAL5: case WXK_SPECIAL6: case WXK_SPECIAL7: case WXK_SPECIAL8:
1562 case WXK_SPECIAL9: case WXK_SPECIAL10: case WXK_SPECIAL11: case WXK_SPECIAL12:
1563 case WXK_SPECIAL13: case WXK_SPECIAL14: case WXK_SPECIAL15: case WXK_SPECIAL16:
1564 case WXK_SPECIAL17: case WXK_SPECIAL18: case WXK_SPECIAL19: case WXK_SPECIAL20:
1565 hotkey += wxString::Format(wxT("Special%d"), code - WXK_SPECIAL1 + 1);
1566 break;
1567 */
1568 // if there are any other keys wxAcceleratorEntry::Create() may
1569 // return, we should process them here
1570
1571 default:
1572 if ( code < 127 )
1573 {
1574 const wxString
1575 name = wxGTK_CONV_BACK_SYS(gdk_keyval_name((guint)code));
1576 if ( !name.empty() )
1577 {
1578 hotkey << name;
1579 break;
1580 }
1581 }
1582
1583 wxFAIL_MSG( wxT("unknown keyboard accel") );
1584 }
1585
1586 delete accel;
1587 }
1588
1589 return hotkey;
1590 }
1591
1592 #endif // wxUSE_ACCEL
1593
1594 // ----------------------------------------------------------------------------
1595 // Pop-up menu stuff
1596 // ----------------------------------------------------------------------------
1597
1598 #if wxUSE_MENUS_NATIVE
1599
1600 extern "C" WXDLLIMPEXP_CORE
1601 void gtk_pop_hide_callback( GtkWidget *WXUNUSED(widget), bool* is_waiting )
1602 {
1603 *is_waiting = false;
1604 }
1605
1606 WXDLLIMPEXP_CORE void SetInvokingWindow( wxMenu *menu, wxWindow* win )
1607 {
1608 menu->SetInvokingWindow( win );
1609
1610 wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst();
1611 while (node)
1612 {
1613 wxMenuItem *menuitem = node->GetData();
1614 if (menuitem->IsSubMenu())
1615 {
1616 SetInvokingWindow( menuitem->GetSubMenu(), win );
1617 }
1618
1619 node = node->GetNext();
1620 }
1621 }
1622
1623 extern "C" WXDLLIMPEXP_CORE
1624 void wxPopupMenuPositionCallback( GtkMenu *menu,
1625 gint *x, gint *y,
1626 gboolean * WXUNUSED(whatever),
1627 gpointer user_data )
1628 {
1629 // ensure that the menu appears entirely on screen
1630 GtkRequisition req;
1631 gtk_widget_get_child_requisition(GTK_WIDGET(menu), &req);
1632
1633 wxSize sizeScreen = wxGetDisplaySize();
1634 wxPoint *pos = (wxPoint*)user_data;
1635
1636 gint xmax = sizeScreen.x - req.width,
1637 ymax = sizeScreen.y - req.height;
1638
1639 *x = pos->x < xmax ? pos->x : xmax;
1640 *y = pos->y < ymax ? pos->y : ymax;
1641 }
1642
1643 bool wxWindowGTK::DoPopupMenu( wxMenu *menu, int x, int y )
1644 {
1645 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid window") );
1646
1647 wxCHECK_MSG( menu != NULL, false, wxT("invalid popup-menu") );
1648
1649 // NOTE: if you change this code, you need to update
1650 // the same code in taskbar.cpp as well. This
1651 // is ugly code duplication, I know.
1652
1653 SetInvokingWindow( menu, this );
1654
1655 menu->UpdateUI();
1656
1657 bool is_waiting = true;
1658
1659 gulong handler = g_signal_connect (menu->m_menu, "hide",
1660 G_CALLBACK (gtk_pop_hide_callback),
1661 &is_waiting);
1662
1663 wxPoint pos;
1664 gpointer userdata;
1665 GtkMenuPositionFunc posfunc;
1666 if ( x == -1 && y == -1 )
1667 {
1668 // use GTK's default positioning algorithm
1669 userdata = NULL;
1670 posfunc = NULL;
1671 }
1672 else
1673 {
1674 pos = ClientToScreen(wxPoint(x, y));
1675 userdata = &pos;
1676 posfunc = wxPopupMenuPositionCallback;
1677 }
1678
1679 wxMenuEvent eventOpen(wxEVT_MENU_OPEN, -1, menu);
1680 DoCommonMenuCallbackCode(menu, eventOpen);
1681
1682 gtk_menu_popup(
1683 GTK_MENU(menu->m_menu),
1684 (GtkWidget *) NULL, // parent menu shell
1685 (GtkWidget *) NULL, // parent menu item
1686 posfunc, // function to position it
1687 userdata, // client data
1688 0, // button used to activate it
1689 gtk_get_current_event_time()
1690 );
1691
1692 while (is_waiting)
1693 {
1694 gtk_main_iteration();
1695 }
1696
1697 g_signal_handler_disconnect (menu->m_menu, handler);
1698
1699 wxMenuEvent eventClose(wxEVT_MENU_CLOSE, -1, menu);
1700 DoCommonMenuCallbackCode(menu, eventClose);
1701
1702 return true;
1703 }
1704
1705 #endif // wxUSE_MENUS_NATIVE
1706
1707 #ifdef __WXGTK20__
1708
1709 #include <gtk/gtk.h>
1710
1711 const char *wxGetStockGtkID(wxWindowID id)
1712 {
1713 #define STOCKITEM(wx,gtk) \
1714 case wx: \
1715 return gtk;
1716
1717 #define STOCKITEM_MISSING(wx) \
1718 case wx: \
1719 return NULL;
1720
1721 #if GTK_CHECK_VERSION(2,4,0)
1722 #define STOCKITEM_24(wx,gtk) STOCKITEM(wx,gtk)
1723 #else
1724 #define STOCKITEM_24(wx,gtk) STOCKITEM_MISSING(wx)
1725 #endif
1726
1727 #if GTK_CHECK_VERSION(2,6,0)
1728 #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
1729 #else
1730 #define STOCKITEM_26(wx,gtk) STOCKITEM_MISSING(wx)
1731 #endif
1732
1733 #if GTK_CHECK_VERSION(2,10,0)
1734 #define STOCKITEM_210(wx,gtk) STOCKITEM(wx,gtk)
1735 #else
1736 #define STOCKITEM_210(wx,gtk) STOCKITEM_MISSING(wx)
1737 #endif
1738
1739
1740 switch (id)
1741 {
1742 STOCKITEM_26(wxID_ABOUT, GTK_STOCK_ABOUT)
1743 STOCKITEM(wxID_ADD, GTK_STOCK_ADD)
1744 STOCKITEM(wxID_APPLY, GTK_STOCK_APPLY)
1745 STOCKITEM(wxID_BOLD, GTK_STOCK_BOLD)
1746 STOCKITEM(wxID_CANCEL, GTK_STOCK_CANCEL)
1747 STOCKITEM(wxID_CLEAR, GTK_STOCK_CLEAR)
1748 STOCKITEM(wxID_CLOSE, GTK_STOCK_CLOSE)
1749 STOCKITEM(wxID_COPY, GTK_STOCK_COPY)
1750 STOCKITEM(wxID_CUT, GTK_STOCK_CUT)
1751 STOCKITEM(wxID_DELETE, GTK_STOCK_DELETE)
1752 STOCKITEM_26(wxID_EDIT, GTK_STOCK_EDIT)
1753 STOCKITEM(wxID_FIND, GTK_STOCK_FIND)
1754 STOCKITEM_26(wxID_FILE, GTK_STOCK_FILE)
1755 STOCKITEM(wxID_REPLACE, GTK_STOCK_FIND_AND_REPLACE)
1756 STOCKITEM(wxID_BACKWARD, GTK_STOCK_GO_BACK)
1757 STOCKITEM(wxID_DOWN, GTK_STOCK_GO_DOWN)
1758 STOCKITEM(wxID_FORWARD, GTK_STOCK_GO_FORWARD)
1759 STOCKITEM(wxID_UP, GTK_STOCK_GO_UP)
1760 STOCKITEM(wxID_HELP, GTK_STOCK_HELP)
1761 STOCKITEM(wxID_HOME, GTK_STOCK_HOME)
1762 STOCKITEM_24(wxID_INDENT, GTK_STOCK_INDENT)
1763 STOCKITEM(wxID_INDEX, GTK_STOCK_INDEX)
1764 STOCKITEM(wxID_ITALIC, GTK_STOCK_ITALIC)
1765 STOCKITEM(wxID_JUSTIFY_CENTER, GTK_STOCK_JUSTIFY_CENTER)
1766 STOCKITEM(wxID_JUSTIFY_FILL, GTK_STOCK_JUSTIFY_FILL)
1767 STOCKITEM(wxID_JUSTIFY_LEFT, GTK_STOCK_JUSTIFY_LEFT)
1768 STOCKITEM(wxID_JUSTIFY_RIGHT, GTK_STOCK_JUSTIFY_RIGHT)
1769 STOCKITEM(wxID_NEW, GTK_STOCK_NEW)
1770 STOCKITEM(wxID_NO, GTK_STOCK_NO)
1771 STOCKITEM(wxID_OK, GTK_STOCK_OK)
1772 STOCKITEM(wxID_OPEN, GTK_STOCK_OPEN)
1773 STOCKITEM(wxID_PASTE, GTK_STOCK_PASTE)
1774 STOCKITEM(wxID_PREFERENCES, GTK_STOCK_PREFERENCES)
1775 STOCKITEM(wxID_PRINT, GTK_STOCK_PRINT)
1776 STOCKITEM(wxID_PREVIEW, GTK_STOCK_PRINT_PREVIEW)
1777 STOCKITEM(wxID_PROPERTIES, GTK_STOCK_PROPERTIES)
1778 STOCKITEM(wxID_EXIT, GTK_STOCK_QUIT)
1779 STOCKITEM(wxID_REDO, GTK_STOCK_REDO)
1780 STOCKITEM(wxID_REFRESH, GTK_STOCK_REFRESH)
1781 STOCKITEM(wxID_REMOVE, GTK_STOCK_REMOVE)
1782 STOCKITEM(wxID_REVERT_TO_SAVED, GTK_STOCK_REVERT_TO_SAVED)
1783 STOCKITEM(wxID_SAVE, GTK_STOCK_SAVE)
1784 STOCKITEM(wxID_SAVEAS, GTK_STOCK_SAVE_AS)
1785 STOCKITEM_210(wxID_SELECTALL, GTK_STOCK_SELECT_ALL)
1786 STOCKITEM(wxID_STOP, GTK_STOCK_STOP)
1787 STOCKITEM(wxID_UNDELETE, GTK_STOCK_UNDELETE)
1788 STOCKITEM(wxID_UNDERLINE, GTK_STOCK_UNDERLINE)
1789 STOCKITEM(wxID_UNDO, GTK_STOCK_UNDO)
1790 STOCKITEM_24(wxID_UNINDENT, GTK_STOCK_UNINDENT)
1791 STOCKITEM(wxID_YES, GTK_STOCK_YES)
1792 STOCKITEM(wxID_ZOOM_100, GTK_STOCK_ZOOM_100)
1793 STOCKITEM(wxID_ZOOM_FIT, GTK_STOCK_ZOOM_FIT)
1794 STOCKITEM(wxID_ZOOM_IN, GTK_STOCK_ZOOM_IN)
1795 STOCKITEM(wxID_ZOOM_OUT, GTK_STOCK_ZOOM_OUT)
1796
1797 default:
1798 wxFAIL_MSG( _T("invalid stock item ID") );
1799 break;
1800 };
1801
1802 #undef STOCKITEM
1803
1804 return NULL;
1805 }
1806
1807 bool wxGetStockGtkAccelerator(const char *id, GdkModifierType *mod, guint *key)
1808 {
1809 if (!id)
1810 return false;
1811
1812 GtkStockItem stock_item;
1813 if (gtk_stock_lookup (id, &stock_item))
1814 {
1815 if (key) *key = stock_item.keyval;
1816 if (mod) *mod = stock_item.modifier;
1817
1818 // some GTK stock items have zero values for the keyval;
1819 // it means that they do not have an accelerator...
1820 if (stock_item.keyval)
1821 return true;
1822 }
1823
1824 return false;
1825 }
1826
1827 #endif // __WXGTK20__
1828
1829 #endif // wxUSE_MENUS