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 9195fdc50a13b75b6b525c61d132c60f56754069..172c5b0ab15614a765fb534fe092cb860f886548 100644 (file)
--- a/src/mac/carbon/menuitem.cpp
+++ b/src/mac/carbon/menuitem.cpp
@@ -1,136 +1,295 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// 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/menu.h"

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

+#include "wx/stockitem.h"

 
 

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

 
 

-// ----------------------------------------------------------------------------
-// dynamic classes implementation
-// ----------------------------------------------------------------------------
+#include "wx/mac/uma.h"

 
 

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

 
 

-// ----------------------------------------------------------------------------
-// wxMenuItem
-// ----------------------------------------------------------------------------

 
 

-// ctor & dtor
-// -----------
+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") ) ;
+
+    // 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") ;
+
+    m_radioGroup.start = -1;
+    m_isRadioGroupStart = false;
+}

 
 

-wxMenuItem::wxMenuItem(wxMenu *pParentMenu, int id,
-                       const wxString& strName, const wxString& strHelp,
-                       bool bCheckable,
-                       wxMenu *pSubMenu) :
-                        m_bCheckable(bCheckable),
-                        m_strName(strName),
-                        m_strHelp(strHelp)
+wxMenuItem::~wxMenuItem()

 {
 {

-  wxASSERT( pParentMenu != NULL );
+}

 
 

-  m_pParentMenu = pParentMenu;
-  m_pSubMenu    = pSubMenu;
-  m_idItem      = id;
-  m_bEnabled    = TRUE;
+// change item state
+// -----------------

 
 

-  if ( m_strName ==  "E&xit"  ||m_strName == "Exit" )
-  {
-       m_strName = "Quit\tCtrl+Q" ;
-  }
+void wxMenuItem::SetBitmap(const wxBitmap& bitmap)
+{
+      m_bitmap = bitmap;
+      UpdateItemBitmap();

 }
 
 }
 

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

 {
 {

+    if ( !m_parentMenu )
+        return ;
+
+    MenuHandle mhandle = MAC_WXHMENU(m_parentMenu->GetHMenu()) ;
+    MenuItemIndex index = m_parentMenu->MacGetIndexFromItem( this ) ;
+    DoUpdateItemBitmap( mhandle, index );

 }
 
 }
 

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

 
 

-// delete the sub menu
-void wxMenuItem::DeleteSubMenu()
+    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
+    }
+}
+
+void wxMenuItem::UpdateItemStatus()

 {
 {

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

 
 

-  delete m_pSubMenu;
-  m_pSubMenu = NULL;
+    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 ) ;
+    }
+
+    {
+        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 ;
+    }

 }
 
 }
 

-// change item state
-// -----------------
+void wxMenuItem::UpdateItemText()
+{
+    if ( !m_parentMenu )
+        return ;
+
+    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);
+    }
+
+    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_bEnabled != bDoEnable ) {
-    if ( m_pSubMenu == NULL ) 
-    {     
-       // normal menu item
-           if ( m_pParentMenu->m_macMenuHandle )
-           {
-                       int index = m_pParentMenu->MacGetIndexFromItem( this ) ;
-                       if ( index >= 1 )
-                       {
-                               if ( bDoEnable )
-                                       UMAEnableMenuItem( m_pParentMenu->m_macMenuHandle , index ) ;
-                               else
-                                       UMADisableMenuItem( m_pParentMenu->m_macMenuHandle , 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_pParentMenu->m_macMenuHandle )
-           {
-                       int index = m_pParentMenu->MacGetIndexFromItem( this ) ;
-                       if ( index >= 1 )
-                       {
-                               if ( bDoEnable )
-                                       UMAEnableMenuItem( m_pParentMenu->m_macMenuHandle , index ) ;
-                               else
-                                       UMADisableMenuItem( m_pParentMenu->m_macMenuHandle , index ) ;
-                       }
-           }
+        wxMenuItemBase::Enable( bDoEnable ) ;
+        UpdateItemStatus() ;

     }
     }

+}

 
 

-    m_bEnabled = 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_bChecked != bDoCheck ) 
-  {
-    m_bChecked = bDoCheck;
-       if ( m_pParentMenu->m_macMenuHandle )
+    if ( m_isChecked != bDoCheck )

     {
     {

-               int index = m_pParentMenu->MacGetIndexFromItem( this ) ;
-               if ( index >= 1 )
-               {
-                       if ( bDoCheck )
-                                       ::SetItemMark( m_pParentMenu->m_macMenuHandle , index , 0x12 ) ; // checkmark
-                               else
-                                       ::SetItemMark( m_pParentMenu->m_macMenuHandle , index , 0 ) ; // no mark
-               }
-       }
-  }
-}
\ No newline at end of file
+        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::SetItemLabel(const wxString& text)
+{
+    // don't do anything if label didn't change
+    if ( m_text == text )
+        return;
+
+    wxMenuItemBase::SetItemLabel(text);
+
+    UpdateItemText() ;
+}
+
+// radio group stuff
+// -----------------
+
+void wxMenuItem::SetAsRadioGroupStart()
+{
+    m_isRadioGroupStart = true;
+}
+
+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)
+{
+    wxASSERT_MSG( m_isRadioGroupStart,
+                  wxT("should only be called for the first radio item") );
+
+    m_radioGroup.end = end;
+}
+
+// ----------------------------------------------------------------------------
+// wxMenuItemBase
+// ----------------------------------------------------------------------------
+
+/* static */
+wxString wxMenuItemBase::GetLabelText(const wxString& text)
+{
+    return wxStripMenuCodes(text);
+}
+
+wxMenuItem *wxMenuItemBase::New(wxMenu *parentMenu,
+                                int id,
+                                const wxString& name,
+                                const wxString& help,
+                                wxItemKind kind,
+                                wxMenu *subMenu)
+{
+    return new wxMenuItem(parentMenu, id, name, help, kind, subMenu);
+}