weak link test is not optimal, as CoreText is already having some symbols defined...

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

diff --git a/src/mac/carbon/menuitem.cpp b/src/mac/carbon/menuitem.cpp
index 33b337518ee1b9e390228a19041cd20cc7ad09bd..172c5b0ab15614a765fb534fe092cb860f886548 100644 (file)
--- a/src/mac/carbon/menuitem.cpp
+++ b/src/mac/carbon/menuitem.cpp
@@ -1,337 +1,277 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxMenuItem implementation
 // Purpose:     wxMenuItem implementation

-// Author:      AUTHOR
-// Modified by: 
-// Created:     ??/??/98
+// Author:      Stefan Csomor
+// Modified by:
+// Created:     1998-01-01

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) AUTHOR
+// Copyright:   (c) Stefan Csomor

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-// ============================================================================
-// headers & declarations
-// ============================================================================
+#include "wx/wxprec.h"

 
 

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

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

+#include "wx/stockitem.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/app.h"
+    #include "wx/menu.h"
+#endif // WX_PRECOMP

 
 #include "wx/mac/uma.h"
 
 #include "wx/mac/uma.h"

-// ============================================================================
-// implementation
-// ============================================================================

 
 

-// ----------------------------------------------------------------------------
-// dynamic classes implementation
-// ----------------------------------------------------------------------------
+IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)

 
 

-#if !USE_SHARED_LIBRARY
-  IMPLEMENT_DYNAMIC_CLASS(wxMenuItem, wxObject)
-#endif  //USE_SHARED_LIBRARY

 
 

-// ----------------------------------------------------------------------------
-// wxMenuItem
-// ----------------------------------------------------------------------------
-
-//
-// Helper Functions to get Mac Menus the way they should be ;-)
-//
+wxMenuItem::wxMenuItem(wxMenu *pParentMenu,
+                       int id,
+                       const wxString& text,
+                       const wxString& strHelp,
+                       wxItemKind kind,
+                       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") ) ;

 
 

-void wxMacCtoPString(const char* theCString, Str255 thePString);
+    // 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") ;

 
 

-// remove inappropriate characters, if useShortcuts is false, the ampersand will not auto-generate a mac menu-shortcut
+    m_radioGroup.start = -1;
+    m_isRadioGroupStart = false;
+}

 
 

-int wxMenuItem::MacBuildMenuString(StringPtr outMacItemText, SInt16 *outMacShortcutChar , UInt8 *outMacModifiers , const char *inItemText , bool useShortcuts )
+wxMenuItem::~wxMenuItem()

 {
 {

-       char *p = (char *) &outMacItemText[1] ;
-       short macModifiers = 0 ;
-       char macShortCut = 0 ;
-       const char *inItemName ;
-       wxString inItemTextMac ;
-       
-       if (wxApp::s_macDefaultEncodingIsPC)
-       {
-               inItemTextMac =  wxMacMakeMacStringFromPC( inItemText ) ;
-               inItemName = inItemTextMac ;
-       }
-       else
-       {
-               inItemName = inItemText ;
-       }
-       
-       if ( useShortcuts && !wxApp::s_macSupportPCMenuShortcuts )
-               useShortcuts = false ;
-       
-       // we have problems with a leading hypen - it will be taken as a separator
-       
-       while ( *inItemName == '-' )
-               inItemName++ ;
-               
-       while( *inItemName )
-       {
-               switch ( *inItemName )
-               {
-                       // special characters for macintosh menus -> use some replacement
-                       case ';' :
-                               *p++ = ',' ;
-                               break ;
-                       case '^' :
-                               *p++ = ' ' ;
-                               break ;
-                       case '!' :
-                               *p++ = ' ' ;
-                               break ;
-                       case '<' :
-                               *p++ = '[' ;
-                               break ;
-                       case '>' :
-                               *p++ = ']' ;
-                               break ;
-                       case '/' :
-                               *p++ = '|' ;
-                               break ;
-                       case '(' :
-                               *p++ = '[' ;
-                               break ;
-                       case ')' :      
-                               *p++ = ']' ;
-                               break ;
-                       // shortcuts
-                       case '&' :
-                               {
-                                       ++inItemName ;
-                                       if ( *inItemName )
-                                       {
-                                               *p++ = *inItemName ;
-                                               if ( useShortcuts )
-                                                       macShortCut = *inItemName ;
-                                       }
-                                       else
-                                               --inItemName ;
-                               }
-                               break ;
-                       // win-like accelerators
-                       case '\t' :
-                               {
-                                       ++inItemName ;
-                                       while( *inItemName )
-                                       {
-                                               if (strncmp("Ctrl", inItemName, 4) == 0) 
-                                               {
-                                                       inItemName = inItemName + 5;
-                                                       macShortCut = *inItemName;
-                                               }
-                                               else if (strncmp("Cntrl", inItemName, 5) == 0) 
-                                               {
-                                                       inItemName = inItemName + 6;
-                                                       macShortCut = *inItemName;
-                                               }
-                                               else if (strncmp("Alt", inItemName, 3) == 0) 
-                                               {
-                                                       inItemName = inItemName + 4;
-                                                       macModifiers |= kMenuOptionModifier ;
-                                                       macShortCut = *inItemName ;
-                                               }
-                                               else if (strncmp("Shift", inItemName, 5) == 0) 
-                                               {
-                                                       inItemName = inItemName + 6;
-                                                       macModifiers |= kMenuShiftModifier ;
-                                                       macShortCut = *inItemName ;
-                                               }
-                                               else if (strncmp("F", inItemName, 1) == 0) 
-                                               {
-                                                       inItemName += strlen( inItemName ) ;
-                                                       // no function keys at the moment
-                                                       // macModifiers |= kMenuShiftModifier ;
-                                                       // macShortCut = *inItemName ;
-                                               }
-                                               else
-                                               {
-                                                       break ;
-                                               }
-                                       }
-
-                                       if ( *inItemName == 0 )
-                                               --inItemName ;
-                                               
-                               }
-                               break ;
-                       default :
-                               *p++ = *inItemName ;
-               }
-               ++inItemName ;
-       }
-
-       outMacItemText[0] = (p - (char *)outMacItemText) - 1;
-       if ( outMacShortcutChar )
-               *outMacShortcutChar = macShortCut ;
-       if ( outMacModifiers )
-               *outMacModifiers = macModifiers ;
-               
-       return 0 ;

 }
 
 }
 

-// ctor & dtor
-// -----------
+// change item state
+// -----------------

 
 

-wxMenuItem::wxMenuItem(wxMenu *pParentMenu, int id,
-                       const wxString& text, const wxString& strHelp,
-                       bool bCheckable,
-                       wxMenu *pSubMenu) 
+void wxMenuItem::SetBitmap(const wxBitmap& bitmap)

 {
 {

-    wxASSERT( pParentMenu != NULL );
-
-    m_parentMenu  = pParentMenu;
-    m_subMenu     = pSubMenu;
-    m_isEnabled   = TRUE;
-    m_isChecked   = FALSE;
-    m_id          = id;
-    m_text        = text;
-    m_isCheckable = bCheckable;
-    m_help        = strHelp;
-
-
-    if ( m_text ==  "E&xit"  ||m_text == "Exit" )
-    {
-        m_text = "Quit\tCtrl+Q" ;
-    }
+      m_bitmap = bitmap;
+      UpdateItemBitmap();

 }
 
 }
 

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

 {
 {

-}
+    if ( !m_parentMenu )
+        return ;

 
 

-bool wxMenuItem::IsChecked() const
-{
-    return wxMenuItemBase::IsChecked() ;
+    MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
+    MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
+    DoUpdateItemBitmap( mhandle, index );

 }
 
 }
 

-wxString wxMenuItem::GetLabel() const
+void wxMenuItem::DoUpdateItemBitmap( WXHMENU menu, wxUint16 index)

 {
 {

-    return wxStripMenuCodes(m_text);
-}
+    MenuHandle mhandle = (MenuHandle) menu;

 
 

-// accelerators
-// ------------
+    if ( mhandle == NULL || index == 0)
+        return ;

 
 

-#if wxUSE_ACCEL
+    if ( m_bitmap.Ok() )
+    {
+#if wxUSE_BMPBUTTON
+        ControlButtonContentInfo info ;
+        wxMacCreateBitmapButton( &info , m_bitmap ) ;
+        if ( info.contentType != kControlNoContent )
+        {
+            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 ) ;
+#endif
+    }
+}

 
 

-wxAcceleratorEntry *wxMenuItem::GetAccel() const
+void wxMenuItem::UpdateItemStatus()

 {
 {

-    return wxGetAccelFromString(GetText());
-}
+    if ( !m_parentMenu )
+        return ;

 
 

-#endif // wxUSE_ACCEL
+    if ( IsSeparator() )
+        return ;

 
 

-// misc
-// ----
+    if ( GetId() == wxApp::s_macPreferencesMenuItemId)
+    {
+        if ( !IsEnabled() )
+            DisableMenuCommand( NULL , kHICommandPreferences ) ;
+        else
+            EnableMenuCommand( NULL , kHICommandPreferences ) ;
+    }

 
 

-/*
+    if ( GetId() == wxApp::s_macExitMenuItemId)
+    {
+        if ( !IsEnabled() )
+            DisableMenuCommand( NULL , kHICommandQuit ) ;
+        else
+            EnableMenuCommand( NULL , kHICommandQuit ) ;
+    }

 
 

-// delete the sub menu
-void wxMenuItem::DeleteSubMenu()
+    {
+        MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
+        MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
+        if ( mhandle == NULL || index == 0)
+            return ;
+
+        UMAEnableMenuItem( mhandle , index , m_isEnabled ) ;
+        if ( IsCheckable() && IsChecked() )
+            ::SetItemMark( mhandle , index , 0x12 ) ; // checkmark
+        else
+            ::SetItemMark( mhandle , index , 0 ) ; // no mark
+
+        UMASetMenuItemText( mhandle , index , wxStripMenuCodes(m_text) , wxFont::GetDefaultEncoding() ) ;
+        wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( m_text ) ;
+        UMASetMenuItemShortcut( mhandle , index , entry ) ;
+        delete entry ;
+    }
+}
+
+void wxMenuItem::UpdateItemText()

 {
 {

-  wxASSERT( m_subMenu != NULL );
+    if ( !m_parentMenu )
+        return ;

 
 

-  delete m_subMenu;
-  m_subMenu = NULL;
-}
+    MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
+    MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
+    if (mhandle == NULL || index == 0)
+        return ;

 
 

-*/
+    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);
+    }

 
 

-// change item state
-// -----------------
+    UMASetMenuItemText( mhandle , index , wxStripMenuCodes(text) , wxFont::GetDefaultEncoding() ) ;
+    wxAcceleratorEntry *entry = wxAcceleratorEntry::Create( text ) ;
+    UMASetMenuItemShortcut( mhandle , index , entry ) ;
+    delete entry ;
+}

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

-  if ( m_isEnabled != bDoEnable ) {
-    if ( m_subMenu == NULL ) 
-    {     
-       // normal menu item
-           if ( m_parentMenu->GetHMenu() )
-           {
-                       int index = m_parentMenu->MacGetIndexFromItem( this ) ;
-                       if ( index >= 1 )
-                       {
-                               if ( bDoEnable )
-                                       UMAEnableMenuItem( m_parentMenu->GetHMenu() , index ) ;
-                               else
-                                       UMADisableMenuItem( m_parentMenu->GetHMenu() , index ) ;
-                       }
-           }
-    }
-    else                            
+    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
+         ))

     {
     {

-               // submenu
-           if ( m_parentMenu->GetHMenu() )
-           {
-                       int index = m_parentMenu->MacGetIndexFromItem( this ) ;
-                       if ( index >= 1 )
-                       {
-                               if ( bDoEnable )
-                                       UMAEnableMenuItem( m_parentMenu->GetHMenu() , index ) ;
-                               else
-                                       UMADisableMenuItem( m_parentMenu->GetHMenu() , index ) ;
-                       }
-           }
+        wxMenuItemBase::Enable( bDoEnable ) ;
+        UpdateItemStatus() ;

     }
     }

+}

 
 

-    m_isEnabled = bDoEnable;
-  }
+void wxMenuItem::UncheckRadio()
+{
+    if ( m_isChecked )
+    {
+        wxMenuItemBase::Check( false ) ;
+        UpdateItemStatus() ;
+    }

 }
 
 void wxMenuItem::Check(bool bDoCheck)
 {
 }
 
 void wxMenuItem::Check(bool bDoCheck)
 {

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

 
 

-  if ( m_isChecked != bDoCheck ) 
-  {
-    m_isChecked = bDoCheck;
-       if ( m_parentMenu->GetHMenu() )
+    if ( m_isChecked != bDoCheck )

     {
     {

-               int index = m_parentMenu->MacGetIndexFromItem( this ) ;
-               if ( index >= 1 )
-               {
-                       if ( bDoCheck )
-                                       ::SetItemMark( m_parentMenu->GetHMenu() , index , 0x12 ) ; // checkmark
-                               else
-                                       ::SetItemMark( m_parentMenu->GetHMenu() , index , 0 ) ; // no mark
-               }
-       }
-  }
+        if ( GetKind() == wxITEM_RADIO )
+        {
+            if ( bDoCheck )
+            {
+                wxMenuItemBase::Check( bDoCheck ) ;
+                UpdateItemStatus() ;
+
+                // 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?") );
+
+                // 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;
+                }
+
+                // 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 )
+                        ((wxMenuItem*)node->GetData())->UncheckRadio();
+
+                    node = node->GetNext();
+                }
+            }
+        }
+        else
+        {
+            wxMenuItemBase::Check( bDoCheck ) ;
+            UpdateItemStatus() ;
+        }
+    }

 }
 
 }
 

-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);
-//    OWNER_DRAWN_ONLY( wxOwnerDrawn::SetName(text) );
+    wxMenuItemBase::SetItemLabel(text);

 
 

-    wxCHECK_RET( m_parentMenu && m_parentMenu->GetHMenu(), wxT("menuitem without menu") );
-       if ( m_parentMenu->GetHMenu() )
-    {
-               int index = m_parentMenu->MacGetIndexFromItem( this ) ;
-               if ( index >= 1 )
-               {
-                       Str255 label;
-                       MacBuildMenuString( label , NULL , NULL , text ,false);
-                       ::SetMenuItemText( m_parentMenu->GetHMenu() , index , label ) ; // checkmark
-               }
-       }
-
-#if wxUSE_ACCEL
-    m_parentMenu->UpdateAccel(this);
-#endif // wxUSE_ACCEL
+    UpdateItemText() ;
+}

 
 

+// radio group stuff
+// -----------------
+
+void wxMenuItem::SetAsRadioGroupStart()
+{
+    m_isRadioGroupStart = true;

 }
 }

-void wxMenuItem::SetCheckable(bool checkable)
+
+void wxMenuItem::SetRadioGroupStart(int start)
+{
+    wxASSERT_MSG( !m_isRadioGroupStart,
+                  wxT("should only be called for the next radio items") );
+
+    m_radioGroup.start = start;
+}
+
+void wxMenuItem::SetRadioGroupEnd(int end)

 {
 {

-    wxMenuItemBase::SetCheckable(checkable);
-   // OWNER_DRAWN_ONLY( wxOwnerDrawn::SetCheckable(checkable) );
+    wxASSERT_MSG( m_isRadioGroupStart,
+                  wxT("should only be called for the first radio item") );
+
+    m_radioGroup.end = end;

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -339,7 +279,7 @@ void wxMenuItem::SetCheckable(bool checkable)
 // ----------------------------------------------------------------------------
 
 /* static */
 // ----------------------------------------------------------------------------
 
 /* static */

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

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


@@ -348,8 +288,8 @@ wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
                                 int id,
                                 const wxString& name,
                                 const wxString& help,
                                 int id,
                                 const wxString& name,
                                 const wxString& help,

-                                bool isCheckable,
+                                wxItemKind kind,

                                 wxMenu *subMenu)
 {
                                 wxMenu *subMenu)
 {

-    return new wxMenuItem(parentMenu, id, name, help, isCheckable, subMenu);
+    return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);

 }
 }