1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/menu.cpp
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
19 #include "wx/bitmap.h"
23 #include "wx/stockitem.h"
24 #include "wx/gtk/private.h"
26 // FIXME: is this right? somehow I don't think so (VZ)
28 #define gtk_accel_group_attach(g, o) gtk_window_add_accel_group((o), (g))
29 //#define gtk_accel_group_detach(g, o) gtk_window_remove_accel_group((o), (g))
30 //#define gtk_menu_ensure_uline_accel_group(m) gtk_menu_get_accel_group(m)
32 #define ACCEL_OBJECT GtkWindow
33 #define ACCEL_OBJECTS(a) (a)->acceleratables
34 #define ACCEL_OBJ_CAST(obj) ((GtkWindow*) obj)
36 // we use normal item but with a special id for the menu title
37 static const int wxGTK_TITLE_ID
= -3;
39 //-----------------------------------------------------------------------------
41 //-----------------------------------------------------------------------------
44 static wxString
GetGtkHotKey( const wxMenuItem
& item
);
47 //-----------------------------------------------------------------------------
49 //-----------------------------------------------------------------------------
51 static wxString
wxReplaceUnderscore( const wxString
& title
)
55 // GTK 1.2 wants to have "_" instead of "&" for accelerators
58 while (*pc
!= wxT('\0'))
60 if ((*pc
== wxT('&')) && (*(pc
+1) == wxT('&')))
62 // "&" is doubled to indicate "&" instead of accelerator
66 else if (*pc
== wxT('&'))
72 if ( *pc
== wxT('_') )
74 // underscores must be doubled to prevent them from being
75 // interpreted as accelerator character prefix by GTK
84 // wxPrintf( wxT("before %s after %s\n"), title.c_str(), str.c_str() );
89 //-----------------------------------------------------------------------------
90 // activate message from GTK
91 //-----------------------------------------------------------------------------
93 static void DoCommonMenuCallbackCode(wxMenu
*menu
, wxMenuEvent
& event
)
96 wxapp_install_idle_handler();
98 event
.SetEventObject( menu
);
100 wxEvtHandler
* handler
= menu
->GetEventHandler();
101 if (handler
&& handler
->ProcessEvent(event
))
104 wxWindow
*win
= menu
->GetInvokingWindow();
106 win
->GetEventHandler()->ProcessEvent( event
);
111 static void gtk_menu_open_callback( GtkWidget
*widget
, wxMenu
*menu
)
113 wxMenuEvent
event(wxEVT_MENU_OPEN
, -1, menu
);
115 DoCommonMenuCallbackCode(menu
, event
);
118 static void gtk_menu_close_callback( GtkWidget
*widget
, wxMenuBar
*menubar
)
120 if ( !menubar
->GetMenuCount() )
122 // if menubar is empty we can't call GetMenu(0) below
126 wxMenuEvent
event( wxEVT_MENU_CLOSE
, -1, NULL
);
128 DoCommonMenuCallbackCode(menubar
->GetMenu(0), event
);
133 //-----------------------------------------------------------------------------
135 //-----------------------------------------------------------------------------
137 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar
,wxWindow
)
139 void wxMenuBar::Init(size_t n
, wxMenu
*menus
[], const wxString titles
[], long style
)
141 // the parent window is known after wxFrame::SetMenu()
142 m_needParent
= false;
144 m_invokingWindow
= (wxWindow
*) NULL
;
146 if (!PreCreation( (wxWindow
*) NULL
, wxDefaultPosition
, wxDefaultSize
) ||
147 !CreateBase( (wxWindow
*) NULL
, -1, wxDefaultPosition
, wxDefaultSize
, style
, wxDefaultValidator
, wxT("menubar") ))
149 wxFAIL_MSG( wxT("wxMenuBar creation failed") );
153 m_menubar
= gtk_menu_bar_new();
155 if (style
& wxMB_DOCKABLE
)
157 m_widget
= gtk_handle_box_new();
158 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_menubar
) );
159 gtk_widget_show( GTK_WIDGET(m_menubar
) );
163 m_widget
= GTK_WIDGET(m_menubar
);
170 for (size_t i
= 0; i
< n
; ++i
)
171 Append(menus
[i
], titles
[i
]);
173 // VZ: for some reason connecting to menus "deactivate" doesn't work (we
174 // don't get it when the menu is dismissed by clicking outside the
175 // toolbar) so we connect to the global one, even if it means that we
176 // can't pass the menu which was closed in wxMenuEvent object
177 g_signal_connect (m_menubar
, "deactivate",
178 G_CALLBACK (gtk_menu_close_callback
), this);
182 wxMenuBar::wxMenuBar(size_t n
, wxMenu
*menus
[], const wxString titles
[], long style
)
184 Init(n
, menus
, titles
, style
);
187 wxMenuBar::wxMenuBar(long style
)
189 Init(0, NULL
, NULL
, style
);
192 wxMenuBar::wxMenuBar()
194 Init(0, NULL
, NULL
, 0);
197 wxMenuBar::~wxMenuBar()
201 static void wxMenubarUnsetInvokingWindow( wxMenu
*menu
, wxWindow
*win
)
203 menu
->SetInvokingWindow( (wxWindow
*) NULL
);
205 wxWindow
*top_frame
= win
;
206 while (top_frame
->GetParent() && !(top_frame
->IsTopLevel()))
207 top_frame
= top_frame
->GetParent();
209 wxMenuItemList::compatibility_iterator node
= menu
->GetMenuItems().GetFirst();
212 wxMenuItem
*menuitem
= node
->GetData();
213 if (menuitem
->IsSubMenu())
214 wxMenubarUnsetInvokingWindow( menuitem
->GetSubMenu(), win
);
215 node
= node
->GetNext();
219 static void wxMenubarSetInvokingWindow( wxMenu
*menu
, wxWindow
*win
)
221 menu
->SetInvokingWindow( win
);
223 wxWindow
*top_frame
= win
;
224 while (top_frame
->GetParent() && !(top_frame
->IsTopLevel()))
225 top_frame
= top_frame
->GetParent();
227 // support for native hot keys
228 ACCEL_OBJECT
*obj
= ACCEL_OBJ_CAST(top_frame
->m_widget
);
229 if ( !g_slist_find( ACCEL_OBJECTS(menu
->m_accel
), obj
) )
230 gtk_accel_group_attach( menu
->m_accel
, obj
);
232 wxMenuItemList::compatibility_iterator node
= menu
->GetMenuItems().GetFirst();
235 wxMenuItem
*menuitem
= node
->GetData();
236 if (menuitem
->IsSubMenu())
237 wxMenubarSetInvokingWindow( menuitem
->GetSubMenu(), win
);
238 node
= node
->GetNext();
242 void wxMenuBar::SetInvokingWindow( wxWindow
*win
)
244 m_invokingWindow
= win
;
245 wxWindow
*top_frame
= win
;
246 while (top_frame
->GetParent() && !(top_frame
->IsTopLevel()))
247 top_frame
= top_frame
->GetParent();
249 wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
252 wxMenu
*menu
= node
->GetData();
253 wxMenubarSetInvokingWindow( menu
, win
);
254 node
= node
->GetNext();
258 void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir
)
260 if ( dir
== wxLayout_Default
)
262 const wxWindow
*const frame
= GetFrame();
265 // inherit layout from frame.
266 dir
= frame
->GetLayoutDirection();
268 else // use global layout
270 dir
= wxTheApp
->GetLayoutDirection();
274 if ( dir
== wxLayout_Default
)
277 GTKSetLayout(m_menubar
, dir
);
279 // also set the layout of all menus we already have (new ones will inherit
280 // the current layout)
281 for ( wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
283 node
= node
->GetNext() )
285 wxMenu
*const menu
= node
->GetData();
286 menu
->SetLayoutDirection(dir
);
290 wxLayoutDirection
wxMenuBar::GetLayoutDirection() const
292 return GTKGetLayout(m_menubar
);
295 void wxMenuBar::Attach(wxFrame
*frame
)
297 wxMenuBarBase::Attach(frame
);
299 SetLayoutDirection(wxLayout_Default
);
302 void wxMenuBar::UnsetInvokingWindow( wxWindow
*win
)
304 m_invokingWindow
= (wxWindow
*) NULL
;
305 wxWindow
*top_frame
= win
;
306 while (top_frame
->GetParent() && !(top_frame
->IsTopLevel()))
307 top_frame
= top_frame
->GetParent();
309 wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
312 wxMenu
*menu
= node
->GetData();
313 wxMenubarUnsetInvokingWindow( menu
, win
);
314 node
= node
->GetNext();
318 bool wxMenuBar::Append( wxMenu
*menu
, const wxString
&title
)
320 if ( !wxMenuBarBase::Append( menu
, title
) )
323 return GtkAppend(menu
, title
);
326 bool wxMenuBar::GtkAppend(wxMenu
*menu
, const wxString
& title
, int pos
)
328 wxString
str( wxReplaceUnderscore( title
) );
330 // This doesn't have much effect right now.
331 menu
->SetTitle( str
);
333 // The "m_owner" is the "menu item"
334 menu
->m_owner
= gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str
) );
335 menu
->SetLayoutDirection(GetLayoutDirection());
337 gtk_widget_show( menu
->m_owner
);
339 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu
->m_owner
), menu
->m_menu
);
342 gtk_menu_shell_append( GTK_MENU_SHELL(m_menubar
), menu
->m_owner
);
344 gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar
), menu
->m_owner
, pos
);
346 g_signal_connect (menu
->m_owner
, "activate",
347 G_CALLBACK (gtk_menu_open_callback
),
350 // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
351 // addings menu later on.
352 if (m_invokingWindow
)
354 wxMenubarSetInvokingWindow( menu
, m_invokingWindow
);
356 // OPTIMISE ME: we should probably cache this, or pass it
357 // directly, but for now this is a minimal
358 // change to validate the new dynamic sizing.
359 // see (and refactor :) similar code in Remove
362 wxFrame
*frame
= wxDynamicCast( m_invokingWindow
, wxFrame
);
365 frame
->UpdateMenuBarSize();
371 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
373 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
378 if ( !GtkAppend(menu
, title
, (int)pos
) )
384 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
386 // remove the old item and insert a new one
387 wxMenu
*menuOld
= Remove(pos
);
388 if ( menuOld
&& !Insert(pos
, menu
, title
) )
390 return (wxMenu
*) NULL
;
393 // either Insert() succeeded or Remove() failed and menuOld is NULL
397 wxMenu
*wxMenuBar::Remove(size_t pos
)
399 wxMenu
*menu
= wxMenuBarBase::Remove(pos
);
401 return (wxMenu
*) NULL
;
403 gtk_menu_item_remove_submenu( GTK_MENU_ITEM(menu
->m_owner
) );
404 gtk_container_remove(GTK_CONTAINER(m_menubar
), menu
->m_owner
);
406 gtk_widget_destroy( menu
->m_owner
);
407 menu
->m_owner
= NULL
;
409 if (m_invokingWindow
)
411 // OPTIMISE ME: see comment in GtkAppend
412 wxFrame
*frame
= wxDynamicCast( m_invokingWindow
, wxFrame
);
415 frame
->UpdateMenuBarSize();
421 static int FindMenuItemRecursive( const wxMenu
*menu
, const wxString
&menuString
, const wxString
&itemString
)
423 if (wxMenuItem::GetLabelFromText(menu
->GetTitle()) == wxMenuItem::GetLabelFromText(menuString
))
425 int res
= menu
->FindItem( itemString
);
426 if (res
!= wxNOT_FOUND
)
430 wxMenuItemList::compatibility_iterator node
= menu
->GetMenuItems().GetFirst();
433 wxMenuItem
*item
= node
->GetData();
434 if (item
->IsSubMenu())
435 return FindMenuItemRecursive(item
->GetSubMenu(), menuString
, itemString
);
437 node
= node
->GetNext();
443 int wxMenuBar::FindMenuItem( const wxString
&menuString
, const wxString
&itemString
) const
445 wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
448 wxMenu
*menu
= node
->GetData();
449 int res
= FindMenuItemRecursive( menu
, menuString
, itemString
);
452 node
= node
->GetNext();
458 // Find a wxMenuItem using its id. Recurses down into sub-menus
459 static wxMenuItem
* FindMenuItemByIdRecursive(const wxMenu
* menu
, int id
)
461 wxMenuItem
* result
= menu
->FindChildItem(id
);
463 wxMenuItemList::compatibility_iterator node
= menu
->GetMenuItems().GetFirst();
464 while ( node
&& result
== NULL
)
466 wxMenuItem
*item
= node
->GetData();
467 if (item
->IsSubMenu())
469 result
= FindMenuItemByIdRecursive( item
->GetSubMenu(), id
);
471 node
= node
->GetNext();
477 wxMenuItem
* wxMenuBar::FindItem( int id
, wxMenu
**menuForItem
) const
479 wxMenuItem
* result
= 0;
480 wxMenuList::compatibility_iterator node
= m_menus
.GetFirst();
481 while (node
&& result
== 0)
483 wxMenu
*menu
= node
->GetData();
484 result
= FindMenuItemByIdRecursive( menu
, id
);
485 node
= node
->GetNext();
490 *menuForItem
= result
? result
->GetMenu() : (wxMenu
*)NULL
;
496 void wxMenuBar::EnableTop( size_t pos
, bool flag
)
498 wxMenuList::compatibility_iterator node
= m_menus
.Item( pos
);
500 wxCHECK_RET( node
, wxT("menu not found") );
502 wxMenu
* menu
= node
->GetData();
505 gtk_widget_set_sensitive( menu
->m_owner
, flag
);
508 wxString
wxMenuBar::GetLabelTop( size_t pos
) const
510 wxMenuList::compatibility_iterator node
= m_menus
.Item( pos
);
512 wxCHECK_MSG( node
, wxT("invalid"), wxT("menu not found") );
514 wxMenu
* menu
= node
->GetData();
517 wxString
text( menu
->GetTitle() );
518 for ( const wxChar
*pc
= text
.c_str(); *pc
; pc
++ )
520 if ( *pc
== wxT('_') )
522 // '_' is the escape character for GTK+
526 // don't remove ampersands '&' since if we have them in the menu title
527 // it means that they were doubled to indicate "&" instead of accelerator
535 void wxMenuBar::SetLabelTop( size_t pos
, const wxString
& label
)
537 wxMenuList::compatibility_iterator node
= m_menus
.Item( pos
);
539 wxCHECK_RET( node
, wxT("menu not found") );
541 wxMenu
* menu
= node
->GetData();
543 const wxString
str( wxReplaceUnderscore( label
) );
545 menu
->SetTitle( str
);
548 gtk_label_set_text_with_mnemonic( GTK_LABEL( GTK_BIN(menu
->m_owner
)->child
), wxGTK_CONV(str
) );
551 //-----------------------------------------------------------------------------
553 //-----------------------------------------------------------------------------
556 static void gtk_menu_clicked_callback( GtkWidget
*widget
, wxMenu
*menu
)
559 wxapp_install_idle_handler();
561 int id
= menu
->FindMenuIdByMenuItem(widget
);
563 /* should find it for normal (not popup) menu */
564 wxASSERT_MSG( (id
!= -1) || (menu
->GetInvokingWindow() != NULL
),
565 _T("menu item not found in gtk_menu_clicked_callback") );
567 if (!menu
->IsEnabled(id
))
570 wxMenuItem
* item
= menu
->FindChildItem( id
);
571 wxCHECK_RET( item
, wxT("error in menu item callback") );
573 if ( item
->GetId() == wxGTK_TITLE_ID
)
575 // ignore events from the menu title
579 if (item
->IsCheckable())
581 bool isReallyChecked
= item
->IsChecked(),
582 isInternallyChecked
= item
->wxMenuItemBase::IsChecked();
584 // ensure that the internal state is always consistent with what is
585 // shown on the screen
586 item
->wxMenuItemBase::Check(isReallyChecked
);
588 // we must not report the events for the radio button going up nor the
589 // events resulting from the calls to wxMenuItem::Check()
590 if ( (item
->GetKind() == wxITEM_RADIO
&& !isReallyChecked
) ||
591 (isInternallyChecked
== isReallyChecked
) )
598 // Is this menu on a menubar? (possibly nested)
599 wxFrame
* frame
= NULL
;
600 if(menu
->IsAttached())
601 frame
= menu
->GetMenuBar()->GetFrame();
603 // FIXME: why do we have to call wxFrame::GetEventHandler() directly here?
604 // normally wxMenu::SendEvent() should be enough, if it doesn't work
605 // in wxGTK then we have a bug in wxMenu::GetInvokingWindow() which
606 // should be fixed instead of working around it here...
609 // If it is attached then let the frame send the event.
610 // Don't call frame->ProcessCommand(id) because it toggles
611 // checkable items and we've already done that above.
612 wxCommandEvent
commandEvent(wxEVT_COMMAND_MENU_SELECTED
, id
);
613 commandEvent
.SetEventObject(frame
);
614 if (item
->IsCheckable())
615 commandEvent
.SetInt(item
->IsChecked());
616 commandEvent
.SetEventObject(menu
);
618 frame
->GetEventHandler()->ProcessEvent(commandEvent
);
622 // otherwise let the menu have it
623 menu
->SendEvent(id
, item
->IsCheckable() ? item
->IsChecked() : -1);
628 //-----------------------------------------------------------------------------
630 //-----------------------------------------------------------------------------
633 static void gtk_menu_hilight_callback( GtkWidget
*widget
, wxMenu
*menu
)
635 if (g_isIdle
) wxapp_install_idle_handler();
637 int id
= menu
->FindMenuIdByMenuItem(widget
);
639 wxASSERT( id
!= -1 ); // should find it!
641 if (!menu
->IsEnabled(id
))
644 wxMenuEvent
event( wxEVT_MENU_HIGHLIGHT
, id
);
645 event
.SetEventObject( menu
);
647 wxEvtHandler
* handler
= menu
->GetEventHandler();
648 if (handler
&& handler
->ProcessEvent(event
))
651 wxWindow
*win
= menu
->GetInvokingWindow();
652 if (win
) win
->GetEventHandler()->ProcessEvent( event
);
656 //-----------------------------------------------------------------------------
658 //-----------------------------------------------------------------------------
661 static void gtk_menu_nolight_callback( GtkWidget
*widget
, wxMenu
*menu
)
663 if (g_isIdle
) wxapp_install_idle_handler();
665 int id
= menu
->FindMenuIdByMenuItem(widget
);
667 wxASSERT( id
!= -1 ); // should find it!
669 if (!menu
->IsEnabled(id
))
672 wxMenuEvent
event( wxEVT_MENU_HIGHLIGHT
, -1 );
673 event
.SetEventObject( menu
);
675 wxEvtHandler
* handler
= menu
->GetEventHandler();
676 if (handler
&& handler
->ProcessEvent(event
))
679 wxWindow
*win
= menu
->GetInvokingWindow();
681 win
->GetEventHandler()->ProcessEvent( event
);
685 //-----------------------------------------------------------------------------
687 //-----------------------------------------------------------------------------
689 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem
, wxObject
)
691 wxMenuItem
*wxMenuItemBase::New(wxMenu
*parentMenu
,
693 const wxString
& name
,
694 const wxString
& help
,
698 return new wxMenuItem(parentMenu
, id
, name
, help
, kind
, subMenu
);
701 wxMenuItem::wxMenuItem(wxMenu
*parentMenu
,
703 const wxString
& text
,
704 const wxString
& help
,
707 : wxMenuItemBase(parentMenu
, id
, text
, help
, kind
, subMenu
)
712 wxMenuItem::wxMenuItem(wxMenu
*parentMenu
,
714 const wxString
& text
,
715 const wxString
& help
,
718 : wxMenuItemBase(parentMenu
, id
, text
, help
,
719 isCheckable
? wxITEM_CHECK
: wxITEM_NORMAL
, subMenu
)
724 void wxMenuItem::Init(const wxString
& text
)
726 m_labelWidget
= (GtkWidget
*) NULL
;
727 m_menuItem
= (GtkWidget
*) NULL
;
732 wxMenuItem::~wxMenuItem()
734 // don't delete menu items, the menus take care of that
737 // return the menu item text without any menu accels
739 wxString
wxMenuItemBase::GetLabelFromText(const wxString
& text
)
743 for ( const wxChar
*pc
= text
.c_str(); *pc
; pc
++ )
745 if ( *pc
== wxT('\t'))
748 if ( *pc
== wxT('_') )
750 // GTK 1.2 escapes "xxx_xxx" to "xxx__xxx"
756 if ( *pc
== wxT('\\') )
758 // GTK 2.0 escapes "xxx/xxx" to "xxx\/xxx"
764 if ( (*pc
== wxT('&')) && (*(pc
+1) != wxT('&')) )
767 // "&" is doubled to indicate "&" instead of accelerator
774 // wxPrintf( wxT("GetLabelFromText(): text %s label %s\n"), text.c_str(), label.c_str() );
779 void wxMenuItem::SetText( const wxString
& str
)
781 // cache some data which must be used later
782 bool isstock
= wxIsStockID(GetId());
783 const char *stockid
= NULL
;
785 stockid
= wxGetStockGtkID(GetId());
787 // Some optimization to avoid flicker
788 wxString oldLabel
= m_text
;
789 oldLabel
= wxStripMenuCodes(oldLabel
);
790 oldLabel
.Replace(wxT("_"), wxT(""));
791 wxString label1
= wxStripMenuCodes(str
);
792 wxString oldhotkey
= GetHotKey(); // Store the old hotkey in Ctrl-foo format
793 wxCharBuffer oldbuf
= wxGTK_CONV_SYS( GetGtkHotKey(*this) ); // and as <control>foo
797 if (oldLabel
== label1
&&
798 oldhotkey
== GetHotKey()) // Make sure we can change a hotkey even if the label is unaltered
805 label
= (GtkLabel
*) m_labelWidget
;
807 label
= GTK_LABEL( GTK_BIN(m_menuItem
)->child
);
809 // stock menu items can have empty labels:
810 wxString text
= m_text
;
811 if (text
.IsEmpty() && !IsSeparator())
813 wxASSERT_MSG(isstock
, wxT("A non-stock menu item with an empty label?"));
814 text
= wxGetStockLabel(GetId());
816 // need & => _ conversion
817 text
= GTKProcessMenuItemLabel(text
, NULL
);
820 gtk_label_set_text_with_mnemonic( GTK_LABEL(label
), wxGTK_CONV_SYS(text
) );
823 // remove old accelerator from our parent's accelerator group, if present
825 GdkModifierType accel_mods
;
826 if (oldbuf
[(size_t)0] != '\0')
828 gtk_accelerator_parse( (const char*) oldbuf
, &accel_key
, &accel_mods
);
831 gtk_widget_remove_accelerator( GTK_WIDGET(m_menuItem
),
832 m_parentMenu
->m_accel
,
839 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
840 if (wxGetStockGtkAccelerator(stockid
, &accel_mods
, &accel_key
))
841 gtk_widget_remove_accelerator( GTK_WIDGET(m_menuItem
),
842 m_parentMenu
->m_accel
,
847 // add new accelerator to our parent's accelerator group
848 wxCharBuffer buf
= wxGTK_CONV_SYS( GetGtkHotKey(*this) );
849 if (buf
[(size_t)0] != '\0')
851 gtk_accelerator_parse( (const char*) buf
, &accel_key
, &accel_mods
);
854 gtk_widget_add_accelerator( GTK_WIDGET(m_menuItem
),
856 m_parentMenu
->m_accel
,
864 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
865 if (wxGetStockGtkAccelerator(stockid
, &accel_mods
, &accel_key
))
866 gtk_widget_remove_accelerator( GTK_WIDGET(m_menuItem
),
867 m_parentMenu
->m_accel
,
873 // NOTE: this function is different from the similar functions GTKProcessMnemonics()
874 // implemented in control.cpp and from wxMenuItemBase::GetLabelFromText...
875 // so there's no real code duplication
876 wxString
wxMenuItem::GTKProcessMenuItemLabel(const wxString
& str
, wxString
*hotKey
)
880 // '\t' is the deliminator indicating a hot key
881 const wxChar
*pc
= str
;
882 while ( (*pc
!= wxT('\0')) && (*pc
!= wxT('\t')) )
884 if ((*pc
== wxT('&')) && (*(pc
+1) == wxT('&')))
886 // "&" is doubled to indicate "&" instead of accelerator
890 else if (*pc
== wxT('&'))
894 else if ( *pc
== wxT('_') ) // escape underscores
918 // it's valid for this function to be called even if m_menuItem == NULL
919 void wxMenuItem::DoSetText( const wxString
& str
)
922 m_text
= GTKProcessMenuItemLabel(str
, &m_hotKey
);
923 // wxPrintf( wxT("DoSetText(): str %s m_text %s hotkey %s\n"), str.c_str(), m_text.c_str(), m_hotKey.c_str() );
928 wxAcceleratorEntry
*wxMenuItem::GetAccel() const
933 return (wxAcceleratorEntry
*)NULL
;
936 // as wxGetAccelFromString() looks for TAB, insert a dummy one here
938 label
<< wxT('\t') << GetHotKey();
940 return wxGetAccelFromString(label
);
943 #endif // wxUSE_ACCEL
945 void wxMenuItem::Check( bool check
)
947 wxCHECK_RET( m_menuItem
, wxT("invalid menu item") );
949 if (check
== m_isChecked
)
952 wxMenuItemBase::Check( check
);
958 gtk_check_menu_item_set_active( (GtkCheckMenuItem
*)m_menuItem
, (gint
)check
);
962 wxFAIL_MSG( _T("can't check this item") );
966 void wxMenuItem::Enable( bool enable
)
968 wxCHECK_RET( m_menuItem
, wxT("invalid menu item") );
970 gtk_widget_set_sensitive( m_menuItem
, enable
);
971 wxMenuItemBase::Enable( enable
);
974 bool wxMenuItem::IsChecked() const
976 wxCHECK_MSG( m_menuItem
, false, wxT("invalid menu item") );
978 wxCHECK_MSG( IsCheckable(), false,
979 wxT("can't get state of uncheckable item!") );
981 return ((GtkCheckMenuItem
*)m_menuItem
)->active
!= 0;
984 //-----------------------------------------------------------------------------
986 //-----------------------------------------------------------------------------
988 IMPLEMENT_DYNAMIC_CLASS(wxMenu
,wxEvtHandler
)
992 m_accel
= gtk_accel_group_new();
993 m_menu
= gtk_menu_new();
994 // NB: keep reference to the menu so that it is not destroyed behind
995 // our back by GTK+ e.g. when it is removed from menubar:
996 gtk_widget_ref(m_menu
);
998 m_owner
= (GtkWidget
*) NULL
;
1000 // Tearoffs are entries, just like separators. So if we want this
1001 // menu to be a tear-off one, we just append a tearoff entry
1003 if ( m_style
& wxMENU_TEAROFF
)
1005 GtkWidget
*tearoff
= gtk_tearoff_menu_item_new();
1007 gtk_menu_shell_append(GTK_MENU_SHELL(m_menu
), tearoff
);
1012 // append the title as the very first entry if we have it
1013 if ( !m_title
.empty() )
1015 Append(wxGTK_TITLE_ID
, m_title
);
1022 WX_CLEAR_LIST(wxMenuItemList
, m_items
);
1024 if ( GTK_IS_WIDGET( m_menu
))
1027 gtk_widget_unref( m_menu
);
1028 // if the menu is inserted in another menu at this time, there was
1029 // one more reference to it:
1031 gtk_widget_destroy( m_menu
);
1035 void wxMenu::SetLayoutDirection(const wxLayoutDirection dir
)
1038 wxWindow::GTKSetLayout(m_owner
, dir
);
1039 //else: will be called later by wxMenuBar again
1042 wxLayoutDirection
wxMenu::GetLayoutDirection() const
1044 return wxWindow::GTKGetLayout(m_owner
);
1047 bool wxMenu::GtkAppend(wxMenuItem
*mitem
, int pos
)
1049 GtkWidget
*menuItem
;
1051 // cache some data used later
1052 wxString text
= mitem
->GetText();
1053 int id
= mitem
->GetId();
1054 bool isstock
= wxIsStockID(id
);
1055 const char *stockid
= NULL
;
1057 stockid
= wxGetStockGtkID(mitem
->GetId());
1059 // stock menu items can have an empty label
1060 if (text
.IsEmpty() && !mitem
->IsSeparator())
1062 wxASSERT_MSG(isstock
, wxT("A non-stock menu item with an empty label?"));
1063 text
= wxGetStockLabel(id
);
1065 // need & => _ conversion
1066 text
= wxMenuItem::GTKProcessMenuItemLabel(text
, NULL
);
1069 if ( mitem
->IsSeparator() )
1071 menuItem
= gtk_separator_menu_item_new();
1073 else if ( mitem
->GetBitmap().Ok() ||
1074 (mitem
->GetKind() == wxITEM_NORMAL
&& isstock
) )
1076 wxBitmap
bitmap(mitem
->GetBitmap());
1078 menuItem
= gtk_image_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text
) );
1083 // use stock bitmap for this item if available on the assumption
1084 // that it never hurts to follow GTK+ conventions more closely
1085 image
= stockid
? gtk_image_new_from_stock(stockid
, GTK_ICON_SIZE_MENU
)
1088 else // we have a custom bitmap
1090 wxASSERT_MSG( mitem
->GetKind() == wxITEM_NORMAL
,
1091 _T("only normal menu items can have bitmaps") );
1093 if ( bitmap
.HasPixbuf() )
1095 image
= gtk_image_new_from_pixbuf(bitmap
.GetPixbuf());
1099 GdkPixmap
*gdk_pixmap
= bitmap
.GetPixmap();
1100 GdkBitmap
*gdk_bitmap
= bitmap
.GetMask() ?
1101 bitmap
.GetMask()->GetBitmap() :
1103 image
= gtk_image_new_from_pixmap( gdk_pixmap
, gdk_bitmap
);
1109 gtk_widget_show(image
);
1111 gtk_image_menu_item_set_image( GTK_IMAGE_MENU_ITEM(menuItem
), image
);
1116 else // a normal item
1118 // NB: 'text' variable has "_" instead of "&" after mitem->SetText()
1121 switch ( mitem
->GetKind() )
1125 menuItem
= gtk_check_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text
) );
1132 GSList
*group
= NULL
;
1133 if ( m_prevRadio
== NULL
)
1135 // start of a new radio group
1136 m_prevRadio
= menuItem
=
1137 gtk_radio_menu_item_new_with_mnemonic( group
, wxGTK_CONV_SYS( text
) );
1139 else // continue the radio group
1141 group
= gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (m_prevRadio
));
1142 m_prevRadio
= menuItem
=
1143 gtk_radio_menu_item_new_with_mnemonic( group
, wxGTK_CONV_SYS( text
) );
1149 wxFAIL_MSG( _T("unexpected menu item kind") );
1154 menuItem
= gtk_menu_item_new_with_mnemonic( wxGTK_CONV_SYS( text
) );
1163 GdkModifierType accel_mods
;
1164 wxCharBuffer buf
= wxGTK_CONV_SYS( GetGtkHotKey(*mitem
) );
1166 // wxPrintf( wxT("item: %s hotkey %s\n"), mitem->GetText().c_str(), GetGtkHotKey(*mitem).c_str() );
1167 if (buf
[(size_t)0] != '\0')
1169 gtk_accelerator_parse( (const char*) buf
, &accel_key
, &accel_mods
);
1172 gtk_widget_add_accelerator (GTK_WIDGET(menuItem
),
1182 // if the accelerator was taken from a stock ID, just get it back from GTK+ stock
1183 if (wxGetStockGtkAccelerator(stockid
, &accel_mods
, &accel_key
))
1184 gtk_widget_add_accelerator( GTK_WIDGET(menuItem
),
1193 gtk_menu_shell_append(GTK_MENU_SHELL(m_menu
), menuItem
);
1195 gtk_menu_shell_insert(GTK_MENU_SHELL(m_menu
), menuItem
, pos
);
1197 gtk_widget_show( menuItem
);
1199 if ( !mitem
->IsSeparator() )
1201 wxASSERT_MSG( menuItem
, wxT("invalid menuitem") );
1203 g_signal_connect (menuItem
, "select",
1204 G_CALLBACK (gtk_menu_hilight_callback
), this);
1205 g_signal_connect (menuItem
, "deselect",
1206 G_CALLBACK (gtk_menu_nolight_callback
), this);
1208 if ( mitem
->IsSubMenu() && mitem
->GetKind() != wxITEM_RADIO
&& mitem
->GetKind() != wxITEM_CHECK
)
1210 gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem
), mitem
->GetSubMenu()->m_menu
);
1212 gtk_widget_show( mitem
->GetSubMenu()->m_menu
);
1214 // if adding a submenu to a menu already existing in the menu bar, we
1215 // must set invoking window to allow processing events from this
1217 if ( m_invokingWindow
)
1218 wxMenubarSetInvokingWindow(mitem
->GetSubMenu(), m_invokingWindow
);
1222 g_signal_connect (menuItem
, "activate",
1223 G_CALLBACK (gtk_menu_clicked_callback
),
1228 mitem
->SetMenuItem(menuItem
);
1232 // This doesn't even exist!
1233 // gtk_widget_lock_accelerators(mitem->GetMenuItem());
1239 wxMenuItem
* wxMenu::DoAppend(wxMenuItem
*mitem
)
1241 if (!GtkAppend(mitem
))
1244 return wxMenuBase::DoAppend(mitem
);
1247 wxMenuItem
* wxMenu::DoInsert(size_t pos
, wxMenuItem
*item
)
1249 if ( !wxMenuBase::DoInsert(pos
, item
) )
1253 if ( !GtkAppend(item
, (int)pos
) )
1259 wxMenuItem
*wxMenu::DoRemove(wxMenuItem
*item
)
1261 if ( !wxMenuBase::DoRemove(item
) )
1262 return (wxMenuItem
*)NULL
;
1264 // TODO: this code doesn't delete the item factory item and this seems
1265 // impossible as of GTK 1.2.6.
1266 gtk_widget_destroy( item
->GetMenuItem() );
1271 int wxMenu::FindMenuIdByMenuItem( GtkWidget
*menuItem
) const
1273 wxMenuItemList::compatibility_iterator node
= m_items
.GetFirst();
1276 wxMenuItem
*item
= node
->GetData();
1277 if (item
->GetMenuItem() == menuItem
)
1278 return item
->GetId();
1279 node
= node
->GetNext();
1285 void wxMenu::Attach(wxMenuBarBase
*menubar
)
1287 wxMenuBase::Attach(menubar
);
1289 // inherit layout direction from menubar.
1290 SetLayoutDirection(menubar
->GetLayoutDirection());
1293 // ----------------------------------------------------------------------------
1295 // ----------------------------------------------------------------------------
1299 static wxString
GetGtkHotKey( const wxMenuItem
& item
)
1303 wxAcceleratorEntry
*accel
= item
.GetAccel();
1306 int flags
= accel
->GetFlags();
1307 if ( flags
& wxACCEL_ALT
)
1308 hotkey
+= wxT("<alt>");
1309 if ( flags
& wxACCEL_CTRL
)
1310 hotkey
+= wxT("<control>");
1311 if ( flags
& wxACCEL_SHIFT
)
1312 hotkey
+= wxT("<shift>");
1314 int code
= accel
->GetKeyCode();
1341 hotkey
+= wxString::Format(wxT("F%d"), code
- WXK_F1
+ 1);
1344 // TODO: we should use gdk_keyval_name() (a.k.a.
1345 // XKeysymToString) here as well as hardcoding the keysym
1346 // names this might be not portable
1348 hotkey
<< wxT("Insert" );
1351 hotkey
<< wxT("Delete" );
1354 hotkey
<< wxT("Up" );
1357 hotkey
<< wxT("Down" );
1360 hotkey
<< wxT("PgUp" );
1363 hotkey
<< wxT("PgDn" );
1366 hotkey
<< wxT("Left" );
1369 hotkey
<< wxT("Right" );
1372 hotkey
<< wxT("Home" );
1375 hotkey
<< wxT("End" );
1378 hotkey
<< wxT("Return" );
1381 hotkey
<< wxT("BackSpace" );
1384 hotkey
<< wxT("Tab" );
1387 hotkey
<< wxT("Esc" );
1390 hotkey
<< wxT("space" );
1393 hotkey
<< wxT("Multiply" );
1396 hotkey
<< wxT("Add" );
1399 hotkey
<< wxT("Separator" );
1402 hotkey
<< wxT("Subtract" );
1405 hotkey
<< wxT("Decimal" );
1408 hotkey
<< wxT("Divide" );
1411 hotkey
<< wxT("Cancel" );
1414 hotkey
<< wxT("Clear" );
1417 hotkey
<< wxT("Menu" );
1420 hotkey
<< wxT("Pause" );
1423 hotkey
<< wxT("Capital" );
1426 hotkey
<< wxT("Select" );
1429 hotkey
<< wxT("Print" );
1432 hotkey
<< wxT("Execute" );
1435 hotkey
<< wxT("Snapshot" );
1438 hotkey
<< wxT("Help" );
1441 hotkey
<< wxT("Num_Lock" );
1444 hotkey
<< wxT("Scroll_Lock" );
1446 case WXK_NUMPAD_INSERT
:
1447 hotkey
<< wxT("KP_Insert" );
1449 case WXK_NUMPAD_DELETE
:
1450 hotkey
<< wxT("KP_Delete" );
1452 case WXK_NUMPAD_SPACE
:
1453 hotkey
<< wxT("KP_Space" );
1455 case WXK_NUMPAD_TAB
:
1456 hotkey
<< wxT("KP_Tab" );
1458 case WXK_NUMPAD_ENTER
:
1459 hotkey
<< wxT("KP_Enter" );
1461 case WXK_NUMPAD_F1
: case WXK_NUMPAD_F2
: case WXK_NUMPAD_F3
:
1463 hotkey
+= wxString::Format(wxT("KP_F%d"), code
- WXK_NUMPAD_F1
+ 1);
1465 case WXK_NUMPAD_HOME
:
1466 hotkey
<< wxT("KP_Home" );
1468 case WXK_NUMPAD_LEFT
:
1469 hotkey
<< wxT("KP_Left" );
1472 hotkey
<< wxT("KP_Up" );
1474 case WXK_NUMPAD_RIGHT
:
1475 hotkey
<< wxT("KP_Right" );
1477 case WXK_NUMPAD_DOWN
:
1478 hotkey
<< wxT("KP_Down" );
1480 case WXK_NUMPAD_PAGEUP
:
1481 hotkey
<< wxT("KP_PgUp" );
1483 case WXK_NUMPAD_PAGEDOWN
:
1484 hotkey
<< wxT("KP_PgDn" );
1486 case WXK_NUMPAD_END
:
1487 hotkey
<< wxT("KP_End" );
1489 case WXK_NUMPAD_BEGIN
:
1490 hotkey
<< wxT("KP_Begin" );
1492 case WXK_NUMPAD_EQUAL
:
1493 hotkey
<< wxT("KP_Equal" );
1495 case WXK_NUMPAD_MULTIPLY
:
1496 hotkey
<< wxT("KP_Multiply" );
1498 case WXK_NUMPAD_ADD
:
1499 hotkey
<< wxT("KP_Add" );
1501 case WXK_NUMPAD_SEPARATOR
:
1502 hotkey
<< wxT("KP_Separator" );
1504 case WXK_NUMPAD_SUBTRACT
:
1505 hotkey
<< wxT("KP_Subtract" );
1507 case WXK_NUMPAD_DECIMAL
:
1508 hotkey
<< wxT("KP_Decimal" );
1510 case WXK_NUMPAD_DIVIDE
:
1511 hotkey
<< wxT("KP_Divide" );
1513 case WXK_NUMPAD0
: case WXK_NUMPAD1
: case WXK_NUMPAD2
:
1514 case WXK_NUMPAD3
: case WXK_NUMPAD4
: case WXK_NUMPAD5
:
1515 case WXK_NUMPAD6
: case WXK_NUMPAD7
: case WXK_NUMPAD8
: case WXK_NUMPAD9
:
1516 hotkey
+= wxString::Format(wxT("KP_%d"), code
- WXK_NUMPAD0
);
1518 case WXK_WINDOWS_LEFT
:
1519 hotkey
<< wxT("Super_L" );
1521 case WXK_WINDOWS_RIGHT
:
1522 hotkey
<< wxT("Super_R" );
1524 case WXK_WINDOWS_MENU
:
1525 hotkey
<< wxT("Menu" );
1528 hotkey
<< wxT("Command" );
1530 /* These probably wouldn't work as there is no SpecialX in gdk/keynames.txt
1531 case WXK_SPECIAL1: case WXK_SPECIAL2: case WXK_SPECIAL3: case WXK_SPECIAL4:
1532 case WXK_SPECIAL5: case WXK_SPECIAL6: case WXK_SPECIAL7: case WXK_SPECIAL8:
1533 case WXK_SPECIAL9: case WXK_SPECIAL10: case WXK_SPECIAL11: case WXK_SPECIAL12:
1534 case WXK_SPECIAL13: case WXK_SPECIAL14: case WXK_SPECIAL15: case WXK_SPECIAL16:
1535 case WXK_SPECIAL17: case WXK_SPECIAL18: case WXK_SPECIAL19: case WXK_SPECIAL20:
1536 hotkey += wxString::Format(wxT("Special%d"), code - WXK_SPECIAL1 + 1);
1539 // if there are any other keys wxGetAccelFromString() may
1540 // return, we should process them here
1545 wxString name
= wxGTK_CONV_BACK( gdk_keyval_name((guint
)code
) );
1553 wxFAIL_MSG( wxT("unknown keyboard accel") );
1562 #endif // wxUSE_ACCEL
1564 // ----------------------------------------------------------------------------
1565 // Pop-up menu stuff
1566 // ----------------------------------------------------------------------------
1568 #if wxUSE_MENUS_NATIVE
1570 extern "C" WXDLLIMPEXP_CORE
1571 void gtk_pop_hide_callback( GtkWidget
*WXUNUSED(widget
), bool* is_waiting
)
1573 *is_waiting
= false;
1576 WXDLLIMPEXP_CORE
void SetInvokingWindow( wxMenu
*menu
, wxWindow
* win
)
1578 menu
->SetInvokingWindow( win
);
1580 wxMenuItemList::compatibility_iterator node
= menu
->GetMenuItems().GetFirst();
1583 wxMenuItem
*menuitem
= node
->GetData();
1584 if (menuitem
->IsSubMenu())
1586 SetInvokingWindow( menuitem
->GetSubMenu(), win
);
1589 node
= node
->GetNext();
1593 extern "C" WXDLLIMPEXP_CORE
1594 void wxPopupMenuPositionCallback( GtkMenu
*menu
,
1596 gboolean
* WXUNUSED(whatever
),
1597 gpointer user_data
)
1599 // ensure that the menu appears entirely on screen
1601 gtk_widget_get_child_requisition(GTK_WIDGET(menu
), &req
);
1603 wxSize sizeScreen
= wxGetDisplaySize();
1604 wxPoint
*pos
= (wxPoint
*)user_data
;
1606 gint xmax
= sizeScreen
.x
- req
.width
,
1607 ymax
= sizeScreen
.y
- req
.height
;
1609 *x
= pos
->x
< xmax
? pos
->x
: xmax
;
1610 *y
= pos
->y
< ymax
? pos
->y
: ymax
;
1613 bool wxWindowGTK::DoPopupMenu( wxMenu
*menu
, int x
, int y
)
1615 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid window") );
1617 wxCHECK_MSG( menu
!= NULL
, false, wxT("invalid popup-menu") );
1619 // NOTE: if you change this code, you need to update
1620 // the same code in taskbar.cpp as well. This
1621 // is ugly code duplication, I know.
1623 SetInvokingWindow( menu
, this );
1627 bool is_waiting
= true;
1629 gulong handler
= g_signal_connect (menu
->m_menu
, "hide",
1630 G_CALLBACK (gtk_pop_hide_callback
),
1635 GtkMenuPositionFunc posfunc
;
1636 if ( x
== -1 && y
== -1 )
1638 // use GTK's default positioning algorithm
1644 pos
= ClientToScreen(wxPoint(x
, y
));
1646 posfunc
= wxPopupMenuPositionCallback
;
1649 wxMenuEvent
eventOpen(wxEVT_MENU_OPEN
, -1, menu
);
1650 DoCommonMenuCallbackCode(menu
, eventOpen
);
1653 GTK_MENU(menu
->m_menu
),
1654 (GtkWidget
*) NULL
, // parent menu shell
1655 (GtkWidget
*) NULL
, // parent menu item
1656 posfunc
, // function to position it
1657 userdata
, // client data
1658 0, // button used to activate it
1659 gtk_get_current_event_time()
1664 gtk_main_iteration();
1667 g_signal_handler_disconnect (menu
->m_menu
, handler
);
1669 wxMenuEvent
eventClose(wxEVT_MENU_CLOSE
, -1, menu
);
1670 DoCommonMenuCallbackCode(menu
, eventClose
);
1675 #endif // wxUSE_MENUS_NATIVE