///////////////////////////////////////////////////////////////////////////////
-// 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>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ===========================================================================
// headers
// ---------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "menuitem.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#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/log.h"
+ #include "wx/menu.h"
#endif
-#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
+
// ---------------------------------------------------------------------------
// macro
// ---------------------------------------------------------------------------
// dynamic classes implementation
// ----------------------------------------------------------------------------
+#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
wxMenu *pSubMenu)
: wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)
#if wxUSE_OWNER_DRAWN
- , wxOwnerDrawn(text, kind == wxITEM_CHECK)
+ , wxOwnerDrawn(text, kind == wxITEM_CHECK, true)
#endif // owner drawn
{
Init();
}
+#if WXWIN_COMPATIBILITY_2_8
wxMenuItem::wxMenuItem(wxMenu *parentMenu,
int id,
const wxString& text,
: wxMenuItemBase(parentMenu, id, text, help,
isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
#if wxUSE_OWNER_DRAWN
- , wxOwnerDrawn(text, isCheckable)
+ , wxOwnerDrawn(text, isCheckable, true)
#endif // owner drawn
{
Init();
}
+#endif
void wxMenuItem::Init()
{
m_radioGroup.start = -1;
- m_isRadioGroupStart = FALSE;
+ m_isRadioGroupStart = false;
#if wxUSE_OWNER_DRAWN
- // set default menu colors
- #define SYS_COLOR(c) (wxSystemSettings::GetColour(wxSYS_COLOUR_##c))
-
- SetTextColour(SYS_COLOR(MENUTEXT));
- SetBackgroundColour(SYS_COLOR(MENU));
- #undef SYS_COLOR
+ // 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();
- // tell the owner drawing code to to show the accel string as well
+ // switch ownerdraw back on if using a non default margin
+ if ( !IsSeparator() )
+ SetMarginWidth(GetMarginWidth());
+
+ // tell the owner drawing code to show the accel string as well
SetAccelString(m_text.AfterFirst(_T('\t')));
#endif // wxUSE_OWNER_DRAWN
}
// ----
// 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
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 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();
- return (flag & MF_CHECKED) != 0;
-}
+ HMENU hmenu = GetHMenuOf(m_parentMenu);
+ int flag = ::GetMenuState(hmenu, GetMSWId(), MF_BYCOMMAND);
-/* static */
-wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
-{
- return wxStripMenuCodes(text);
+ return (flag & MF_CHECKED) != 0;
}
// radio group stuff
void wxMenuItem::SetAsRadioGroupStart()
{
- m_isRadioGroupStart = TRUE;
+ m_isRadioGroupStart = true;
}
void wxMenuItem::SetRadioGroupStart(int start)
if ( m_isEnabled == enable )
return;
- long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),
- GetRealId(),
- MF_BYCOMMAND |
- (enable ? MF_ENABLED : MF_GRAYED));
+ if ( m_parentMenu )
+ {
+ long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),
+ GetMSWId(),
+ MF_BYCOMMAND |
+ (enable ? MF_ENABLED : MF_GRAYED));
- if ( rc == -1 ) {
- wxLogLastError(wxT("EnableMenuItem"));
+ if ( rc == -1 )
+ {
+ wxLogLastError(wxT("EnableMenuItem"));
+ }
}
wxMenuItemBase::Enable(enable);
if ( m_isChecked == check )
return;
- int flags = check ? MF_CHECKED : MF_UNCHECKED;
- HMENU hmenu = GetHMenuOf(m_parentMenu);
-
- if ( GetKind() == wxITEM_RADIO )
+ if ( m_parentMenu )
{
- // 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?") );
+ int flags = check ? MF_CHECKED : MF_UNCHECKED;
+ HMENU hmenu = GetHMenuOf(m_parentMenu);
- // 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
+ if ( GetKind() == wxITEM_RADIO )
{
- // get the radio group end from the start item
- start = m_radioGroup.start;
- end = items.Item(start)->GetData()->m_radioGroup.end;
- }
+ // 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::Node *node = items.Item(start);
- for ( int n = start; n <= end && node; n++ )
- {
- if ( n != pos )
+ // 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) )
{
- node->GetData()->m_isChecked = FALSE;
+ wxLogLastError(_T("CheckMenuRadioItem"));
}
+#endif // __WIN32__
- // we also have to do it in the menu for Win16 (under Win32
- // CheckMenuRadioItem() does it for us)
-#ifndef __WIN32__
- ::CheckMenuItem(hmenu, n, n == pos ? MF_CHECKED : MF_UNCHECKED);
-#endif // Win16
+ // 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();
+ node = node->GetNext();
+ }
}
- }
- else // check item
- {
- if ( ::CheckMenuItem(hmenu,
- GetRealId(),
- MF_BYCOMMAND | flags) == (DWORD)-1 )
+ else // check item
{
- wxLogLastError(wxT("CheckMenuItem"));
+ if ( ::CheckMenuItem(hmenu,
+ GetMSWId(),
+ MF_BYCOMMAND | flags) == (DWORD)-1 )
+ {
+ wxFAIL_MSG(_T("CheckMenuItem() failed, item not in the menu?"));
+ }
}
}
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
- if ( m_text == text )
+ if ( m_text == txt )
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(text.AfterFirst(_T('\t')));
+ SetAccelString(m_text.AfterFirst(_T('\t')));
#endif
- HMENU hMenu = GetHMenuOf(m_parentMenu);
- wxCHECK_RET( hMenu, wxT("menuitem without menu") );
+ // 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
- UINT id = GetRealId();
- UINT flagsOld = ::GetMenuState(hMenu, id, MF_BYCOMMAND);
- if ( flagsOld == 0xFFFFFFFF )
+ 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(wxT("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<MENUITEMINFO> 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;
- }
-
- LPCTSTR data;
-
-#if wxUSE_OWNER_DRAWN
- if ( IsOwnerDrawn() )
- {
- flagsOld |= MF_OWNERDRAW;
- data = (LPCTSTR)this;
- }
- else
-#endif //owner drawn
- {
- flagsOld |= MF_STRING;
- data = (wxChar*) text.c_str();
- }
+ wxLogLastError(wxT("GetMenuItemInfo"));
+ return;
+ }
- if ( ::ModifyMenu(hMenu, id,
- MF_BYCOMMAND | flagsOld,
- id, data) == (int)0xFFFFFFFF )
- {
- wxLogLastError(wxT("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"));
}
}