// Name: src/gtk/menu.cpp
// Purpose: implementation of wxMenuBar and wxMenu classes for wxGTK
// Author: Robert Roebling
-// Id: $Id$
// Copyright: (c) 1998 Robert Roebling
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef WX_PRECOMP
#include "wx/intl.h"
#include "wx/log.h"
+ #include "wx/dialog.h"
#include "wx/frame.h"
#include "wx/bitmap.h"
#include "wx/app.h"
#include "wx/accel.h"
#include "wx/stockitem.h"
+
+#include <gtk/gtk.h>
#include "wx/gtk/private.h"
+#include "wx/gtk/private/gtk2-compat.h"
#include "wx/gtk/private/mnemonics.h"
+// Number of currently open modal dialogs, defined in src/gtk/toplevel.cpp.
+extern int wxOpenModalDialogsCount;
+
// we use normal item but with a special id for the menu title
static const int wxGTK_TITLE_ID = -3;
static void wxGetGtkAccel(const wxMenuItem*, guint*, GdkModifierType*);
#endif
+// Unity hack: under Ubuntu Unity the global menu bar is not affected by a
+// modal dialog being shown, so the user can select a menu item before hiding
+// the dialog and, in particular, a new instance of the same dialog can be
+// shown again, breaking a lot of programs not expecting this.
+//
+// So explicitly ignore any menu events generated while any modal dialogs
+// are opened except for the events generated by a context menu within the
+// modal dialog itself that should have a dialog as their invoking window.
+static bool IsMenuEventAllowed(wxMenu* menu)
+{
+ if ( wxOpenModalDialogsCount )
+ {
+ wxWindow* tlw = wxGetTopLevelParent(menu->GetWindow());
+ if ( !tlw || !wxDynamicCast(tlw, wxDialog) )
+ {
+ // This must be an event from a menu bar of one of the frames.
+ return false;
+ }
+ }
+
+ return true;
+}
+
static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
{
+ if ( !IsMenuEventAllowed(menu) )
+ return;
+
event.SetEventObject( menu );
wxEvtHandler* handler = menu->GetEventHandler();
if (handler && handler->SafelyProcessEvent(event))
return;
- wxWindow *win = menu->GetInvokingWindow();
- if (win)
- win->HandleWindowEvent( event );
+ wxWindow *win = menu->GetWindow();
+ wxCHECK_RET( win, "event for a menu without associated window?" );
+
+ win->HandleWindowEvent( event );
}
//-----------------------------------------------------------------------------
// wxMenuBar
//-----------------------------------------------------------------------------
-IMPLEMENT_DYNAMIC_CLASS(wxMenuBar,wxWindow)
+wxMenuBar::~wxMenuBar()
+{
+}
void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
{
- m_invokingWindow = NULL;
-
#if wxUSE_LIBHILDON || wxUSE_LIBHILDON2
// Hildon window uses a single menu instead of a menu bar, so wxMenuBar is
// the same as menu in this case
}
PostCreation();
-
- GTKApplyWidgetStyle();
#endif // wxUSE_LIBHILDON || wxUSE_LIBHILDON2/!wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
- g_object_ref(m_widget);
+ g_object_ref_sink(m_widget);
for (size_t i = 0; i < n; ++i )
Append(menus[i], titles[i]);
Init(0, NULL, NULL, 0);
}
-static void
-wxMenubarUnsetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
+// recursive helpers for wxMenuBar::Attach() and Detach(): they are called to
+// associate the menus with the frame they belong to or dissociate them from it
+namespace
{
- menu->SetInvokingWindow( NULL );
+// This should be called when detaching menus to ensure that they don't keep
+// focus grab, because if they do, they continue getting all GTK+ messages
+// which they can't process any more in their (soon to be) unrealized state.
+void
+EnsureNoGrab(GtkWidget* widget)
+{
+#if !wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
+ gtk_widget_hide(widget);
+ gtk_grab_remove(widget);
+#endif // !wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
+}
+
+void
+DetachFromFrame(wxMenu* menu, wxFrame* frame)
+{
// support for native hot keys
if (menu->m_accel)
{
- if (tlw == NULL)
- tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
- if (g_slist_find(menu->m_accel->acceleratables, tlw))
+ // Note that wxGetTopLevelParent() is really needed because this frame
+ // can be an MDI child frame which is a fake frame and not a TLW at all
+ GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
+ if (g_slist_find(gtk_accel_groups_from_object(G_OBJECT(tlw)), menu->m_accel))
gtk_window_remove_accel_group(tlw, menu->m_accel);
}
{
wxMenuItem *menuitem = node->GetData();
if (menuitem->IsSubMenu())
- wxMenubarUnsetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
+ DetachFromFrame(menuitem->GetSubMenu(), frame);
node = node->GetNext();
}
+
+ EnsureNoGrab(menu->m_menu);
}
-static void
-wxMenubarSetInvokingWindow(wxMenu* menu, wxWindow* win, GtkWindow* tlw = NULL)
+void
+AttachToFrame(wxMenu* menu, wxFrame* frame)
{
- menu->SetInvokingWindow( win );
-
// support for native hot keys
if (menu->m_accel)
{
- if (tlw == NULL)
- tlw = GTK_WINDOW(wxGetTopLevelParent(win)->m_widget);
- if (!g_slist_find(menu->m_accel->acceleratables, tlw))
+ GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
+ if (!g_slist_find(gtk_accel_groups_from_object(G_OBJECT(tlw)), menu->m_accel))
gtk_window_add_accel_group(tlw, menu->m_accel);
}
{
wxMenuItem *menuitem = node->GetData();
if (menuitem->IsSubMenu())
- wxMenubarSetInvokingWindow(menuitem->GetSubMenu(), win, tlw);
+ AttachToFrame(menuitem->GetSubMenu(), frame);
node = node->GetNext();
}
}
-void wxMenuBar::SetInvokingWindow( wxWindow *win )
-{
- m_invokingWindow = win;
-
- wxMenuList::compatibility_iterator node = m_menus.GetFirst();
- while (node)
- {
- wxMenu *menu = node->GetData();
- wxMenubarSetInvokingWindow( menu, win );
- node = node->GetNext();
- }
-}
+} // anonymous namespace
void wxMenuBar::SetLayoutDirection(wxLayoutDirection dir)
{
{
wxMenuBarBase::Attach(frame);
+ wxMenuList::compatibility_iterator node = m_menus.GetFirst();
+ while (node)
+ {
+ wxMenu *menu = node->GetData();
+ AttachToFrame( menu, frame );
+ node = node->GetNext();
+ }
+
SetLayoutDirection(wxLayout_Default);
}
-void wxMenuBar::UnsetInvokingWindow( wxWindow *win )
+void wxMenuBar::Detach()
{
- m_invokingWindow = NULL;
-
wxMenuList::compatibility_iterator node = m_menus.GetFirst();
while (node)
{
wxMenu *menu = node->GetData();
- wxMenubarUnsetInvokingWindow( menu, win );
+ DetachFromFrame( menu, m_menuBarFrame );
node = node->GetNext();
}
+
+ EnsureNoGrab(m_widget);
+
+ wxMenuBarBase::Detach();
}
bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
{
- if ( !wxMenuBarBase::Append( menu, title ) )
- return false;
-
- return GtkAppend(menu, title);
+ if (wxMenuBarBase::Append(menu, title))
+ {
+ GtkAppend(menu, title);
+ return true;
+ }
+ return false;
}
-bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
+void wxMenuBar::GtkAppend(wxMenu* menu, const wxString& title, int pos)
{
menu->SetLayoutDirection(GetLayoutDirection());
const wxString str(wxStripMenuCodes(item->GetItemLabel()));
if ( item->IsSubMenu() )
- return GtkAppend(item->GetSubMenu(), str, pos);
+ {
+ GtkAppend(item->GetSubMenu(), str, pos);
+ return;
+ }
menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
else
#endif // wxUSE_LIBHILDON || wxUSE_LIBHILDON2 /!wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
{
- const wxString str(wxConvertMnemonicsToGTK(title));
-
// This doesn't have much effect right now.
- menu->SetTitle( str );
+ menu->SetTitle( title );
+ const wxString str(wxConvertMnemonicsToGTK(title));
// The "m_owner" is the "menu item"
menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
gtk_menu_item_set_submenu( GTK_MENU_ITEM(menu->m_owner), menu->m_menu );
}
+ g_object_ref(menu->m_owner);
gtk_widget_show( menu->m_owner );
else
gtk_menu_shell_insert( GTK_MENU_SHELL(m_menubar), menu->m_owner, pos );
- // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
- // addings menu later on.
- if (m_invokingWindow)
- wxMenubarSetInvokingWindow( menu, m_invokingWindow );
-
- return true;
+ if ( m_menuBarFrame )
+ AttachToFrame( menu, m_menuBarFrame );
}
bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
{
- if ( !wxMenuBarBase::Insert(pos, menu, title) )
- return false;
-
- // TODO
-
- if ( !GtkAppend(menu, title, (int)pos) )
- return false;
-
- return true;
+ if (wxMenuBarBase::Insert(pos, menu, title))
+ {
+ GtkAppend(menu, title, int(pos));
+ return true;
+ }
+ return false;
}
wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
if ( !menu )
return NULL;
- gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
+ // remove item from menubar before destroying item to avoid spurious
+ // warnings from Ubuntu libdbusmenu
gtk_container_remove(GTK_CONTAINER(m_menubar), menu->m_owner);
+ // remove submenu to avoid destroying it when item is destroyed
+#ifdef __WXGTK3__
+ gtk_menu_item_set_submenu(GTK_MENU_ITEM(menu->m_owner), NULL);
+#else
+ gtk_menu_item_remove_submenu(GTK_MENU_ITEM(menu->m_owner));
+#endif
gtk_widget_destroy( menu->m_owner );
+ g_object_unref(menu->m_owner);
menu->m_owner = NULL;
- if (m_invokingWindow)
- wxMenubarUnsetInvokingWindow( menu, m_invokingWindow );
+ if ( m_menuBarFrame )
+ DetachFromFrame( menu, m_menuBarFrame );
return menu;
}
static int FindMenuItemRecursive( const wxMenu *menu, const wxString &menuString, const wxString &itemString )
{
- if (wxMenuItem::GetLabelText(wxConvertMnemonicsFromGTK(menu->GetTitle())) == wxMenuItem::GetLabelText(menuString))
+ if (wxMenuItem::GetLabelText(menu->GetTitle()) == wxMenuItem::GetLabelText(menuString))
{
int res = menu->FindItem( itemString );
if (res != wxNOT_FOUND)
gtk_widget_set_sensitive( menu->m_owner, flag );
}
+bool wxMenuBar::IsEnabledTop(size_t pos) const
+{
+ wxMenuList::compatibility_iterator node = m_menus.Item( pos );
+ wxCHECK_MSG( node, false, wxS("invalid index in IsEnabledTop") );
+ wxMenu* const menu = node->GetData();
+ wxCHECK_MSG( menu->m_owner, true, wxS("no menu owner?") );
+ return gtk_widget_get_sensitive( menu->m_owner ) != 0;
+}
+
wxString wxMenuBar::GetMenuLabel( size_t pos ) const
{
wxMenuList::compatibility_iterator node = m_menus.Item( pos );
wxMenu* menu = node->GetData();
- return wxConvertMnemonicsFromGTK(menu->GetTitle());
+ return menu->GetTitle();
}
void wxMenuBar::SetMenuLabel( size_t pos, const wxString& label )
wxMenu* menu = node->GetData();
- const wxString str(wxConvertMnemonicsToGTK(label));
-
- menu->SetTitle( str );
+ menu->SetTitle( label );
+ const wxString str(wxConvertMnemonicsToGTK(label));
if (menu->m_owner)
- gtk_label_set_text_with_mnemonic( GTK_LABEL( GTK_BIN(menu->m_owner)->child), wxGTK_CONV(str) );
+ gtk_label_set_text_with_mnemonic(GTK_LABEL(gtk_bin_get_child(GTK_BIN(menu->m_owner))), wxGTK_CONV(str));
}
//-----------------------------------------------------------------------------
if (!item->IsEnabled())
return;
+ if ( !IsMenuEventAllowed(item->GetMenu()) )
+ return;
+
int id = item->GetId();
if (id == wxGTK_TITLE_ID)
{
wxMenu* menu = item->GetMenu();
menu->SendEvent(id, item->IsCheckable() ? item->IsChecked() : -1);
+
+ // A lot of existing code, including any program that closes its main
+ // window from a menu handler and expects the program to exit -- as our own
+ // minimal sample -- relies on getting an idle event after a menu event.
+ // But when using Ubuntu Unity detached menus, we get called from a DBUS
+ // handler called from g_timeout_dispatch() and Glib doesn't send us any
+ // idle events after it. So ask explicitly for an idle event to get one.
+ wxWakeUpIdle();
}
}
// wxMenuItem
//-----------------------------------------------------------------------------
-IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
-
wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
int id,
const wxString& name,
wxMenuItem::~wxMenuItem()
{
+ if (m_menuItem)
+ g_object_unref(m_menuItem);
// don't delete menu items, the menus take care of that
}
+void wxMenuItem::SetMenuItem(GtkWidget* menuItem)
+{
+ if (m_menuItem)
+ g_object_unref(m_menuItem);
+ m_menuItem = menuItem;
+ if (menuItem)
+ g_object_ref(menuItem);
+}
+
void wxMenuItem::SetItemLabel( const wxString& str )
{
#if wxUSE_ACCEL
void wxMenuItem::SetGtkLabel()
{
const wxString text = wxConvertMnemonicsToGTK(m_text.BeforeFirst('\t'));
- GtkLabel* label = GTK_LABEL(GTK_BIN(m_menuItem)->child);
+ GtkLabel* label = GTK_LABEL(gtk_bin_get_child(GTK_BIN(m_menuItem)));
gtk_label_set_text_with_mnemonic(label, wxGTK_CONV_SYS(text));
#if wxUSE_ACCEL
guint accel_key;
if (m_kind == wxITEM_NORMAL)
m_bitmap = bitmap;
else
+ {
wxFAIL_MSG("only normal menu items can have bitmaps");
+ }
}
void wxMenuItem::Check( bool check )
wxCHECK_MSG( IsCheckable(), false,
wxT("can't get state of uncheckable item!") );
- return ((GtkCheckMenuItem*)m_menuItem)->active != 0;
+ return gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(m_menuItem)) != 0;
}
//-----------------------------------------------------------------------------
// "hide" from m_menu
static void menu_hide(GtkWidget*, wxMenu* menu)
{
+ // When using Ubuntu Unity desktop environment we get "hide" signal even
+ // when the window is not shown yet because Unity hides all the menus to
+ // show them only in the global menu bar. Just ignore this even instead of
+ // crashing in DoCommonMenuCallbackCode().
+ if ( !menu->GetWindow() )
+ return;
+
wxMenuEvent event(wxEVT_MENU_CLOSE, menu->m_popupShown ? -1 : 0, menu);
menu->m_popupShown = false;
DoCommonMenuCallbackCode(menu, event);
}
}
-IMPLEMENT_DYNAMIC_CLASS(wxMenu,wxEvtHandler)
-
void wxMenu::Init()
{
m_popupShown = false;
m_accel = gtk_accel_group_new();
m_menu = gtk_menu_new();
- // NB: keep reference to the menu so that it is not destroyed behind
- // our back by GTK+ e.g. when it is removed from menubar:
- g_object_ref(m_menu);
- gtk_object_sink(GTK_OBJECT(m_menu));
+ g_object_ref_sink(m_menu);
m_owner = NULL;
gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
}
- m_prevRadio = NULL;
-
// append the title as the very first entry if we have it
if ( !m_title.empty() )
{
wxMenu::~wxMenu()
{
- // see wxMenu::Init
- g_object_unref(m_menu);
+ // Destroying a menu generates a "hide" signal even if it's not shown
+ // currently, so disconnect it to avoid dummy wxEVT_MENU_CLOSE events
+ // generation.
+ g_signal_handlers_disconnect_matched(m_menu,
+ GSignalMatchType(G_SIGNAL_MATCH_DATA), 0, 0, NULL, NULL, this);
- // if the menu is inserted in another menu at this time, there was
- // one more reference to it:
if (m_owner)
- gtk_widget_destroy(m_menu);
+ {
+ gtk_widget_destroy(m_owner);
+ g_object_unref(m_owner);
+ }
+ else
+ gtk_widget_destroy(m_menu);
+ g_object_unref(m_menu);
g_object_unref(m_accel);
}
return wxWindow::GTKGetLayout(m_owner);
}
-bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
+wxString wxMenu::GetTitle() const
+{
+ return wxConvertMnemonicsFromGTK(wxMenuBase::GetTitle());
+}
+
+void wxMenu::SetTitle(const wxString& title)
+{
+ wxMenuBase::SetTitle(wxConvertMnemonicsToGTK(title));
+}
+
+void wxMenu::GtkAppend(wxMenuItem* mitem, int pos)
{
GtkWidget *menuItem;
- GtkWidget* prevRadio = m_prevRadio;
- m_prevRadio = NULL;
switch (mitem->GetKind())
{
case wxITEM_SEPARATOR:
break;
case wxITEM_RADIO:
{
+ // See if we need to create a new radio group for this item or
+ // add it to an existing one.
+ wxMenuItem* radioGroupItem = NULL;
+
+ const size_t numItems = GetMenuItemCount();
+ const size_t n = pos == -1 ? numItems - 1 : size_t(pos);
+
+ if (n != 0)
+ {
+ wxMenuItem* const itemPrev = FindItemByPosition(n - 1);
+ if ( itemPrev->GetKind() == wxITEM_RADIO )
+ {
+ // Appending an item after an existing radio item puts
+ // it into the same radio group.
+ radioGroupItem = itemPrev;
+ }
+ }
+
+ if (radioGroupItem == NULL && n != numItems - 1)
+ {
+ wxMenuItem* const itemNext = FindItemByPosition(n + 1);
+ if ( itemNext->GetKind() == wxITEM_RADIO )
+ {
+ // Inserting an item before an existing radio item
+ // also puts it into the existing radio group.
+ radioGroupItem = itemNext;
+ }
+ }
+
GSList* group = NULL;
- if (prevRadio)
- group = gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(prevRadio));
+ if ( radioGroupItem )
+ {
+ group = gtk_radio_menu_item_get_group(
+ GTK_RADIO_MENU_ITEM(radioGroupItem->GetMenuItem())
+ );
+ }
+
menuItem = gtk_radio_menu_item_new_with_label(group, "");
- m_prevRadio = menuItem;
}
break;
default:
gtk_menu_item_set_submenu( GTK_MENU_ITEM(menuItem), mitem->GetSubMenu()->m_menu );
gtk_widget_show( mitem->GetSubMenu()->m_menu );
-
- // if adding a submenu to a menu already existing in the menu bar, we
- // must set invoking window to allow processing events from this
- // submenu
- if ( m_invokingWindow )
- wxMenubarSetInvokingWindow(mitem->GetSubMenu(), m_invokingWindow);
}
else
{
mitem);
}
}
-
- return true;
}
wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
{
- if (!GtkAppend(mitem))
- return NULL;
-
- return wxMenuBase::DoAppend(mitem);
+ if (wxMenuBase::DoAppend(mitem))
+ {
+ GtkAppend(mitem);
+ return mitem;
+ }
+ return NULL;
}
wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
{
- if ( !wxMenuBase::DoInsert(pos, item) )
- return NULL;
-
- // TODO
- if ( !GtkAppend(item, (int)pos) )
- return NULL;
-
- return item;
+ if (wxMenuBase::DoInsert(pos, item))
+ {
+ GtkAppend(item, int(pos));
+ return item;
+ }
+ return NULL;
}
wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
return NULL;
GtkWidget * const mitem = item->GetMenuItem();
- if ( m_prevRadio == mitem )
- {
- // deleting an item starts a new radio group (has to as we shouldn't
- // keep a deleted pointer anyhow)
- m_prevRadio = NULL;
- }
+ g_signal_handlers_disconnect_matched(mitem,
+ GSignalMatchType(G_SIGNAL_MATCH_DATA), 0, 0, NULL, NULL, item);
+
+#ifdef __WXGTK3__
gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
+#else
+ gtk_menu_item_remove_submenu(GTK_MENU_ITEM(mitem));
+#endif
+
gtk_widget_destroy(mitem);
item->SetMenuItem(NULL);
case wx: \
return gtk;
- #if GTK_CHECK_VERSION(2,6,0)
- #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
- #else
- #define STOCKITEM_26(wx,gtk)
- #endif
-
#if GTK_CHECK_VERSION(2,8,0)
#define STOCKITEM_28(wx,gtk) STOCKITEM(wx,gtk)
#else
switch (id)
{
- STOCKITEM_26(wxID_ABOUT, GTK_STOCK_ABOUT)
+ STOCKITEM(wxID_ABOUT, GTK_STOCK_ABOUT)
STOCKITEM(wxID_ADD, GTK_STOCK_ADD)
STOCKITEM(wxID_APPLY, GTK_STOCK_APPLY)
STOCKITEM(wxID_BACKWARD, GTK_STOCK_GO_BACK)
STOCKITEM(wxID_CUT, GTK_STOCK_CUT)
STOCKITEM(wxID_DELETE, GTK_STOCK_DELETE)
STOCKITEM(wxID_DOWN, GTK_STOCK_GO_DOWN)
- STOCKITEM_26(wxID_EDIT, GTK_STOCK_EDIT)
+ STOCKITEM(wxID_EDIT, GTK_STOCK_EDIT)
STOCKITEM(wxID_EXECUTE, GTK_STOCK_EXECUTE)
STOCKITEM(wxID_EXIT, GTK_STOCK_QUIT)
- STOCKITEM_26(wxID_FILE, GTK_STOCK_FILE)
+ STOCKITEM(wxID_FILE, GTK_STOCK_FILE)
STOCKITEM(wxID_FIND, GTK_STOCK_FIND)
STOCKITEM(wxID_FIRST, GTK_STOCK_GOTO_FIRST)
STOCKITEM(wxID_FLOPPY, GTK_STOCK_FLOPPY)