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