X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3a5ffa81c1cdf446c3d79f6f4676f91092e1c0f5..8cbc59fe84f046685b873cf58f6c56debe59de1c:/src/msw/menuitem.cpp diff --git a/src/msw/menuitem.cpp b/src/msw/menuitem.cpp index fa63e469a8..2eb256b619 100644 --- 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 -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// // =========================================================================== @@ -17,10 +17,6 @@ // headers // --------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "menuitem.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -28,29 +24,47 @@ #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" - #include "wx/font.h" + #include "wx/window.h" #include "wx/accel.h" - #include "wx/menu.h" #include "wx/string.h" - #include "wx/window.h" + #include "wx/log.h" + #include "wx/menu.h" #endif -#include "wx/ownerdrw.h" -#include "wx/menuitem.h" -#include "wx/log.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 + // --------------------------------------------------------------------------- -// convenience macro +// macro // --------------------------------------------------------------------------- +// hide the ugly cast #define GetHMenuOf(menu) ((HMENU)menu->GetHMenu()) +// conditional compilation +#if wxUSE_OWNER_DRAWN + #define OWNER_DRAWN_ONLY( code ) if ( IsOwnerDrawn() ) code +#else // !wxUSE_OWNER_DRAWN + #define OWNER_DRAWN_ONLY( code ) +#endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN + // ============================================================================ // implementation // ============================================================================ @@ -59,14 +73,48 @@ // dynamic classes implementation // ---------------------------------------------------------------------------- -#if !defined(USE_SHARED_LIBRARY) || !USE_SHARED_LIBRARY -#if wxUSE_OWNER_DRAWN - IMPLEMENT_DYNAMIC_CLASS2(wxMenuItem, wxObject, wxOwnerDrawn) -#else //!USE_OWNER_DRAWN - IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject) -#endif //USE_OWNER_DRAWN +#if wxUSE_EXTENDED_RTTI + +bool wxMenuItemStreamingCallback( const wxObject *object, wxWriter * , wxPersister * , wxxVariantArray & ) +{ + const wxMenuItem * mitem = dynamic_cast(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 ; +} -#endif //USE_SHARED_LIBRARY +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 @@ -75,38 +123,61 @@ // ctor & dtor // ----------- -wxMenuItem::wxMenuItem(wxMenu *pParentMenu, int id, - const wxString& strName, const wxString& strHelp, - bool bCheckable, - wxMenu *pSubMenu) : +wxMenuItem::wxMenuItem(wxMenu *pParentMenu, + int id, + const wxString& text, + const wxString& strHelp, + wxItemKind kind, + wxMenu *pSubMenu) + : wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu) #if wxUSE_OWNER_DRAWN - wxOwnerDrawn(strName, bCheckable), -#else //no owner drawn support - m_bCheckable(bCheckable), - m_strName(strName), -#endif //owner drawn - m_strHelp(strHelp) + , wxOwnerDrawn(text, kind == wxITEM_CHECK, true) +#endif // owner drawn { - wxASSERT_MSG( pParentMenu != NULL, "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 - // 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(); - #undef SYS_COLOR -#endif + // switch ownerdraw back on if using a non default margin + if ( !IsSeparator() ) + SetMarginWidth(GetMarginWidth()); - m_pParentMenu = pParentMenu; - m_pSubMenu = pSubMenu; - m_bEnabled = TRUE; - m_bChecked = FALSE; - m_idItem = id; + // tell the owner drawing code to show the accel string as well + SetAccelString(m_text.AfterFirst(_T('\t'))); +#endif // wxUSE_OWNER_DRAWN } wxMenuItem::~wxMenuItem() @@ -117,101 +188,266 @@ wxMenuItem::~wxMenuItem() // ---- // return the id for calling Win32 API functions -int wxMenuItem::GetRealId() const +WXWPARAM wxMenuItem::GetMSWId() const { - return m_pSubMenu ? (int)m_pSubMenu->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(GetId()); } -// delete the sub menu -// ------------------- -void wxMenuItem::DeleteSubMenu() +// get item state +// -------------- + +bool wxMenuItem::IsChecked() const { - delete m_pSubMenu; - m_pSubMenu = NULL; + // fix that RTTI is always getting the correct state (separators cannot be + // checked, but the Windows call below returns true + if ( IsSeparator() ) + return false; + + // the item might not be attached to a menu yet + // + // TODO: shouldn't we just always call the base class version? It seems + // like it ought to always be in sync + if ( !m_parentMenu ) + return wxMenuItemBase::IsChecked(); + + HMENU hmenu = GetHMenuOf(m_parentMenu); + int flag = ::GetMenuState(hmenu, GetMSWId(), MF_BYCOMMAND); + + return (flag & MF_CHECKED) != 0; +} + +// radio group stuff +// ----------------- + +void wxMenuItem::SetAsRadioGroupStart() +{ + m_isRadioGroupStart = true; +} + +void wxMenuItem::SetRadioGroupStart(int start) +{ + wxASSERT_MSG( !m_isRadioGroupStart, + _T("should only be called for the next radio items") ); + + m_radioGroup.start = start; +} + +void wxMenuItem::SetRadioGroupEnd(int end) +{ + wxASSERT_MSG( m_isRadioGroupStart, + _T("should only be called for the first radio item") ); + + m_radioGroup.end = end; } // change item state // ----------------- -void wxMenuItem::Enable(bool bDoEnable) +void wxMenuItem::Enable(bool enable) { - if ( m_bEnabled != bDoEnable ) { - long rc = EnableMenuItem(GetHMenuOf(m_pParentMenu), - GetRealId(), + if ( m_isEnabled == enable ) + return; + + if ( m_parentMenu ) + { + long rc = EnableMenuItem(GetHMenuOf(m_parentMenu), + GetMSWId(), MF_BYCOMMAND | - (bDoEnable ? MF_ENABLED : MF_GRAYED)); + (enable ? MF_ENABLED : MF_GRAYED)); - if ( rc == -1 ) { - wxLogLastError("EnableMenuItem"); + if ( rc == -1 ) + { + wxLogLastError(wxT("EnableMenuItem")); } - - m_bEnabled = bDoEnable; } + + wxMenuItemBase::Enable(enable); } -void wxMenuItem::Check(bool bDoCheck) +void wxMenuItem::Check(bool check) { - wxCHECK_RET( IsCheckable(), "only checkable items may be checked" ); + wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") ); + + if ( m_isChecked == check ) + return; - if ( m_bChecked != bDoCheck ) { - long rc = CheckMenuItem(GetHMenuOf(m_pParentMenu), - GetId(), - MF_BYCOMMAND | - (bDoCheck ? MF_CHECKED : MF_UNCHECKED)); + if ( m_parentMenu ) + { + 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?")); + } } - - m_bChecked = bDoCheck; } + + wxMenuItemBase::Check(check); } -void wxMenuItem::SetName(const wxString& strName) +void wxMenuItem::SetItemLabel(const wxString& txt) { + wxString text = txt; + // don't do anything if label didn't change - if ( m_strName == strName ) + if ( m_text == txt ) return; - m_strName = strName; + // 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 - HMENU hMenu = GetHMenuOf(m_pParentMenu); + 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 - UINT id = GetRealId(); - UINT flagsOld = ::GetMenuState(hMenu, id, MF_BYCOMMAND); - if ( flagsOld == 0xFFFFFFFF ) + // the item can be not attached to any menu yet and SetItemLabel() is still + // valid to call in this case and should do nothing else + if ( !m_parentMenu ) + return; + +#if wxUSE_ACCEL + m_parentMenu->UpdateAccel(this); +#endif // wxUSE_ACCEL + + const UINT id = GetMSWId(); + HMENU hMenu = GetHMenuOf(m_parentMenu); + if ( !hMenu || ::GetMenuState(hMenu, id, MF_BYCOMMAND) == (UINT)-1 ) + return; + +#if wxUSE_OWNER_DRAWN + if ( IsOwnerDrawn() ) { - wxLogLastError("GetMenuState"); + // we don't need to do anything for owner drawn items, they will redraw + // themselves using the new text the next time they're displayed + return; } +#endif // owner drawn + + // update the text of the native menu item + WinStruct info; + + // surprisingly, calling SetMenuItemInfo() with just MIIM_STRING doesn't + // work as it resets the menu bitmap, so we need to first get the old item + // state and then modify it + const bool isLaterThanWin95 = wxGetWinVersion() > wxWinVersion_95; + info.fMask = MIIM_STATE | + MIIM_ID | + MIIM_SUBMENU | + MIIM_CHECKMARKS | + MIIM_DATA; + if ( isLaterThanWin95 ) + info.fMask |= MIIM_BITMAP | MIIM_FTYPE; else + info.fMask |= MIIM_TYPE; + if ( !::GetMenuItemInfo(hMenu, id, FALSE, &info) ) { - if ( IsSubMenu() ) - { - // high byte contains the number of items in a submenu for submenus - flagsOld &= 0xFF; - flagsOld |= MF_POPUP; - } - - LPCSTR data; -#if wxUSE_OWNER_DRAWN - if ( IsOwnerDrawn() ) - { - flagsOld |= MF_OWNERDRAW; - data = (LPCSTR)this; - } - else -#endif //owner drawn - { - flagsOld |= MF_STRING; - data = strName; - } + wxLogLastError(wxT("GetMenuItemInfo")); + return; + } - if ( ::ModifyMenu(hMenu, id, - MF_BYCOMMAND | flagsOld, - id, data) == 0xFFFFFFFF ) - { - wxLogLastError("ModifyMenu"); - } + if ( isLaterThanWin95 ) + info.fMask |= MIIM_STRING; + //else: MIIM_TYPE already specified + info.dwTypeData = (LPTSTR)m_text.wx_str(); + info.cch = m_text.length(); + if ( !::SetMenuItemInfo(hMenu, id, FALSE, &info) ) + { + wxLogLastError(wxT("SetMenuItemInfo")); } } +void wxMenuItem::SetCheckable(bool checkable) +{ + wxMenuItemBase::SetCheckable(checkable); + OWNER_DRAWN_ONLY( wxOwnerDrawn::SetCheckable(checkable) ); +} + +// ---------------------------------------------------------------------------- +// wxMenuItemBase +// ---------------------------------------------------------------------------- + +wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu, + int id, + const wxString& name, + const wxString& help, + wxItemKind kind, + wxMenu *subMenu) +{ + return new wxMenuItem(parentMenu, id, name, help, kind, subMenu); +} + +#endif // wxUSE_MENUS