use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

[wxWidgets.git] / src / mac / carbon / menuitem.cpp

diff --git a/src/mac/carbon/menuitem.cpp b/src/mac/carbon/menuitem.cpp
index 6974e7870cb9c72d4207e6200ca7bb200ec3b597..172c5b0ab15614a765fb534fe092cb860f886548 100644 (file)
--- a/src/mac/carbon/menuitem.cpp
+++ b/src/mac/carbon/menuitem.cpp
@@ -1,183 +1,184 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        menuitem.cpp
+// Name:        src/mac/carbon/menuitem.cpp

 // Purpose:     wxMenuItem implementation
 // Author:      Stefan Csomor
 // Purpose:     wxMenuItem implementation
 // Author:      Stefan Csomor

-// Modified by: 
+// Modified by:

 // Created:     1998-01-01
 // RCS-ID:      $Id$
 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Created:     1998-01-01
 // RCS-ID:      $Id$
 // Copyright:   (c) Stefan Csomor
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// headers & declarations
-// ============================================================================
-

 #include "wx/wxprec.h"
 
 #include "wx/wxprec.h"
 

-#include "wx/app.h"
-#include "wx/menu.h"

 #include "wx/menuitem.h"
 #include "wx/menuitem.h"

+#include "wx/stockitem.h"

 
 

-#include "wx/mac/uma.h"
-// ============================================================================
-// implementation
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// dynamic classes implementation
-// ----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/app.h"
+    #include "wx/menu.h"
+#endif // WX_PRECOMP

 
 

-#if !USE_SHARED_LIBRARY
-  IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
-#endif  //USE_SHARED_LIBRARY
+#include "wx/mac/uma.h"

 
 

-// ----------------------------------------------------------------------------
-// wxMenuItem
-// ----------------------------------------------------------------------------
+IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)

 
 

-//
-// ctor & dtor
-// -----------

 
 wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
                        int id,
                        const wxString& text,
                        const wxString& strHelp,
                        wxItemKind kind,
 
 wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
                        int id,
                        const wxString& text,
                        const wxString& strHelp,
                        wxItemKind kind,

-                       wxMenu *pSubMenu) 
-          : wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)
+                       wxMenu *pSubMenu)
+           :wxMenuItemBase(pParentMenu, id, text, strHelp, kind, pSubMenu)

 {
     wxASSERT_MSG( id != 0 || pSubMenu != NULL , wxT("A MenuItem ID of Zero does not work under Mac") ) ;
 {
     wxASSERT_MSG( id != 0 || pSubMenu != NULL , wxT("A MenuItem ID of Zero does not work under Mac") ) ;

-    
+

     // In other languages there is no difference in naming the Exit/Quit menu item between MacOS and Windows guidelines
     // therefore these item must not be translated
     // In other languages there is no difference in naming the Exit/Quit menu item between MacOS and Windows guidelines
     // therefore these item must not be translated

-    if ( wxStripMenuCodes(m_text).Upper() ==  wxT("EXIT") )
-    {
-        m_text =wxT("Quit\tCtrl+Q") ;
-    }
+    if ( wxStripMenuCodes(m_text).Upper() == wxT("EXIT") )
+        m_text = wxT("Quit\tCtrl+Q") ;

 
     m_radioGroup.start = -1;
 
     m_radioGroup.start = -1;

-    m_isRadioGroupStart = FALSE;
+    m_isRadioGroupStart = false;

 }
 
 }
 

-wxMenuItem::~wxMenuItem() 
+wxMenuItem::~wxMenuItem()

 {
 }
 
 // change item state
 // -----------------
 
 {
 }
 
 // change item state
 // -----------------
 

-void wxMenuItem::SetBitmap(const wxBitmap& bitmap) 
-{ 
-      m_bitmap = bitmap; 
-      UpdateItemBitmap() ;
+void wxMenuItem::SetBitmap(const wxBitmap& bitmap)
+{
+      m_bitmap = bitmap;
+      UpdateItemBitmap();

 }
 
 }
 

-void wxMenuItem::UpdateItemBitmap() 
+void wxMenuItem::UpdateItemBitmap()

 {
     if ( !m_parentMenu )
         return ;
 {
     if ( !m_parentMenu )
         return ;

-        
+

     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;

-    if( mhandle == NULL || index == 0)
+    DoUpdateItemBitmap( mhandle, index );
+}
+
+void wxMenuItem::DoUpdateItemBitmap( WXHMENU menu, wxUint16 index)
+{
+    MenuHandle mhandle = (MenuHandle) menu;
+
+    if ( mhandle == NULL || index == 0)

         return ;
         return ;

-        
+

     if ( m_bitmap.Ok() )
     {
     if ( m_bitmap.Ok() )
     {

+#if wxUSE_BMPBUTTON

         ControlButtonContentInfo info ;
         ControlButtonContentInfo info ;

-        wxMacCreateBitmapButton( &info , m_bitmap , kControlContentCIconHandle ) ;
+        wxMacCreateBitmapButton( &info , m_bitmap ) ;

         if ( info.contentType != kControlNoContent )
         {
         if ( info.contentType != kControlNoContent )
         {

-            if ( info.contentType == kControlContentCIconHandle )
-                SetMenuItemIconHandle( mhandle , index , 
-                    kMenuColorIconType , (Handle) info.u.cIconHandle ) ;
+            if ( info.contentType == kControlContentIconRef )
+                SetMenuItemIconHandle( mhandle , index ,
+                    kMenuIconRefType , (Handle) info.u.iconRef ) ;
+            else if ( info.contentType == kControlContentCGImageRef )
+               SetMenuItemIconHandle( mhandle , index ,
+                    kMenuCGImageRefType , (Handle) info.u.imageRef ) ;

         }
         wxMacReleaseBitmapButton( &info ) ;
         }
         wxMacReleaseBitmapButton( &info ) ;

-            
+#endif

     }
 }
 
     }
 }
 

-void wxMenuItem::UpdateItemStatus() 
+void wxMenuItem::UpdateItemStatus()

 {
     if ( !m_parentMenu )
         return ;
 {
     if ( !m_parentMenu )
         return ;

-        
-#if TARGET_CARBON
-    if ( UMAGetSystemVersion() >= 0x1000 && GetId() == wxApp::s_macPreferencesMenuItemId)
+
+    if ( IsSeparator() )
+        return ;
+
+    if ( GetId() == wxApp::s_macPreferencesMenuItemId)

     {
         if ( !IsEnabled() )
             DisableMenuCommand( NULL , kHICommandPreferences ) ;
         else
             EnableMenuCommand( NULL , kHICommandPreferences ) ;
     }
     {
         if ( !IsEnabled() )
             DisableMenuCommand( NULL , kHICommandPreferences ) ;
         else
             EnableMenuCommand( NULL , kHICommandPreferences ) ;
     }

-    if ( UMAGetSystemVersion() >= 0x1000 && GetId() == wxApp::s_macExitMenuItemId)
+
+    if ( GetId() == wxApp::s_macExitMenuItemId)

     {
         if ( !IsEnabled() )
             DisableMenuCommand( NULL , kHICommandQuit ) ;
         else
             EnableMenuCommand( NULL , kHICommandQuit ) ;
     }
     {
         if ( !IsEnabled() )
             DisableMenuCommand( NULL , kHICommandQuit ) ;
         else
             EnableMenuCommand( NULL , kHICommandQuit ) ;
     }

-#endif
-    { 
+
+    {

         MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
         MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
         MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
         MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;

-        if( mhandle == NULL || index == 0)
+        if ( mhandle == NULL || index == 0)

             return ;
 
             return ;
 

-          UMAEnableMenuItem( mhandle , index , m_isEnabled ) ;
-          if ( IsCheckable() && IsChecked() )
+        UMAEnableMenuItem( mhandle , index , m_isEnabled ) ;
+        if ( IsCheckable() && IsChecked() )

             ::SetItemMark( mhandle , index , 0x12 ) ; // checkmark
         else
             ::SetItemMark( mhandle , index , 0 ) ; // no mark
 
             ::SetItemMark( mhandle , index , 0x12 ) ; // checkmark
         else
             ::SetItemMark( mhandle , index , 0 ) ; // no mark
 

-           UMASetMenuItemText( mhandle , index , m_text , wxFont::GetDefaultEncoding() ) ; 
-           wxAcceleratorEntry *entry = wxGetAccelFromString( m_text ) ;
+        UMASetMenuItemText( mhandle , index , wxStripMenuCodes(m_text) , wxFont::GetDefaultEncoding() ) ;
+        wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( m_text ) ;

         UMASetMenuItemShortcut( mhandle , index , entry ) ;
         delete entry ;
     }
 }
 
         UMASetMenuItemShortcut( mhandle , index , entry ) ;
         delete entry ;
     }
 }
 

-void wxMenuItem::UpdateItemText() 
+void wxMenuItem::UpdateItemText()

 {
     if ( !m_parentMenu )
         return ;
 {
     if ( !m_parentMenu )
         return ;

-        
+

     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
     MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
     MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;

-    if( mhandle == NULL || index == 0)
+    if (mhandle == NULL || index == 0)

         return ;
 
         return ;
 

-       UMASetMenuItemText( mhandle , index , m_text , wxFont::GetDefaultEncoding() ) ; 
-       wxAcceleratorEntry *entry = wxGetAccelFromString( m_text ) ;
+    wxString text = m_text;
+    if (text.IsEmpty() && !IsSeparator())
+    {
+        wxASSERT_MSG(wxIsStockID(GetId()), wxT("A non-stock menu item with an empty label?"));
+        text = wxGetStockLabel(GetId(), wxSTOCK_WITH_ACCELERATOR|wxSTOCK_WITH_MNEMONIC);
+    }
+
+    UMASetMenuItemText( mhandle , index , wxStripMenuCodes(text) , wxFont::GetDefaultEncoding() ) ;
+    wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( text ) ;

     UMASetMenuItemShortcut( mhandle , index , entry ) ;
     delete entry ;
 }
 
     UMASetMenuItemShortcut( mhandle , index , entry ) ;
     delete entry ;
 }
 

-

 void wxMenuItem::Enable(bool bDoEnable)
 {
 void wxMenuItem::Enable(bool bDoEnable)
 {

-    // Due to desychronisation of m_isEnabled from the
-    // true state after a modal dialog is shown in OnInit,
-    // and subsequent enabling of menu items that should be
-    // disabled, we now always update the item's status.
-    
-    if ( /* m_isEnabled != bDoEnable */ true
-#if TARGET_CARBON
-         || GetId() == wxApp::s_macPreferencesMenuItemId
-         || GetId() == wxApp::s_macExitMenuItemId
-         || GetId() == wxApp::s_macAboutMenuItemId
-#endif
-         ) 
+    if (( m_isEnabled != bDoEnable
+      // avoid changing menuitem state when menu is disabled
+      // eg. BeginAppModalStateForWindow() will disable menus and ignore this change
+      // which in turn causes m_isEnabled to become out of sync with real menuitem state
+         && !(m_parentMenu && !IsMenuItemEnabled(MAC_WXHMENU(m_parentMenu->GetHMenu()), 0)) )
+      // always update builtin menuitems
+         || (   GetId() == wxApp::s_macPreferencesMenuItemId
+             || GetId() == wxApp::s_macExitMenuItemId
+             || GetId() == wxApp::s_macAboutMenuItemId
+         ))

     {
         wxMenuItemBase::Enable( bDoEnable ) ;
         UpdateItemStatus() ;
     }
 }
     {
         wxMenuItemBase::Enable( bDoEnable ) ;
         UpdateItemStatus() ;
     }
 }

+

 void wxMenuItem::UncheckRadio()
 {
 void wxMenuItem::UncheckRadio()
 {

-    if ( m_isChecked ) 
+    if ( m_isChecked )

     {
         wxMenuItemBase::Check( false ) ;
         UpdateItemStatus() ;
     {
         wxMenuItemBase::Check( false ) ;
         UpdateItemStatus() ;


@@ -186,9 +187,9 @@ void wxMenuItem::UncheckRadio()
 
 void wxMenuItem::Check(bool bDoCheck)
 {
 
 void wxMenuItem::Check(bool bDoCheck)
 {

-    wxCHECK_RET( IsCheckable(), wxT("only checkable items may be checked") );
+    wxCHECK_RET( IsCheckable() && !IsSeparator(), wxT("only checkable items may be checked") );

 
 

-    if ( m_isChecked != bDoCheck ) 
+    if ( m_isChecked != bDoCheck )

     {
         if ( GetKind() == wxITEM_RADIO )
         {
     {
         if ( GetKind() == wxITEM_RADIO )
         {


@@ -196,7 +197,7 @@ void wxMenuItem::Check(bool bDoCheck)
             {
                 wxMenuItemBase::Check( bDoCheck ) ;
                 UpdateItemStatus() ;
             {
                 wxMenuItemBase::Check( bDoCheck ) ;
                 UpdateItemStatus() ;

-                
+

                 // get the index of this item in the menu
                 const wxMenuItemList& items = m_parentMenu->GetMenuItems();
                 int pos = items.IndexOf(this);
                 // get the index of this item in the menu
                 const wxMenuItemList& items = m_parentMenu->GetMenuItems();
                 int pos = items.IndexOf(this);


@@ -204,8 +205,7 @@ void wxMenuItem::Check(bool bDoCheck)
                              _T("menuitem not found in the menu items list?") );
 
                 // get the radio group range
                              _T("menuitem not found in the menu items list?") );
 
                 // get the radio group range

-                int start,
-                    end;
+                int start, end;

 
                 if ( m_isRadioGroupStart )
                 {
 
                 if ( m_isRadioGroupStart )
                 {


@@ -225,9 +225,8 @@ void wxMenuItem::Check(bool bDoCheck)
                 for ( int n = start; n <= end && node; n++ )
                 {
                     if ( n != pos )
                 for ( int n = start; n <= end && node; n++ )
                 {
                     if ( n != pos )

-                    {

                         ((wxMenuItem*)node->GetData())->UncheckRadio();
                         ((wxMenuItem*)node->GetData())->UncheckRadio();

-                    }
+

                     node = node->GetNext();
                 }
             }
                     node = node->GetNext();
                 }
             }


@@ -240,14 +239,14 @@ void wxMenuItem::Check(bool bDoCheck)
     }
 }
 
     }
 }
 

-void wxMenuItem::SetText(const wxString& text)
+void wxMenuItem::SetItemLabel(const wxString& text)

 {
     // don't do anything if label didn't change
     if ( m_text == text )
         return;
 
 {
     // don't do anything if label didn't change
     if ( m_text == text )
         return;
 

-    wxMenuItemBase::SetText(text);
-    
+    wxMenuItemBase::SetItemLabel(text);
+

     UpdateItemText() ;
 }
 
     UpdateItemText() ;
 }
 


@@ -256,13 +255,13 @@ void wxMenuItem::SetText(const wxString& text)
 
 void wxMenuItem::SetAsRadioGroupStart()
 {
 
 void wxMenuItem::SetAsRadioGroupStart()
 {

-    m_isRadioGroupStart = TRUE;
+    m_isRadioGroupStart = true;

 }
 
 void wxMenuItem::SetRadioGroupStart(int start)
 {
     wxASSERT_MSG( !m_isRadioGroupStart,
 }
 
 void wxMenuItem::SetRadioGroupStart(int start)
 {
     wxASSERT_MSG( !m_isRadioGroupStart,

-                  _T("should only be called for the next radio items") );
+                  wxT("should only be called for the next radio items") );

 
     m_radioGroup.start = start;
 }
 
     m_radioGroup.start = start;
 }


@@ -270,7 +269,7 @@ void wxMenuItem::SetRadioGroupStart(int start)
 void wxMenuItem::SetRadioGroupEnd(int end)
 {
     wxASSERT_MSG( m_isRadioGroupStart,
 void wxMenuItem::SetRadioGroupEnd(int end)
 {
     wxASSERT_MSG( m_isRadioGroupStart,

-                  _T("should only be called for the first radio item") );
+                  wxT("should only be called for the first radio item") );

 
     m_radioGroup.end = end;
 }
 
     m_radioGroup.end = end;
 }


@@ -280,7 +279,7 @@ void wxMenuItem::SetRadioGroupEnd(int end)
 // ----------------------------------------------------------------------------
 
 /* static */
 // ----------------------------------------------------------------------------
 
 /* static */

-wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
+wxString wxMenuItemBase::GetLabelText(const wxString& text)

 {
     return wxStripMenuCodes(text);
 }
 {
     return wxStripMenuCodes(text);
 }