///////////////////////////////////////////////////////////////////////////////
-// 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"
#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
// ============================================================================
// 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
-#endif //USE_SHARED_LIBRARY
+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
// 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
+{
+ 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()
{
- wxASSERT_MSG( pParentMenu != NULL, "a menu item should have a parent" );
+ 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()
// ----
// return the id for calling Win32 API functions
-int wxMenuItem::GetRealId() const
+WXWPARAM wxMenuItem::GetMSWId() const
+{
+ // 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())
+ : wx_static_cast(unsigned short, GetId());
+}
+
+// get item state
+// --------------
+
+bool wxMenuItem::IsChecked() const
+{
+ // 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;
+}
+
+// radio group stuff
+// -----------------
+
+void wxMenuItem::SetAsRadioGroupStart()
+{
+ m_isRadioGroupStart = true;
+}
+
+void wxMenuItem::SetRadioGroupStart(int start)
{
- return m_pSubMenu ? (int)m_pSubMenu->GetHMenu() : GetId();
+ wxASSERT_MSG( !m_isRadioGroupStart,
+ _T("should only be called for the next radio items") );
+
+ m_radioGroup.start = start;
}
-// delete the sub menu
-// -------------------
-void wxMenuItem::DeleteSubMenu()
+void wxMenuItem::SetRadioGroupEnd(int end)
{
- delete m_pSubMenu;
- m_pSubMenu = NULL;
+ 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(),
- MF_BYCOMMAND |
- (bDoEnable ? MF_ENABLED : MF_GRAYED));
-
- if ( rc == -1 ) {
- wxLogLastError("EnableMenuItem");
- }
+ if ( m_isEnabled == enable )
+ return;
+
+ long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),
+ GetMSWId(),
+ MF_BYCOMMAND |
+ (enable ? MF_ENABLED : MF_GRAYED));
- m_bEnabled = bDoEnable;
+ if ( rc == -1 ) {
+ wxLogLastError(wxT("EnableMenuItem"));
}
+
+ 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;
+
+ int flags = check ? MF_CHECKED : MF_UNCHECKED;
+ HMENU hmenu = GetHMenuOf(m_parentMenu);
+
+ if ( GetKind() == wxITEM_RADIO )
+ {
+ // it doesn't make sense to uncheck a radio item - what would this do?
+ if ( !check )
+ return;
- if ( m_bChecked != bDoCheck ) {
- long rc = CheckMenuItem(GetHMenuOf(m_pParentMenu),
- GetId(),
- MF_BYCOMMAND |
- (bDoCheck ? MF_CHECKED : MF_UNCHECKED));
+ // 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?") );
- if ( rc == -1 ) {
- wxLogLastError("CheckMenuItem");
+ // 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;
}
- m_bChecked = bDoCheck;
+#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);
}
-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
+
+ HMENU hMenu = GetHMenuOf(m_parentMenu);
+ wxCHECK_RET( hMenu, wxT("menuitem without menu") );
- UINT id = GetRealId();
+#if wxUSE_ACCEL
+ m_parentMenu->UpdateAccel(this);
+#endif // wxUSE_ACCEL
+
+ UINT id = GetMSWId();
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
{
flagsOld |= MF_POPUP;
}
- LPCSTR data;
+ LPCTSTR data;
+
#if wxUSE_OWNER_DRAWN
if ( IsOwnerDrawn() )
{
flagsOld |= MF_OWNERDRAW;
- data = (LPCSTR)this;
+ data = (LPCTSTR)this;
}
else
#endif //owner drawn
{
flagsOld |= MF_STRING;
- data = strName;
+ 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) == 0xFFFFFFFF )
+ id, data) == (int)0xFFFFFFFF )
{
- wxLogLastError("ModifyMenu");
+ wxLogLastError(wxT("ModifyMenu"));
}
+#endif
}
}
+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