]> git.saurik.com Git - wxWidgets.git/blobdiff - src/motif/menu.cpp
Fix ribbon documentation warnings.
[wxWidgets.git] / src / motif / menu.cpp
index 61f37764db380bd1e2c95b53769918dba65ecc87..cecd53cf3ccf16035ce7e59ccb4fa3cc97b39ae7 100644 (file)
@@ -1,23 +1,17 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        menu.cpp
+// Name:        src/motif/menu.cpp
 // Purpose:     wxMenu, wxMenuBar, wxMenuItem
 // Author:      Julian Smart
 // Modified by:
 // Created:     17/09/98
-// RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
 // ============================================================================
 // declarations
 // ============================================================================
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "menu.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
-#include "wx/defs.h"
-
 #include "wx/menu.h"
-#include "wx/menuitem.h"
-#include "wx/log.h"
-#include "wx/utils.h"
-#include "wx/app.h"
-#include "wx/frame.h"
-#include "wx/settings.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/utils.h"
+    #include "wx/frame.h"
+    #include "wx/settings.h"
+    #include "wx/menuitem.h"
+#endif
 
 #ifdef __VMS__
 #pragma message disable nosimpint
-#define XtDisplay XTDISPLAY
-#define XtWindow XTWINDOW
 #endif
 #include <Xm/Label.h>
 #include <Xm/LabelG.h>
@@ -58,9 +51,6 @@
 // other standard headers
 #include <string.h>
 
-IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
-IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler)
-
 // ============================================================================
 // implementation
 // ============================================================================
@@ -78,7 +68,7 @@ void wxMenu::Init()
     m_popupShell = (WXWidget) NULL;
     m_buttonWidget = (WXWidget) NULL;
     m_menuId = 0;
-    m_topLevelMenu  = (wxMenu*) NULL;
+    m_topLevelMenu  = NULL;
     m_ownedByMenuBar = false;
 
     if ( !m_title.empty() )
@@ -86,10 +76,6 @@ void wxMenu::Init()
         Append(-3, m_title) ;
         AppendSeparator() ;
     }
-
-    m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENU);
-    m_foregroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENUTEXT);
-    m_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 }
 
 // The wxWindow destructor will take care of deleting the submenus.
@@ -119,18 +105,7 @@ void wxMenu::Break()
 // function appends a new item or submenu to the menu
 wxMenuItem* wxMenu::DoAppend(wxMenuItem *pItem)
 {
-    if (m_menuWidget)
-    {
-        // this is a dynamic Append
-        pItem->CreateItem(m_menuWidget, GetMenuBar(), m_topLevelMenu);
-    }
-
-    if ( pItem->IsSubMenu() )
-    {
-        pItem->GetSubMenu()->m_topLevelMenu = m_topLevelMenu;
-    }
-
-    return wxMenuBase::DoAppend(pItem);
+    return DoInsert(GetMenuItemCount(), pItem);
 }
 
 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
@@ -142,12 +117,22 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
 
 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
 {
-    if ( wxMenuBase::DoInsert(pos, item) )
-        return item;
+    if (m_menuWidget)
+    {
+        // this is a dynamic Append
+#ifndef XmNpositionIndex
+    wxCHECK_MSG( pos == GetMenuItemCount(), -1, wxT("insert not implemented"));
+#endif
+        item->CreateItem(m_menuWidget, GetMenuBar(), m_topLevelMenu, pos);
+    }
 
-    wxFAIL_MSG(wxT("DoInsert not implemented; or error in wxMenuBase::DoInsert"));
+    if ( item->IsSubMenu() )
+    {
+        item->GetSubMenu()->m_topLevelMenu = m_topLevelMenu;
+    }
 
-    return NULL;
+    return pos == GetMenuItemCount() ? wxMenuBase::DoAppend(item) :
+                                       wxMenuBase::DoInsert(pos, item);
 }
 
 void wxMenu::SetTitle(const wxString& label)
@@ -171,17 +156,14 @@ void wxMenu::SetTitle(const wxString& label)
 
 bool wxMenu::ProcessCommand(wxCommandEvent & event)
 {
-    bool processed = false;
+    // Try the menu's event handler first
+    wxEvtHandler * const handler = GetEventHandler();
+    bool processed = handler ? handler->SafelyProcessEvent(event) : false;
 
-    // Try the menu's event handler
-    if ( !processed && GetEventHandler())
-    {
-        processed = GetEventHandler()->ProcessEvent(event);
-    }
     // Try the window the menu was popped up from (and up
     // through the hierarchy)
     if ( !processed && GetInvokingWindow())
-        processed = GetInvokingWindow()->ProcessEvent(event);
+        processed = GetInvokingWindow()->HandleWindowEvent(event);
 
     return processed;
 }
@@ -195,9 +177,6 @@ void wxMenuBar::Init()
     m_eventHandler = this;
     m_menuBarFrame = NULL;
     m_mainWidget = (WXWidget) NULL;
-    m_backgroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENU);
-    m_foregroundColour = wxSystemSettings::GetColour(wxSYS_COLOUR_MENUTEXT);
-    m_font = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
 }
 
 wxMenuBar::wxMenuBar(size_t n, wxMenu *menus[], const wxArrayString& titles, long WXUNUSED(style))
@@ -233,7 +212,7 @@ void wxMenuBar::EnableTop(size_t WXUNUSED(pos), bool WXUNUSED(flag))
 //  wxLogWarning("wxMenuBar::EnableTop not yet implemented.");
 }
 
-void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
+void wxMenuBar::SetMenuLabel(size_t pos, const wxString& label)
 {
     wxMenu *menu = GetMenu(pos);
     if ( !menu )
@@ -248,54 +227,39 @@ void wxMenuBar::SetLabelTop(size_t pos, const wxString& label)
                       XmNlabelString, label_str(),
                       NULL);
     }
+    m_titles[pos] = label;
 }
 
-wxString wxMenuBar::GetLabelTop(size_t pos) const
+wxString wxMenuBar::GetMenuLabel(size_t pos) const
 {
-    wxMenu *menu = GetMenu(pos);
-    if ( menu )
-    {
-        Widget w = (Widget)menu->GetButtonWidget();
-        if (w)
-        {
-            XmString text;
-            XtVaGetValues(w,
-                          XmNlabelString, &text,
-                          NULL);
-
-            return wxXmStringToString( text );
-        }
-    }
-
-    return wxEmptyString;
+    wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString,
+                 wxT("invalid menu index in wxMenuBar::GetMenuLabel") );
+    return m_titles[pos];
 }
 
 bool wxMenuBar::Append(wxMenu * menu, const wxString& title)
 {
+    return Insert(GetMenuCount(), menu, title);
+}
+
+bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
+{
+    wxCHECK_MSG( pos <= GetMenuCount(), false, wxT("invalid position") );
     wxCHECK_MSG( menu, false, wxT("invalid menu") );
     wxCHECK_MSG( !menu->GetParent() && !menu->GetButtonWidget(), false,
                  wxT("menu already appended") );
 
     if ( m_menuBarFrame )
     {
-        WXWidget w = menu->CreateMenu(this, GetMainWidget(), menu, title, true);
+        WXWidget w = menu->CreateMenu(this, GetMainWidget(), menu,
+                                      pos, title, true);
         wxCHECK_MSG( w, false, wxT("failed to create menu") );
         menu->SetButtonWidget(w);
     }
 
-    m_titles.Add(title);
-
-    return wxMenuBarBase::Append(menu, title);
-}
-
-bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
-{
-    if ( !wxMenuBarBase::Insert(pos, menu, title) )
-        return false;
-
-    wxFAIL_MSG(wxT("TODO"));
+    m_titles.Insert(title, pos);
 
-    return false;
+    return wxMenuBarBase::Insert(pos, menu, title);
 }
 
 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
@@ -326,20 +290,17 @@ wxMenu *wxMenuBar::Remove(size_t pos)
 
 // Find the menu menuString, item itemString, and return the item id.
 // Returns -1 if none found.
-int wxMenuBar::FindMenuItem (const wxString& menuString, const wxString& itemString) const
+int wxMenuBar::FindMenuItem(const wxString& menuString, const wxString& itemString) const
 {
-    char buf1[200];
-    char buf2[200];
-    wxStripMenuCodes (wxConstCast(menuString.c_str(), char), buf1);
+    const wxString stripped = wxStripMenuCodes(menuString);
 
     size_t menuCount = GetMenuCount();
     for (size_t i = 0; i < menuCount; i++)
     {
-        wxStripMenuCodes (wxConstCast(m_titles[i].c_str(), char), buf2);
-        if (strcmp (buf1, buf2) == 0)
+        if ( wxStripMenuCodes(m_titles[i]) == stripped )
             return m_menus.Item(i)->GetData()->FindItem (itemString);
     }
-    return -1;
+    return wxNOT_FOUND;
 }
 
 wxMenuItem *wxMenuBar::FindItem(int id, wxMenu ** itemMenu) const
@@ -347,17 +308,23 @@ wxMenuItem *wxMenuBar::FindItem(int id, wxMenu ** itemMenu) const
     if (itemMenu)
         *itemMenu = NULL;
 
-    wxMenuItem *item = NULL;
     size_t menuCount = GetMenuCount();
     for (size_t i = 0; i < menuCount; i++)
-        if ((item = m_menus.Item(i)->GetData()->FindItem(id, itemMenu)))
-            return item;
-        return NULL;
+    {
+        wxMenuItem *item = m_menus.Item(i)->GetData()->FindItem(id, itemMenu);
+        if (item) return item;
+    }
+
+    return NULL;
 }
 
 // Create menubar
 bool wxMenuBar::CreateMenuBar(wxFrame* parent)
 {
+    m_parent = parent; // bleach... override it!
+    PreCreation();
+    m_parent = NULL;
+
     if (m_mainWidget)
     {
         XtVaSetValues((Widget) parent->GetMainWidget(), XmNmenuBar, (Widget) m_mainWidget, NULL);
@@ -378,7 +345,7 @@ bool wxMenuBar::CreateMenuBar(wxFrame* parent)
     {
         wxMenu *menu = GetMenu(i);
         wxString title(m_titles[i]);
-        menu->SetButtonWidget(menu->CreateMenu (this, menuBarW, menu, title, true));
+        menu->SetButtonWidget(menu->CreateMenu (this, menuBarW, menu, i, title, true));
 
         if (strcmp (wxStripMenuCodes(title), "Help") == 0)
             XtVaSetValues ((Widget) menuBarW, XmNmenuHelpWidget, (Widget) menu->GetButtonWidget(), NULL);
@@ -393,13 +360,11 @@ bool wxMenuBar::CreateMenuBar(wxFrame* parent)
             Widget tearOff = XmGetTearOffControl(GetWidget(menu));
             wxDoChangeForegroundColour((Widget) tearOff, m_foregroundColour);
             wxDoChangeBackgroundColour((Widget) tearOff, m_backgroundColour, true);
-#endif
         }
+#endif
     }
 
-    SetBackgroundColour(m_backgroundColour);
-    SetForegroundColour(m_foregroundColour);
-    SetFont(m_font);
+    PostCreation();
 
     XtVaSetValues((Widget) parent->GetMainWidget(), XmNmenuBar, (Widget) m_mainWidget, NULL);
     XtRealizeWidget ((Widget) menuBarW);
@@ -414,7 +379,7 @@ bool wxMenuBar::DestroyMenuBar()
 {
     if (!m_mainWidget)
     {
-        SetMenuBarFrame((wxFrame*) NULL);
+        SetMenuBarFrame(NULL);
         return false;
     }
 
@@ -431,7 +396,7 @@ bool wxMenuBar::DestroyMenuBar()
     XtDestroyWidget((Widget) m_mainWidget);
     m_mainWidget = (WXWidget) 0;
 
-    SetMenuBarFrame((wxFrame*) NULL);
+    SetMenuBarFrame(NULL);
 
     return true;
 }
@@ -474,17 +439,33 @@ void wxMenu::DestroyWidgetAndDetach()
 *
 */
 
-WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar, WXWidget parent, wxMenu * topMenu, const wxString& title, bool pullDown)
+WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar,
+                             WXWidget parent,
+                             wxMenu * topMenu,
+                             size_t menuIndex,
+                             const wxString& title,
+                             bool pullDown)
 {
     Widget menu = (Widget) 0;
     Widget buttonWidget = (Widget) 0;
+    Display* dpy = XtDisplay((Widget)parent);
     Arg args[5];
     XtSetArg (args[0], XmNnumColumns, m_numColumns);
     XtSetArg (args[1], XmNpacking, (m_numColumns > 1) ? XmPACK_COLUMN : XmPACK_TIGHT);
 
+    if ( !m_font.IsOk() )
+    {
+        if ( menuBar )
+            m_font = menuBar->GetFont();
+        else if ( GetInvokingWindow() )
+            m_font = GetInvokingWindow()->GetFont();
+    }
+
+    XtSetArg (args[2], (String)wxFont::GetFontTag(), m_font.GetFontTypeC(dpy) );
+
     if (!pullDown)
     {
-        menu = XmCreatePopupMenu ((Widget) parent, wxMOTIF_STR("popup"), args, 2);
+        menu = XmCreatePopupMenu ((Widget) parent, wxMOTIF_STR("popup"), args, 3);
 #if 0
         XtAddCallback(menu,
             XmNunmapCallback,
@@ -495,7 +476,7 @@ WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar, WXWidget parent, wxMenu * topM
     else
     {
         char mnem = wxFindMnemonic (title);
-        menu = XmCreatePulldownMenu ((Widget) parent, wxMOTIF_STR("pulldown"), args, 2);
+        menu = XmCreatePulldownMenu ((Widget) parent, wxMOTIF_STR("pulldown"), args, 3);
 
         wxString title2(wxStripMenuCodes(title));
         wxXmString label_str(title2);
@@ -507,6 +488,8 @@ WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar, WXWidget parent, wxMenu * topM
 #endif
             XmNlabelString, label_str(),
             XmNsubMenuId, menu,
+            (String)wxFont::GetFontTag(), m_font.GetFontTypeC(dpy),
+            XmNpositionIndex, menuIndex,
             NULL);
 
         if (mnem != 0)
@@ -517,18 +500,17 @@ WXWidget wxMenu::CreateMenu (wxMenuBar * menuBar, WXWidget parent, wxMenu * topM
 
     m_topLevelMenu = topMenu;
 
+    size_t i = 0;
     for ( wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
           node;
-          node = node->GetNext() )
+          node = node->GetNext(), ++i )
     {
         wxMenuItem *item = node->GetData();
 
-        item->CreateItem(menu, menuBar, topMenu);
+        item->CreateItem(menu, menuBar, topMenu, i);
     }
 
-    SetBackgroundColour(m_backgroundColour);
-    SetForegroundColour(m_foregroundColour);
-    SetFont(m_font);
+    ChangeFont();
 
     return buttonWidget;
 }
@@ -543,7 +525,7 @@ void wxMenu::DestroyMenu (bool full)
           node = node->GetNext() )
     {
         wxMenuItem *item = node->GetData();
-        item->SetMenuBar((wxMenuBar*) NULL);
+        item->SetMenuBar(NULL);
 
         item->DestroyItem(full);
     }
@@ -569,7 +551,7 @@ WXWidget wxMenu::FindMenuItem (int id, wxMenuItem ** it) const
     if (id == m_menuId)
     {
         if (it)
-            *it = (wxMenuItem*) NULL;
+            *it = NULL;
         return m_buttonWidget;
     }
 
@@ -596,13 +578,15 @@ WXWidget wxMenu::FindMenuItem (int id, wxMenuItem ** it) const
     }
 
     if (it)
-        *it = (wxMenuItem*) NULL;
+        *it = NULL;
     return (WXWidget) NULL;
 }
 
 void wxMenu::SetBackgroundColour(const wxColour& col)
 {
     m_backgroundColour = col;
+    if (!col.IsOk())
+        return;
     if (m_menuWidget)
         wxDoChangeBackgroundColour(m_menuWidget, (wxColour&) col);
     if (m_buttonWidget)
@@ -626,6 +610,8 @@ void wxMenu::SetBackgroundColour(const wxColour& col)
 void wxMenu::SetForegroundColour(const wxColour& col)
 {
     m_foregroundColour = col;
+    if (!col.IsOk())
+        return;
     if (m_menuWidget)
         wxDoChangeForegroundColour(m_menuWidget, (wxColour&) col);
     if (m_buttonWidget)
@@ -650,7 +636,7 @@ void wxMenu::ChangeFont(bool keepOriginalSize)
 {
     // Lesstif 0.87 hangs here, but 0.93 does not; MBN: sometimes it does
 #if !wxCHECK_LESSTIF() // || wxCHECK_LESSTIF_VERSION( 0, 93 )
-    if (!m_font.Ok() || !m_menuWidget)
+    if (!m_font.IsOk() || !m_menuWidget)
         return;
 
     Display* dpy = XtDisplay((Widget) m_menuWidget);
@@ -670,7 +656,7 @@ void wxMenu::ChangeFont(bool keepOriginalSize)
           node = node->GetNext() )
     {
         wxMenuItem* item = node->GetData();
-        if (m_menuWidget && item->GetButtonWidget() && m_font.Ok())
+        if (m_menuWidget && item->GetButtonWidget() && m_font.IsOk())
         {
             XtVaSetValues ((Widget) item->GetButtonWidget(),
                            wxFont::GetFontTag(), m_font.GetFontTypeC(dpy),
@@ -679,6 +665,8 @@ void wxMenu::ChangeFont(bool keepOriginalSize)
         if (item->GetSubMenu())
             item->GetSubMenu()->ChangeFont(keepOriginalSize);
     }
+#else
+    wxUnusedVar(keepOriginalSize);
 #endif
 }
 
@@ -690,7 +678,10 @@ void wxMenu::SetFont(const wxFont& font)
 
 bool wxMenuBar::SetBackgroundColour(const wxColour& col)
 {
-    m_backgroundColour = col;
+    if (!wxWindowBase::SetBackgroundColour(col))
+        return false;
+    if (!col.IsOk())
+        return false;
     if (m_mainWidget)
         wxDoChangeBackgroundColour(m_mainWidget, (wxColour&) col);
 
@@ -703,7 +694,10 @@ bool wxMenuBar::SetBackgroundColour(const wxColour& col)
 
 bool wxMenuBar::SetForegroundColour(const wxColour& col)
 {
-    m_foregroundColour = col;
+    if (!wxWindowBase::SetForegroundColour(col))
+        return false;
+    if (!col.IsOk())
+        return false;
     if (m_mainWidget)
         wxDoChangeForegroundColour(m_mainWidget, (wxColour&) col);
 
@@ -730,4 +724,3 @@ bool wxMenuBar::SetFont(const wxFont& font)
 
     return true;
 }
-