src/msw/menuitem.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/msw/menuitem.cpp
   3 // Purpose:     wxMenuItem implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11.11.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ===========================================================================
  13 // declarations
  14 // ===========================================================================
  15
  16 // ---------------------------------------------------------------------------
  17 // headers
  18 // ---------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_MENUS
  28
  29 #include "wx/menu.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/font.h"
  33     #include "wx/bitmap.h"
  34     #include "wx/settings.h"
  35     #include "wx/font.h"
  36     #include "wx/window.h"
  37     #include "wx/accel.h"
  38     #include "wx/string.h"
  39     #include "wx/log.h"
  40 #endif
  41
  42 #include "wx/menuitem.h"
  43
  44 #if wxUSE_ACCEL
  45     #include "wx/accel.h"
  46 #endif // wxUSE_ACCEL
  47
  48 #include "wx/msw/private.h"
  49
  50 #ifdef __WXWINCE__
  51 // Implemented in menu.cpp
  52 UINT GetMenuState(HMENU hMenu, UINT id, UINT flags) ;
  53 #endif
  54
  55 // ---------------------------------------------------------------------------
  56 // macro
  57 // ---------------------------------------------------------------------------
  58
  59 // hide the ugly cast
  60 #define GetHMenuOf(menu)    ((HMENU)menu->GetHMenu())
  61
  62 // conditional compilation
  63 #if wxUSE_OWNER_DRAWN
  64     #define OWNER_DRAWN_ONLY( code ) if ( IsOwnerDrawn() ) code
  65 #else // !wxUSE_OWNER_DRAWN
  66     #define OWNER_DRAWN_ONLY( code )
  67 #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
  68
  69 // ============================================================================
  70 // implementation
  71 // ============================================================================
  72
  73 // ----------------------------------------------------------------------------
  74 // dynamic classes implementation
  75 // ----------------------------------------------------------------------------
  76
  77 #if wxUSE_EXTENDED_RTTI
  78
  79 bool wxMenuItemStreamingCallback( const wxObject *object, wxWriter * , wxPersister * , wxxVariantArray & )
  80 {
  81     const wxMenuItem * mitem = dynamic_cast<const wxMenuItem*>(object) ;
  82     if ( mitem->GetMenu() && !mitem->GetMenu()->GetTitle().IsEmpty() )
  83     {
  84         // we don't stream out the first two items for menus with a title, they will be reconstructed
  85         if ( mitem->GetMenu()->FindItemByPosition(0) == mitem || mitem->GetMenu()->FindItemByPosition(1) == mitem )
  86             return false ;
  87     }
  88     return true ;
  89 }
  90
  91 wxBEGIN_ENUM( wxItemKind )
  92     wxENUM_MEMBER( wxITEM_SEPARATOR )
  93     wxENUM_MEMBER( wxITEM_NORMAL )
  94     wxENUM_MEMBER( wxITEM_CHECK )
  95     wxENUM_MEMBER( wxITEM_RADIO )
  96 wxEND_ENUM( wxItemKind )
  97
  98 IMPLEMENT_DYNAMIC_CLASS_XTI_CALLBACK(wxMenuItem, wxObject,"wx/menuitem.h",wxMenuItemStreamingCallback)
  99
 100 wxBEGIN_PROPERTIES_TABLE(wxMenuItem)
 101     wxPROPERTY( Parent,wxMenu*, SetMenu, GetMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 102     wxPROPERTY( Id,int, SetId, GetId, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 103     wxPROPERTY( Text, wxString , SetText, GetText, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 104     wxPROPERTY( Help, wxString , SetHelp, GetHelp, wxString(), 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 105     wxREADONLY_PROPERTY( Kind, wxItemKind , GetKind , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 106     wxPROPERTY( SubMenu,wxMenu*, SetSubMenu, GetSubMenu, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
 107     wxPROPERTY( Enabled , bool , Enable , IsEnabled , wxxVariant((bool)true) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 108     wxPROPERTY( Checked , bool , Check , IsChecked , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 109     wxPROPERTY( Checkable , bool , SetCheckable , IsCheckable , wxxVariant((bool)false) , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
 110 wxEND_PROPERTIES_TABLE()
 111
 112 wxBEGIN_HANDLERS_TABLE(wxMenuItem)
 113 wxEND_HANDLERS_TABLE()
 114
 115 wxDIRECT_CONSTRUCTOR_6( wxMenuItem , wxMenu* , Parent , int , Id , wxString , Text , wxString , Help , wxItemKind , Kind , wxMenu* , SubMenu  )
 116 #else
 117 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
 118 #endif
 119
 120 // ----------------------------------------------------------------------------
 121 // wxMenuItem
 122 // ----------------------------------------------------------------------------
 123
 124 // ctor & dtor
 125 // -----------
 126
 127 wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
 128                        int id,
 129                        const wxString& text,
 130                        const wxString& strHelp,
 131                        wxItemKind kind,
 132                        wxMenu *pSubMenu)
 133           : wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)
 134 #if wxUSE_OWNER_DRAWN
 135             , wxOwnerDrawn(text, kind == wxITEM_CHECK, true)
 136 #endif // owner drawn
 137 {
 138     Init();
 139 }
 140
 141 wxMenuItem::wxMenuItem(wxMenu *parentMenu,
 142                        int id,
 143                        const wxString& text,
 144                        const wxString& help,
 145                        bool isCheckable,
 146                        wxMenu *subMenu)
 147           : wxMenuItemBase(parentMenu, id, text, help,
 148                            isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu)
 149 #if wxUSE_OWNER_DRAWN
 150            , wxOwnerDrawn(text, isCheckable, true)
 151 #endif // owner drawn
 152 {
 153     Init();
 154 }
 155
 156 void wxMenuItem::Init()
 157 {
 158     m_radioGroup.start = -1;
 159     m_isRadioGroupStart = false;
 160
 161 #if  wxUSE_OWNER_DRAWN
 162
 163     // when the color is not valid, wxOwnerDraw takes the default ones.
 164     // If we set the colors here and they are changed by the user during
 165     // the execution, then the colors are not updated until the application
 166     // is restarted and our menus look bad
 167     SetTextColour(wxNullColour);
 168     SetBackgroundColour(wxNullColour);
 169
 170     // setting default colors switched ownerdraw on: switch it off again
 171     ResetOwnerDrawn();
 172
 173     //  switch ownerdraw back on if using a non default margin
 174     if ( GetId() != wxID_SEPARATOR )
 175         SetMarginWidth(GetMarginWidth());
 176
 177     // tell the owner drawing code to show the accel string as well
 178     SetAccelString(m_text.AfterFirst(_T('\t')));
 179 #endif // wxUSE_OWNER_DRAWN
 180 }
 181
 182 wxMenuItem::~wxMenuItem()
 183 {
 184 }
 185
 186 // misc
 187 // ----
 188
 189 // return the id for calling Win32 API functions
 190 int wxMenuItem::GetRealId() const
 191 {
 192     return m_subMenu ? (int)m_subMenu->GetHMenu() : GetId();
 193 }
 194
 195 // get item state
 196 // --------------
 197
 198 bool wxMenuItem::IsChecked() const
 199 {
 200     // fix that RTTI is always getting the correct state (separators cannot be checked, but the call below
 201     // returns true
 202     if ( GetId() == wxID_SEPARATOR )
 203         return false ;
 204
 205     int flag = ::GetMenuState(GetHMenuOf(m_parentMenu), GetId(), MF_BYCOMMAND);
 206
 207     return (flag & MF_CHECKED) != 0;
 208 }
 209
 210 /* static */
 211 wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
 212 {
 213     return wxStripMenuCodes(text);
 214 }
 215
 216 // radio group stuff
 217 // -----------------
 218
 219 void wxMenuItem::SetAsRadioGroupStart()
 220 {
 221     m_isRadioGroupStart = true;
 222 }
 223
 224 void wxMenuItem::SetRadioGroupStart(int start)
 225 {
 226     wxASSERT_MSG( !m_isRadioGroupStart,
 227                   _T("should only be called for the next radio items") );
 228
 229     m_radioGroup.start = start;
 230 }
 231
 232 void wxMenuItem::SetRadioGroupEnd(int end)
 233 {
 234     wxASSERT_MSG( m_isRadioGroupStart,
 235                   _T("should only be called for the first radio item") );
 236
 237     m_radioGroup.end = end;
 238 }
 239
 240 // change item state
 241 // -----------------
 242
 243 void wxMenuItem::Enable(bool enable)
 244 {
 245     if ( m_isEnabled == enable )
 246         return;
 247
 248     long rc = EnableMenuItem(GetHMenuOf(m_parentMenu),
 249                              GetRealId(),
 250                              MF_BYCOMMAND |
 251                              (enable ? MF_ENABLED : MF_GRAYED));
 252
 253     if ( rc == -1 ) {
 254         wxLogLastError(wxT("EnableMenuItem"));
 255     }
 256
 257     wxMenuItemBase::Enable(enable);
 258 }
 259
 260 void wxMenuItem::Check(bool check)
 261 {
 262     wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") );
 263
 264     if ( m_isChecked == check )
 265         return;
 266
 267     int flags = check ? MF_CHECKED : MF_UNCHECKED;
 268     HMENU hmenu = GetHMenuOf(m_parentMenu);
 269
 270     if ( GetKind() == wxITEM_RADIO )
 271     {
 272         // it doesn't make sense to uncheck a radio item - what would this do?
 273         if ( !check )
 274             return;
 275
 276         // get the index of this item in the menu
 277         const wxMenuItemList& items = m_parentMenu->GetMenuItems();
 278         int pos = items.IndexOf(this);
 279         wxCHECK_RET( pos != wxNOT_FOUND,
 280                      _T("menuitem not found in the menu items list?") );
 281
 282         // get the radio group range
 283         int start,
 284             end;
 285
 286         if ( m_isRadioGroupStart )
 287         {
 288             // we already have all information we need
 289             start = pos;
 290             end = m_radioGroup.end;
 291         }
 292         else // next radio group item
 293         {
 294             // get the radio group end from the start item
 295             start = m_radioGroup.start;
 296             end = items.Item(start)->GetData()->m_radioGroup.end;
 297         }
 298
 299 #ifdef __WIN32__
 300         // calling CheckMenuRadioItem() with such parameters hangs my system
 301         // (NT4 SP6) and I suspect this could happen to the others as well - so
 302         // don't do it!
 303         wxCHECK_RET( start != -1 && end != -1,
 304                      _T("invalid ::CheckMenuRadioItem() parameter(s)") );
 305
 306         if ( !::CheckMenuRadioItem(hmenu,
 307                                    start,   // the first radio group item
 308                                    end,     // the last one
 309                                    pos,     // the one to check
 310                                    MF_BYPOSITION) )
 311         {
 312             wxLogLastError(_T("CheckMenuRadioItem"));
 313         }
 314 #endif // __WIN32__
 315
 316         // also uncheck all the other items in this radio group
 317         wxMenuItemList::compatibility_iterator node = items.Item(start);
 318         for ( int n = start; n <= end && node; n++ )
 319         {
 320             if ( n != pos )
 321             {
 322                 node->GetData()->m_isChecked = false;
 323             }
 324
 325             node = node->GetNext();
 326         }
 327     }
 328     else // check item
 329     {
 330         if ( ::CheckMenuItem(hmenu,
 331                              GetRealId(),
 332                              MF_BYCOMMAND | flags) == (DWORD)-1 )
 333         {
 334             wxFAIL_MSG( _T("CheckMenuItem() failed, item not in the menu?") );
 335         }
 336     }
 337
 338     wxMenuItemBase::Check(check);
 339 }
 340
 341 void wxMenuItem::SetText(const wxString& text)
 342 {
 343     // don't do anything if label didn't change
 344     if ( m_text == text )
 345         return;
 346
 347     wxMenuItemBase::SetText(text);
 348     OWNER_DRAWN_ONLY( wxOwnerDrawn::SetName(text) );
 349 #if wxUSE_OWNER_DRAWN
 350     // tell the owner drawing code to to show the accel string as well
 351     SetAccelString(text.AfterFirst(_T('\t')));
 352 #endif
 353
 354     HMENU hMenu = GetHMenuOf(m_parentMenu);
 355     wxCHECK_RET( hMenu, wxT("menuitem without menu") );
 356
 357 #if wxUSE_ACCEL
 358     m_parentMenu->UpdateAccel(this);
 359 #endif // wxUSE_ACCEL
 360
 361     UINT id = GetRealId();
 362     UINT flagsOld = ::GetMenuState(hMenu, id, MF_BYCOMMAND);
 363     if ( flagsOld == 0xFFFFFFFF )
 364     {
 365         // It's not an error, it means that the menu item doesn't exist
 366         //wxLogLastError(wxT("GetMenuState"));
 367     }
 368     else
 369     {
 370         if ( IsSubMenu() )
 371         {
 372             // high byte contains the number of items in a submenu for submenus
 373             flagsOld &= 0xFF;
 374             flagsOld |= MF_POPUP;
 375         }
 376
 377         LPCTSTR data;
 378
 379 #if wxUSE_OWNER_DRAWN
 380         if ( IsOwnerDrawn() )
 381         {
 382             flagsOld |= MF_OWNERDRAW;
 383             data = (LPCTSTR)this;
 384         }
 385         else
 386 #endif  //owner drawn
 387         {
 388             flagsOld |= MF_STRING;
 389             data = (wxChar*) text.c_str();
 390         }
 391
 392 #ifdef __WXWINCE__
 393         // FIXME: complete this, applying the old
 394         // flags.
 395         // However, the WinCE doc for SetMenuItemInfo
 396         // says that you can't use it to set the menu
 397         // item state; only data, id and type.
 398         MENUITEMINFO info;
 399         wxZeroMemory(info);
 400         info.cbSize = sizeof(info);
 401         info.fMask = MIIM_TYPE;
 402         info.fType = MFT_STRING;
 403         info.cch = text.length();
 404         info.dwTypeData = (LPTSTR) data ;
 405         if ( !::SetMenuItemInfo(hMenu, id, FALSE, & info) )
 406         {
 407             wxLogLastError(wxT("SetMenuItemInfo"));
 408         }
 409 #else
 410         if ( ::ModifyMenu(hMenu, id,
 411                           MF_BYCOMMAND | flagsOld,
 412                           id, data) == (int)0xFFFFFFFF )
 413         {
 414             wxLogLastError(wxT("ModifyMenu"));
 415         }
 416 #endif
 417     }
 418 }
 419
 420 void wxMenuItem::SetCheckable(bool checkable)
 421 {
 422     wxMenuItemBase::SetCheckable(checkable);
 423     OWNER_DRAWN_ONLY( wxOwnerDrawn::SetCheckable(checkable) );
 424 }
 425
 426 // ----------------------------------------------------------------------------
 427 // wxMenuItemBase
 428 // ----------------------------------------------------------------------------
 429
 430 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 431                                 int id,
 432                                 const wxString& name,
 433                                 const wxString& help,
 434                                 wxItemKind kind,
 435                                 wxMenu *subMenu)
 436 {
 437     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 438 }
 439
 440 #endif // wxUSE_MENUS