src/osx/carbon/menuitem.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/mac/carbon/menuitem.cpp
   3 // Purpose:     wxMenuItem implementation
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #include "wx/menuitem.h"
  15 #include "wx/stockitem.h"
  16
  17 #ifndef WX_PRECOMP
  18     #include "wx/app.h"
  19     #include "wx/menu.h"
  20 #endif // WX_PRECOMP
  21
  22 #include "wx/osx/uma.h"
  23
  24 IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
  25
  26
  27 wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
  28                        int id,
  29                        const wxString& text,
  30                        const wxString& strHelp,
  31                        wxItemKind kind,
  32                        wxMenu *pSubMenu)
  33            :wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)
  34 {
  35     wxASSERT_MSG( id != 0 || pSubMenu != NULL , wxT("A MenuItem ID of Zero does not work under Mac") ) ;
  36
  37     // In other languages there is no difference in naming the Exit/Quit menu item between MacOS and Windows guidelines
  38     // therefore these item must not be translated
  39     if ( wxStripMenuCodes(m_text).Upper() == wxT("EXIT") )
  40         m_text = wxT("Quit\tCtrl+Q") ;
  41
  42     m_radioGroup.start = -1;
  43     m_isRadioGroupStart = false;
  44 }
  45
  46 wxMenuItem::~wxMenuItem()
  47 {
  48 }
  49
  50 // change item state
  51 // -----------------
  52
  53 void wxMenuItem::SetBitmap(const wxBitmap& bitmap)
  54 {
  55       m_bitmap = bitmap;
  56       UpdateItemBitmap();
  57 }
  58
  59 void wxMenuItem::UpdateItemBitmap()
  60 {
  61     if ( !m_parentMenu )
  62         return ;
  63
  64     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
  65     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
  66     DoUpdateItemBitmap( mhandle, index );
  67 }
  68
  69 void wxMenuItem::DoUpdateItemBitmap( WXHMENU menu, wxUint16 index)
  70 {
  71     MenuHandle mhandle = (MenuHandle) menu;
  72
  73     if ( mhandle == NULL || index == 0)
  74         return ;
  75
  76     if ( m_bitmap.Ok() )
  77     {
  78 #if wxUSE_BMPBUTTON
  79         ControlButtonContentInfo info ;
  80         wxMacCreateBitmapButton( &info , m_bitmap ) ;
  81         if ( info.contentType != kControlNoContent )
  82         {
  83             if ( info.contentType == kControlContentIconRef )
  84                 SetMenuItemIconHandle( mhandle , index ,
  85                     kMenuIconRefType , (Handle) info.u.iconRef ) ;
  86             else if ( info.contentType == kControlContentCGImageRef )
  87                SetMenuItemIconHandle( mhandle , index ,
  88                     kMenuCGImageRefType , (Handle) info.u.imageRef ) ;
  89         }
  90         wxMacReleaseBitmapButton( &info ) ;
  91 #endif
  92     }
  93 }
  94
  95 void wxMenuItem::UpdateItemStatus()
  96 {
  97     if ( !m_parentMenu )
  98         return ;
  99
 100     if ( IsSeparator() )
 101         return ;
 102
 103     if ( GetId() == wxApp::s_macPreferencesMenuItemId)
 104     {
 105         if ( !IsEnabled() )
 106             DisableMenuCommand( NULL , kHICommandPreferences ) ;
 107         else
 108             EnableMenuCommand( NULL , kHICommandPreferences ) ;
 109     }
 110
 111     if ( GetId() == wxApp::s_macExitMenuItemId)
 112     {
 113         if ( !IsEnabled() )
 114             DisableMenuCommand( NULL , kHICommandQuit ) ;
 115         else
 116             EnableMenuCommand( NULL , kHICommandQuit ) ;
 117     }
 118
 119     {
 120         MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
 121         MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
 122         if ( mhandle == NULL || index == 0)
 123             return ;
 124
 125         UMAEnableMenuItem( mhandle , index , m_isEnabled ) ;
 126         if ( IsCheckable() && IsChecked() )
 127             ::SetItemMark( mhandle , index , 0x12 ) ; // checkmark
 128         else
 129             ::SetItemMark( mhandle , index , 0 ) ; // no mark
 130
 131         UMASetMenuItemText( mhandle , index , wxStripMenuCodes(m_text) , wxFont::GetDefaultEncoding() ) ;
 132         wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( m_text ) ;
 133         UMASetMenuItemShortcut( mhandle , index , entry ) ;
 134         delete entry ;
 135     }
 136 }
 137
 138 void wxMenuItem::UpdateItemText()
 139 {
 140     if ( !m_parentMenu )
 141         return ;
 142
 143     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
 144     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
 145     if (mhandle == NULL || index == 0)
 146         return ;
 147
 148     wxString text = m_text;
 149     if (text.IsEmpty() && !IsSeparator())
 150     {
 151         wxASSERT_MSG(wxIsStockID(GetId()), wxT("A non-stock menu item with an empty label?"));
 152         text = wxGetStockLabel(GetId(), wxSTOCK_WITH_ACCELERATOR|wxSTOCK_WITH_MNEMONIC);
 153     }
 154
 155     UMASetMenuItemText( mhandle , index , wxStripMenuCodes(text) , wxFont::GetDefaultEncoding() ) ;
 156     wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( text ) ;
 157     UMASetMenuItemShortcut( mhandle , index , entry ) ;
 158     delete entry ;
 159 }
 160
 161 void wxMenuItem::Enable(bool bDoEnable)
 162 {
 163     if (( m_isEnabled != bDoEnable
 164       // avoid changing menuitem state when menu is disabled
 165       // eg. BeginAppModalStateForWindow() will disable menus and ignore this change
 166       // which in turn causes m_isEnabled to become out of sync with real menuitem state
 167          && !(m_parentMenu && !IsMenuItemEnabled(MAC_WXHMENU(m_parentMenu->GetHMenu()), 0)) )
 168       // always update builtin menuitems
 169          || (   GetId() == wxApp::s_macPreferencesMenuItemId
 170              || GetId() == wxApp::s_macExitMenuItemId
 171              || GetId() == wxApp::s_macAboutMenuItemId
 172          ))
 173     {
 174         wxMenuItemBase::Enable( bDoEnable ) ;
 175         UpdateItemStatus() ;
 176     }
 177 }
 178
 179 void wxMenuItem::UncheckRadio()
 180 {
 181     if ( m_isChecked )
 182     {
 183         wxMenuItemBase::Check( false ) ;
 184         UpdateItemStatus() ;
 185     }
 186 }
 187
 188 void wxMenuItem::Check(bool bDoCheck)
 189 {
 190     wxCHECK_RET( IsCheckable() && !IsSeparator(), wxT("only checkable items may be checked") );
 191
 192     if ( m_isChecked != bDoCheck )
 193     {
 194         if ( GetKind() == wxITEM_RADIO )
 195         {
 196             if ( bDoCheck )
 197             {
 198                 wxMenuItemBase::Check( bDoCheck ) ;
 199                 UpdateItemStatus() ;
 200
 201                 // get the index of this item in the menu
 202                 const wxMenuItemList& items = m_parentMenu->GetMenuItems();
 203                 int pos = items.IndexOf(this);
 204                 wxCHECK_RET( pos != wxNOT_FOUND,
 205                              _T("menuitem not found in the menu items list?") );
 206
 207                 // get the radio group range
 208                 int start, end;
 209
 210                 if ( m_isRadioGroupStart )
 211                 {
 212                     // we already have all information we need
 213                     start = pos;
 214                     end = m_radioGroup.end;
 215                 }
 216                 else // next radio group item
 217                 {
 218                     // get the radio group end from the start item
 219                     start = m_radioGroup.start;
 220                     end = items.Item(start)->GetData()->m_radioGroup.end;
 221                 }
 222
 223                 // also uncheck all the other items in this radio group
 224                 wxMenuItemList::compatibility_iterator node = items.Item(start);
 225                 for ( int n = start; n <= end && node; n++ )
 226                 {
 227                     if ( n != pos )
 228                         ((wxMenuItem*)node->GetData())->UncheckRadio();
 229
 230                     node = node->GetNext();
 231                 }
 232             }
 233         }
 234         else
 235         {
 236             wxMenuItemBase::Check( bDoCheck ) ;
 237             UpdateItemStatus() ;
 238         }
 239     }
 240 }
 241
 242 void wxMenuItem::SetItemLabel(const wxString& text)
 243 {
 244     // don't do anything if label didn't change
 245     if ( m_text == text )
 246         return;
 247
 248     wxMenuItemBase::SetItemLabel(text);
 249
 250     UpdateItemText() ;
 251 }
 252
 253 // radio group stuff
 254 // -----------------
 255
 256 void wxMenuItem::SetAsRadioGroupStart()
 257 {
 258     m_isRadioGroupStart = true;
 259 }
 260
 261 void wxMenuItem::SetRadioGroupStart(int start)
 262 {
 263     wxASSERT_MSG( !m_isRadioGroupStart,
 264                   wxT("should only be called for the next radio items") );
 265
 266     m_radioGroup.start = start;
 267 }
 268
 269 void wxMenuItem::SetRadioGroupEnd(int end)
 270 {
 271     wxASSERT_MSG( m_isRadioGroupStart,
 272                   wxT("should only be called for the first radio item") );
 273
 274     m_radioGroup.end = end;
 275 }
 276
 277 // ----------------------------------------------------------------------------
 278 // wxMenuItemBase
 279 // ----------------------------------------------------------------------------
 280
 281 wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
 282                                 int id,
 283                                 const wxString& name,
 284                                 const wxString& help,
 285                                 wxItemKind kind,
 286                                 wxMenu *subMenu)
 287 {
 288     return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
 289 }