always properly check if SeekI() calls succeded; this makes CanRead() functions of...

[wxWidgets.git] / src / msw / menuitem.cpp

diff --git a/src/msw/menuitem.cpp b/src/msw/menuitem.cpp
index 9b6dbe9b52d18e3d126a1a222d0dc3488229728e..cc55d4199646b42483ba76e7fa7aaadbe0810f26 100644 (file)
--- a/src/msw/menuitem.cpp
+++ b/src/msw/menuitem.cpp
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        menuitem.cpp
+// Name:        src/msw/menuitem.cpp

 // Purpose:     wxMenuItem implementation
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     11.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Purpose:     wxMenuItem implementation
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     11.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ===========================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ===========================================================================


@@ -17,10 +17,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation "menuitem.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,26 +24,33 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_MENUS
+
+#include "wx/menuitem.h"
+#include "wx/stockitem.h"
+

 #ifndef WX_PRECOMP
     #include "wx/font.h"
     #include "wx/bitmap.h"
     #include "wx/settings.h"
 #ifndef WX_PRECOMP
     #include "wx/font.h"
     #include "wx/bitmap.h"
     #include "wx/settings.h"

-    #include "wx/font.h"

     #include "wx/window.h"
     #include "wx/accel.h"
     #include "wx/window.h"
     #include "wx/accel.h"

-    #include "wx/menu.h"

     #include "wx/string.h"
     #include "wx/string.h"

+    #include "wx/log.h"
+    #include "wx/menu.h"

 #endif
 
 #endif
 

-#include "wx/menuitem.h"
-#include "wx/log.h"
-

 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #endif // wxUSE_ACCEL
 
 #include "wx/msw/private.h"
 
 #if wxUSE_ACCEL
     #include "wx/accel.h"
 #endif // wxUSE_ACCEL
 
 #include "wx/msw/private.h"
 

+#ifdef __WXWINCE__
+// Implemented in menu.cpp
+UINT GetMenuState(HMENU hMenu, UINT id, UINT flags) ;
+#endif
+

 // ---------------------------------------------------------------------------
 // macro
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // macro
 // ---------------------------------------------------------------------------


@@ -70,11 +73,48 @@
 // dynamic classes implementation
 // ----------------------------------------------------------------------------
 
 // dynamic classes implementation
 // ----------------------------------------------------------------------------
 

-    #if wxUSE_OWNER_DRAWN
-        IMPLEMENT_DYNAMIC_CLASS2(wxMenuItem, wxMenuItemBase, wxOwnerDrawn)
-    #else   //!USE_OWNER_DRAWN
-        IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxMenuItemBase)
-    #endif  //USE_OWNER_DRAWN
+#if wxUSE_EXTENDED_RTTI
+
+bool wxMenuItemStreamingCallback( const wxObject *object, wxWriter * , wxPersister * , wxxVariantArray & )
+{
+    const wxMenuItem * mitem = dynamic_cast<const wxMenuItem*>(object) ;
+    if ( mitem->GetMenu() && !mitem->GetMenu()->GetTitle().empty() )
+    {
+        // we don't stream out the first two items for menus with a title, they will be reconstructed
+        if ( mitem->GetMenu()->FindItemByPosition(0) == mitem || mitem->GetMenu()->FindItemByPosition(1) == mitem )
+            return false ;
+    }
+    return true ;
+}
+
+wxBEGIN_ENUM( wxItemKind )
+    wxENUM_MEMBER( wxITEM_SEPARATOR )
+    wxENUM_MEMBER( wxITEM_NORMAL )
+    wxENUM_MEMBER( wxITEM_CHECK )
+    wxENUM_MEMBER( wxITEM_RADIO )
+wxEND_ENUM( wxItemKind )
+
+IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuItem, wxObject,"wx/menuitem.h",wxMenuItemStreamingCallback)
+
+wxBEGIN_PROPERTIES_TABLE(wxMenuItem)
+    wxPROPERTY( Parent,wxMenu*, SetMenu, GetMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( Id,int, SetId, GetId, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( Text, wxString , SetText, GetText, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( Help, wxString , SetHelp, GetHelp, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxREADONLY_PROPERTY( Kind, wxItemKind , GetKind , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( SubMenu,wxMenu*, SetSubMenu, GetSubMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
+    wxPROPERTY( Enabled , bool , Enable , IsEnabled , wxxVariant((bool)true) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY( Checked , bool , Check , IsChecked , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+    wxPROPERTY( Checkable , bool , SetCheckable , IsCheckable , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
+wxEND_PROPERTIES_TABLE()
+
+wxBEGIN_HANDLERS_TABLE(wxMenuItem)
+wxEND_HANDLERS_TABLE()
+
+wxDIRECT_CONSTRUCTOR_6( wxMenuItem , wxMenu* , Parent , int , Id , wxString , Text , wxString , Help , wxItemKind , Kind , wxMenu* , SubMenu  )
+#else
+IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
+#endif

 
 // ----------------------------------------------------------------------------
 // wxMenuItem
 
 // ----------------------------------------------------------------------------
 // wxMenuItem


@@ -87,35 +127,57 @@ wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
                        int id,
                        const wxString& text,
                        const wxString& strHelp,
                        int id,
                        const wxString& text,
                        const wxString& strHelp,

-                       bool bCheckable,
+                       wxItemKind kind,

                        wxMenu *pSubMenu)
                        wxMenu *pSubMenu)

+          : wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)

 #if wxUSE_OWNER_DRAWN
 #if wxUSE_OWNER_DRAWN

-                       : wxOwnerDrawn(text, bCheckable)
+            , wxOwnerDrawn(text, kind == wxITEM_CHECK, true)

 #endif // owner drawn
 {
 #endif // owner drawn
 {

-    wxASSERT_MSG( pParentMenu != NULL, wxT("a menu item should have a parent") );
+    Init();
+}
+
+#if WXWIN_COMPATIBILITY_2_8
+wxMenuItem::wxMenuItem(wxMenu *parentMenu,
+                       int id,
+                       const wxString& text,
+                       const wxString& help,
+                       bool isCheckable,
+                       wxMenu *subMenu)
+          : wxMenuItemBase(parentMenu, id, text, help,
+                           isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
+#if wxUSE_OWNER_DRAWN
+           , wxOwnerDrawn(text, isCheckable, true)
+#endif // owner drawn
+{
+    Init();
+}
+#endif
+
+void wxMenuItem::Init()
+{
+    m_radioGroup.start = -1;
+    m_isRadioGroupStart = false;

 
 #if  wxUSE_OWNER_DRAWN
 
 #if  wxUSE_OWNER_DRAWN

-    // set default menu colors
-    #define SYS_COLOR(c) (wxSystemSettings::GetSystemColour(wxSYS_COLOUR_##c))

 
 

-    SetTextColour(SYS_COLOR(MENUTEXT));
-    SetBackgroundColour(SYS_COLOR(MENU));
+    // when the color is not valid, wxOwnerDraw takes the default ones.
+    // If we set the colors here and they are changed by the user during
+    // the execution, then the colors are not updated until the application
+    // is restarted and our menus look bad
+    SetTextColour(wxNullColour);
+    SetBackgroundColour(wxNullColour);

 
 

-    // we don't want normal items be owner-drawn
+    // setting default colors switched ownerdraw on: switch it off again

     ResetOwnerDrawn();
 
     ResetOwnerDrawn();
 

-    #undef  SYS_COLOR
-#endif // wxUSE_OWNER_DRAWN
+    //  switch ownerdraw back on if using a non default margin
+    if ( !IsSeparator() )
+        SetMarginWidth(GetMarginWidth());

 
 

-    m_parentMenu  = pParentMenu;
-    m_subMenu     = pSubMenu;
-    m_isEnabled   = TRUE;
-    m_isChecked   = FALSE;
-    m_id          = id;
-    m_text        = text;
-    m_isCheckable = bCheckable;
-    m_help        = strHelp;
+    // tell the owner drawing code to show the accel string as well
+    SetAccelString(m_text.AfterFirst(_T('\t')));
+#endif // wxUSE_OWNER_DRAWN

 }
 
 wxMenuItem::~wxMenuItem()
 }
 
 wxMenuItem::~wxMenuItem()


@@ -126,9 +188,14 @@ wxMenuItem::~wxMenuItem()
 // ----
 
 // return the id for calling Win32 API functions
 // ----
 
 // return the id for calling Win32 API functions

-int wxMenuItem::GetRealId() const
+WXWPARAM wxMenuItem::GetMSWId() const

 {
 {

-    return m_subMenu ? (int)m_subMenu->GetHMenu() : GetId();
+    // we must use ids in unsigned short range with Windows functions, if we
+    // pass ids > USHRT_MAX to them they get very confused (e.g. start
+    // generating WM_COMMAND messages with negative high word of wParam), so
+    // use the cast to ensure the id is in range
+    return m_subMenu ? wxPtrToUInt(m_subMenu->GetHMenu())
+                     : static_cast<unsigned short>(GetId());

 }
 
 // get item state
 }
 
 // get item state


@@ -136,27 +203,39 @@ int wxMenuItem::GetRealId() const
 
 bool wxMenuItem::IsChecked() const
 {
 
 bool wxMenuItem::IsChecked() const
 {

-    int flag = ::GetMenuState(GetHMenuOf(m_parentMenu), GetId(), MF_BYCOMMAND);
+    // fix that RTTI is always getting the correct state (separators cannot be checked, but the call below
+    // returns true
+    if ( IsSeparator() )
+        return false ;
+
+    int flag = ::GetMenuState(GetHMenuOf(m_parentMenu), GetMSWId(), MF_BYCOMMAND);

 
     return (flag & MF_CHECKED) != 0;
 }
 
 
     return (flag & MF_CHECKED) != 0;
 }
 

-wxString wxMenuItem::GetLabel() const
+// radio group stuff
+// -----------------
+
+void wxMenuItem::SetAsRadioGroupStart()

 {
 {

-    return wxStripMenuCodes(m_text);
+    m_isRadioGroupStart = true;

 }
 
 }
 

-// accelerators
-// ------------
+void wxMenuItem::SetRadioGroupStart(int start)
+{
+    wxASSERT_MSG( !m_isRadioGroupStart,
+                  _T("should only be called for the next radio items") );

 
 

-#if wxUSE_ACCEL
+    m_radioGroup.start = start;
+}

 
 

-wxAcceleratorEntry *wxMenuItem::GetAccel() const
+void wxMenuItem::SetRadioGroupEnd(int end)

 {
 {

-    return wxGetAccelFromString(GetText());
-}
+    wxASSERT_MSG( m_isRadioGroupStart,
+                  _T("should only be called for the first radio item") );

 
 

-#endif // wxUSE_ACCEL
+    m_radioGroup.end = end;
+}

 
 // change item state
 // -----------------
 
 // change item state
 // -----------------


@@ -167,12 +246,12 @@ void wxMenuItem::Enable(bool enable)
         return;
 
     long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),
         return;
 
     long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),

-                             GetRealId(),
+                             GetMSWId(),

                              MF_BYCOMMAND |
                              (enable ? MF_ENABLED : MF_GRAYED));
 
     if ( rc == -1 ) {
                              MF_BYCOMMAND |
                              (enable ? MF_ENABLED : MF_GRAYED));
 
     if ( rc == -1 ) {

-        wxLogLastError("EnableMenuItem");
+        wxLogLastError(wxT("EnableMenuItem"));

     }
 
     wxMenuItemBase::Enable(enable);
     }
 
     wxMenuItemBase::Enable(enable);


@@ -180,31 +259,104 @@ void wxMenuItem::Enable(bool enable)
 
 void wxMenuItem::Check(bool check)
 {
 
 void wxMenuItem::Check(bool check)
 {

-    wxCHECK_RET( m_isCheckable, wxT("only checkable items may be checked") );
+    wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") );

 
     if ( m_isChecked == check )
         return;
 
 
     if ( m_isChecked == check )
         return;
 

-    long rc = CheckMenuItem(GetHMenuOf(m_parentMenu),
-                            GetRealId(),
-                            MF_BYCOMMAND |
-                            (check ? MF_CHECKED : MF_UNCHECKED));
+    int flags = check ? MF_CHECKED : MF_UNCHECKED;
+    HMENU hmenu = GetHMenuOf(m_parentMenu);

 
 

-    if ( rc == -1 ) {
-        wxLogLastError("CheckMenuItem");
+    if ( GetKind() == wxITEM_RADIO )
+    {
+        // it doesn't make sense to uncheck a radio item - what would this do?
+        if ( !check )
+            return;
+
+        // get the index of this item in the menu
+        const wxMenuItemList& items = m_parentMenu->GetMenuItems();
+        int pos = items.IndexOf(this);
+        wxCHECK_RET( pos != wxNOT_FOUND,
+                     _T("menuitem not found in the menu items list?") );
+
+        // get the radio group range
+        int start,
+            end;
+
+        if ( m_isRadioGroupStart )
+        {
+            // we already have all information we need
+            start = pos;
+            end = m_radioGroup.end;
+        }
+        else // next radio group item
+        {
+            // get the radio group end from the start item
+            start = m_radioGroup.start;
+            end = items.Item(start)->GetData()->m_radioGroup.end;
+        }
+
+#ifdef __WIN32__
+        // calling CheckMenuRadioItem() with such parameters hangs my system
+        // (NT4 SP6) and I suspect this could happen to the others as well - so
+        // don't do it!
+        wxCHECK_RET( start != -1 && end != -1,
+                     _T("invalid ::CheckMenuRadioItem() parameter(s)") );
+
+        if ( !::CheckMenuRadioItem(hmenu,
+                                   start,   // the first radio group item
+                                   end,     // the last one
+                                   pos,     // the one to check
+                                   MF_BYPOSITION) )
+        {
+            wxLogLastError(_T("CheckMenuRadioItem"));
+        }
+#endif // __WIN32__
+
+        // also uncheck all the other items in this radio group
+        wxMenuItemList::compatibility_iterator node = items.Item(start);
+        for ( int n = start; n <= end && node; n++ )
+        {
+            if ( n != pos )
+            {
+                node->GetData()->m_isChecked = false;
+            }
+
+            node = node->GetNext();
+        }
+    }
+    else // check item
+    {
+        if ( ::CheckMenuItem(hmenu,
+                             GetMSWId(),
+                             MF_BYCOMMAND | flags) == (DWORD)-1 )
+        {
+            wxFAIL_MSG( _T("CheckMenuItem() failed, item not in the menu?") );
+        }

     }
 
     wxMenuItemBase::Check(check);
 }
 
     }
 
     wxMenuItemBase::Check(check);
 }
 

-void wxMenuItem::SetText(const wxString& text)
+void wxMenuItem::SetItemLabel(const wxString& txt)

 {
 {

+    wxString text = txt;
+

     // don't do anything if label didn't change
     // don't do anything if label didn't change

-    if ( m_text == text )
+    if ( m_text == txt )

         return;
 
         return;
 

-    wxMenuItemBase::SetText(text);
-    OWNER_DRAWN_ONLY( wxOwnerDrawn::SetName(text) );
+    // wxMenuItemBase will do stock ID checks
+    wxMenuItemBase::SetItemLabel(text);
+
+    // m_text could now be different from 'text' if we are a stock menu item,
+    // so use only m_text below
+
+    OWNER_DRAWN_ONLY( wxOwnerDrawn::SetName(m_text) );
+#if wxUSE_OWNER_DRAWN
+    // tell the owner drawing code to to show the accel string as well
+    SetAccelString(m_text.AfterFirst(_T('\t')));
+#endif

 
     HMENU hMenu = GetHMenuOf(m_parentMenu);
     wxCHECK_RET( hMenu, wxT("menuitem without menu") );
 
     HMENU hMenu = GetHMenuOf(m_parentMenu);
     wxCHECK_RET( hMenu, wxT("menuitem without menu") );


@@ -213,11 +365,12 @@ void wxMenuItem::SetText(const wxString& text)
     m_parentMenu->UpdateAccel(this);
 #endif // wxUSE_ACCEL
 
     m_parentMenu->UpdateAccel(this);
 #endif // wxUSE_ACCEL
 

-    UINT id = GetRealId();
+    UINT id = GetMSWId();

     UINT flagsOld = ::GetMenuState(hMenu, id, MF_BYCOMMAND);
     if ( flagsOld == 0xFFFFFFFF )
     {
     UINT flagsOld = ::GetMenuState(hMenu, id, MF_BYCOMMAND);
     if ( flagsOld == 0xFFFFFFFF )
     {

-        wxLogLastError("GetMenuState");
+        // It's not an error, it means that the menu item doesn't exist
+        //wxLogLastError(wxT("GetMenuState"));

     }
     else
     {
     }
     else
     {


@@ -240,15 +393,34 @@ void wxMenuItem::SetText(const wxString& text)
 #endif  //owner drawn
         {
             flagsOld |= MF_STRING;
 #endif  //owner drawn
         {
             flagsOld |= MF_STRING;

-            data = (wxChar*) text.c_str();
+            data = (wxChar*) m_text.wx_str();

         }
 
         }
 

+#ifdef __WXWINCE__
+        // FIXME: complete this, applying the old
+        // flags.
+        // However, the WinCE doc for SetMenuItemInfo
+        // says that you can't use it to set the menu
+        // item state; only data, id and type.
+        MENUITEMINFO info;
+        wxZeroMemory(info);
+        info.cbSize = sizeof(info);
+        info.fMask = MIIM_TYPE;
+        info.fType = MFT_STRING;
+        info.cch = m_text.length();
+        info.dwTypeData = (LPTSTR) data ;
+        if ( !::SetMenuItemInfo(hMenu, id, FALSE, & info) )
+        {
+            wxLogLastError(wxT("SetMenuItemInfo"));
+        }
+#else

         if ( ::ModifyMenu(hMenu, id,
                           MF_BYCOMMAND | flagsOld,
                           id, data) == (int)0xFFFFFFFF )
         {
             wxLogLastError(wxT("ModifyMenu"));
         }
         if ( ::ModifyMenu(hMenu, id,
                           MF_BYCOMMAND | flagsOld,
                           id, data) == (int)0xFFFFFFFF )
         {
             wxLogLastError(wxT("ModifyMenu"));
         }

+#endif

     }
 }
 
     }
 }
 


@@ -266,8 +438,10 @@ wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
                                 int id,
                                 const wxString& name,
                                 const wxString& help,
                                 int id,
                                 const wxString& name,
                                 const wxString& help,

-                                bool isCheckable,
+                                wxItemKind kind,

                                 wxMenu *subMenu)
 {
                                 wxMenu *subMenu)
 {

-    return new wxMenuItem(parentMenu, id, name, help, isCheckable, subMenu);
+    return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);

 }
 }

+
+#endif // wxUSE_MENUS