otherwise we always fall back to blitting, even if we can provide better results

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

diff --git a/src/mac/carbon/taskbar.cpp b/src/mac/carbon/taskbar.cpp
index 0eeca244c57429ab9aa7c143deb7b32de4db9c38..9c46425f454161cb39bda795ecc6f464455da7dd 100644 (file)
--- a/src/mac/carbon/taskbar.cpp
+++ b/src/mac/carbon/taskbar.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:               taskbar.cpp
+// Name:        taskbar.cpp

 // Purpose:     wxTaskBarIcon OSX Implementation
 // Author:      Ryan Norton
 // Modified by:
 // Purpose:     wxTaskBarIcon OSX Implementation
 // Author:      Ryan Norton
 // Modified by:


@@ -11,8 +11,6 @@
 
 #include "wx/wxprec.h"
 
 
 #include "wx/wxprec.h"
 

-#include "wx/defs.h"
-

 #ifdef wxHAS_TASK_BAR_ICON
 
 #include "wx/mac/private.h"
 #ifdef wxHAS_TASK_BAR_ICON
 
 #include "wx/mac/private.h"


@@ -20,24 +18,12 @@
 #include "wx/taskbar.h"
 #include "wx/menu.h"
 #include "wx/icon.h"
 #include "wx/taskbar.h"
 #include "wx/menu.h"
 #include "wx/icon.h"

+#include "wx/dcmemory.h"

 
 

-#if 0
-
-#include "wx/frame.h"
-#include "wx/dialog.h"
-
-#endif
-
-//
-//TODO:  Implement  Apple Software Guidelines - show the top window it it's not shown,
-//and force it to be unminimized - and all unminimized windows should be brought to 
-//the front
-//
-//TODO:

 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
 
 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
 

-pascal OSStatus wxDockEventHandler(    EventHandlerCallRef inHandlerCallRef,
-                                                                       EventRef inEvent, void* pData)
+pascal OSStatus wxDockEventHandler( EventHandlerCallRef inHandlerCallRef,
+                                    EventRef inEvent, void* pData)

 {
     wxTaskBarIcon*& pTB = (wxTaskBarIcon*&) pData;
 
 {
     wxTaskBarIcon*& pTB = (wxTaskBarIcon*&) pData;
 


@@ -46,99 +32,128 @@ pascal OSStatus wxDockEventHandler(        EventHandlerCallRef inHandlerCallRef,
             
     if (eventClass == kEventClassCommand && eventKind == kEventCommandProcess) 
     {
             
     if (eventClass == kEventClassCommand && eventKind == kEventCommandProcess) 
     {

-    //TODO:
-    //TODO:    This is a complete copy of 
-    //static pascal OSStatus wxMacAppCommandEventHandler( EventHandlerCallRef handler , EventRef event , void *data )
-    //FIND A WAY TO EXTERN THIS AND USE THAT HERE INSTEAD!!
-    //TODO:
-       MenuRef hMenu = MAC_WXHMENU(pTB->GetCurrentMenu()->GetHMenu());
-    OSStatus result = eventNotHandledErr ;
-
-    HICommand command ;
-    OSErr err;
-    
-    err =    GetEventParameter(inEvent, kEventParamDirectObject, typeHICommand,        
+        //TODO:        This is a complete copy of 
+        //static pascal OSStatus wxMacAppCommandEventHandler( EventHandlerCallRef handler , EventRef event , void *data )
+
+        if (! pTB->GetCurrentMenu() )
+        {
+            return eventNotHandledErr;
+        }
+                
+        MenuRef hMenu = MAC_WXHMENU(pTB->GetCurrentMenu()->GetHMenu());
+        OSStatus result = eventNotHandledErr ;
+
+        HICommand command ;
+        OSErr err;
+    
+        err =    GetEventParameter(inEvent, kEventParamDirectObject, typeHICommand,    

                             NULL, sizeof(HICommand), NULL, &command);
                             NULL, sizeof(HICommand), NULL, &command);

-    wxASSERT(err == noErr);
+        wxASSERT(err == noErr);

                 
                 

-    MenuItemIndex menuItemIndex;
-    err = GetIndMenuItemWithCommandID(hMenu, command.commandID, 1, NULL, &menuItemIndex);
-    wxASSERT(err == noErr);
+        MenuItemIndex menuItemIndex;
+        err = GetIndMenuItemWithCommandID(hMenu, command.commandID, 1, NULL, &menuItemIndex);
+        wxASSERT(err == noErr);

                 
                     
                 
                     

-    MenuCommand id = command.commandID ;
-    wxMenuItem* item = NULL;
-    // for items we don't really control
-    if ( id == kHICommandPreferences )
-    {
-        id = wxApp::s_macPreferencesMenuItemId ;
+        MenuCommand id = command.commandID ;
+        wxMenuItem* item = NULL;

         
         

-        wxMenuBar* mbar = wxMenuBar::MacGetInstalledMenuBar() ;
-        if ( mbar )
+        // for items we don't really control
+        if ( id == kHICommandPreferences )

         {
         {

-            wxMenu* menu = NULL ;
-            item = mbar->FindItem( id , &menu ) ;
+            id = wxApp::s_macPreferencesMenuItemId ;
+        
+            wxMenuBar* mbar = wxMenuBar::MacGetInstalledMenuBar() ;
+            
+            if ( mbar )
+            {
+                wxMenu* menu = NULL ;
+                item = mbar->FindItem( id , &menu ) ;
+            }

         }
         }

-    }
-   else if (id != 0)
-        GetMenuItemRefCon( hMenu , menuItemIndex , (UInt32*) &item ) ;
+        else if (id != 0)
+            GetMenuItemRefCon( hMenu , menuItemIndex , (UInt32*) &item ) ;

 
 

-    if ( item )
-    {
-                if (item->IsCheckable())
-                {
-                    item->Check( !item->IsChecked() ) ;
-                }
+        if ( item )
+        {
+            if (item->IsCheckable())
+            {
+                item->Check( !item->IsChecked() ) ;
+            }

 
 

-                item->GetMenu()->SendEvent( id , item->IsCheckable() ? item->IsChecked() : -1 ) ;
-                result = noErr ;
-    }
-    return result ;
+            item->GetMenu()->SendEvent( id , item->IsCheckable() ? item->IsChecked() : -1 ) ;
+            result = noErr ;
+        }
+    
+        return result ;

     }
     
     wxASSERT(eventClass == kEventClassApplication && eventKind == kEventAppGetDockTileMenu);
     }
     
     wxASSERT(eventClass == kEventClassApplication && eventKind == kEventAppGetDockTileMenu);

-       
-       //set the internal event
-       pTB->SetInternalEvent(inEvent);
-       
-       //process the right click event
-       wxTaskBarIconEvent evt(wxEVT_TASKBAR_RIGHT_UP,NULL);
-       pTB->ProcessEvent(evt);
+                       
+       //process the right click events
+       wxTaskBarIconEvent downevt(wxEVT_TASKBAR_RIGHT_DOWN,NULL);
+       pTB->ProcessEvent(downevt);

                
                

-       //set the internal event
-       pTB->SetInternalEvent(NULL);
+       wxTaskBarIconEvent upevt(wxEVT_TASKBAR_RIGHT_UP,NULL);
+       pTB->ProcessEvent(upevt);
+
+    //create popup menu
+    wxMenu* menu = pTB->DoCreatePopupMenu();
+    
+    OSStatus err = noErr;
+
+    if(menu)
+    {
+        //note to self - a MenuRef IS A MenuHandle
+        MenuRef hMenu = MAC_WXHMENU(menu->GetHMenu());

 
 

-       return noErr;
+        //When we call SetEventParameter it will decrement
+        //the reference count of the menu - we need to make
+        //sure it stays around in the wxMenu class here
+        RetainMenu(hMenu);
+
+        //set the actual dock menu
+        err = SetEventParameter((EventRef) inEvent, kEventParamMenuRef, 
+                    typeMenuRef, sizeof(MenuRef), 
+                     &hMenu);
+        wxASSERT(err == 0);
+
+        return err;
+    }
+    else
+        return eventNotHandledErr;

 }
 
 DEFINE_ONE_SHOT_HANDLER_GETTER( wxDockEventHandler );
 
 wxTaskBarIcon::wxTaskBarIcon(const wxTaskBarIconType& nType)
 }
 
 DEFINE_ONE_SHOT_HANDLER_GETTER( wxDockEventHandler );
 
 wxTaskBarIcon::wxTaskBarIcon(const wxTaskBarIconType& nType)

-    : m_nType(nType), m_pEvent(NULL), m_pEventHandlerRef(NULL), m_pMenu(NULL), m_iconAdded(false)
+    : m_nType(nType), m_pEventHandlerRef(NULL), m_pMenu(NULL), 
+        m_theLastMenu((WXHMENU)GetApplicationDockTileMenu()), m_iconAdded(false) 

 {
     //Register the events that will return the dock menu
 {
     //Register the events that will return the dock menu

-       EventTypeSpec tbEventList[] = { { kEventClassCommand, kEventProcessCommand },
+    EventTypeSpec tbEventList[] = { { kEventClassCommand, kEventProcessCommand },

                                     { kEventClassApplication, kEventAppGetDockTileMenu } };
                                     { kEventClassApplication, kEventAppGetDockTileMenu } };

-       
+    

 #ifdef __WXDEBUG__
 #ifdef __WXDEBUG__

-       OSStatus err =
+    OSStatus err =

 #endif
 #endif

-      InstallApplicationEventHandler(
+    InstallApplicationEventHandler(

             GetwxDockEventHandlerUPP(),
             GetEventTypeCount(tbEventList), tbEventList, 
             GetwxDockEventHandlerUPP(),
             GetEventTypeCount(tbEventList), tbEventList, 

-                       this, (&(EventHandlerRef&)m_pEventHandlerRef));
-                       
-       wxASSERT(err == noErr);
+            this, (&(EventHandlerRef&)m_pEventHandlerRef));
+            
+    wxASSERT(err == noErr);
+    
+    Connect(wxEVT_TASKBAR_RIGHT_DOWN, wxTaskBarIconEventHandler(wxTaskBarIcon::OnRightDown));

 }
 
 wxTaskBarIcon::~wxTaskBarIcon()
 {
 }
 
 wxTaskBarIcon::~wxTaskBarIcon()
 {

+    //clean up event handler

     RemoveEventHandler((EventHandlerRef&)m_pEventHandlerRef);
     RemoveEventHandler((EventHandlerRef&)m_pEventHandlerRef);

-}

 
 

-void wxTaskBarIcon::SetInternalEvent(void* pEvent)
-{
-       m_pEvent = pEvent;
+    //restore old icon and menu to the dock
+    RemoveIcon();    

 }
 
 wxMenu* wxTaskBarIcon::GetCurrentMenu()
 }
 
 wxMenu* wxTaskBarIcon::GetCurrentMenu()


@@ -146,83 +161,140 @@ wxMenu* wxTaskBarIcon::GetCurrentMenu()
     return m_pMenu;
 }
 
     return m_pMenu;
 }
 

+wxMenu* wxTaskBarIcon::DoCreatePopupMenu()
+{    
+    wxMenu* theNewMenu = CreatePopupMenu();
+    
+    if (theNewMenu)
+    {
+        delete m_pMenu;
+        m_pMenu = theNewMenu;
+        m_pMenu->SetEventHandler(this);
+    }
+    
+    return m_pMenu;
+}
+

 // Operations:
 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 {
 // Operations:
 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 {

-    #if 0
-    wxASSERT(wxTheApp);
-    wxWindow* pTopWindow = wxTheApp->GetTopWindow();
-    
-    wxASSERT(pTopWindow);
+    wxBitmap bmp( icon ) ;
+    OSStatus err = noErr ;
+
+    CGImageRef pImage;

     
     

-    if(pTopWindow->IsKindOf(CLASSINFO(wxDialog)))
-        ((wxDialog*)pTopWindow)->SetIcon(icon);
-    else
+#if 0 // is always available under OSX now -- crashes on 10.2 in CFRetain() - RN
+    pImage = (CGImageRef) bmp.CGImageCreate() ;
+#else
+    WXHBITMAP iconport ;
+    WXHBITMAP maskport ;
+    iconport = bmp.GetHBITMAP( &maskport ) ;
+
+    if (!maskport)

     {
     {

-        wxASSERT(pTopWindow->IsKindOf(CLASSINFO(wxFrame)));
-        ((wxFrame*)pTopWindow)->SetIcon(icon);
-    }
+        // Make a mask with no transparent pixels
+        wxBitmap   mbmp(icon.GetWidth(), icon.GetHeight());
+        wxMemoryDC dc;
+        dc.SelectObject(mbmp);
+        dc.SetBackground(*wxBLACK_BRUSH);
+        dc.Clear();
+        dc.SelectObject(wxNullBitmap);
+        bmp.SetMask( new wxMask(mbmp, *wxWHITE) ) ;
+        iconport = bmp.GetHBITMAP( &maskport ) ;
+    } 

     
     

-    return true;
-    #else
-    //TODO: (IT WORKS!)  Make work without mask - mayby by using a wxDC?
-    
-    wxASSERT(icon.GetMask() != NULL);
-    
-       CGImageRef pImage;
-       //create the icon from the bitmap and mask bitmap contained within
-       OSStatus err = CreateCGImageFromPixMaps(
-               GetGWorldPixMap(MAC_WXHBITMAP(icon.GetHBITMAP())),
-               GetGWorldPixMap(MAC_WXHBITMAP(icon.GetMask()->GetMaskBitmap())),
-               &pImage
-               );
-               
-       wxASSERT(err == 0);
-       
-       err = SetApplicationDockTileImage(pImage);
-               
-       wxASSERT(err == 0);
+    //create the icon from the bitmap and mask bitmap contained within
+    err = CreateCGImageFromPixMaps(
+                                            GetGWorldPixMap(MAC_WXHBITMAP(iconport)),
+                                            GetGWorldPixMap(MAC_WXHBITMAP(maskport)),
+                                            &pImage
+                                            );    
+    wxASSERT(err == 0);
+#endif
+    wxASSERT(pImage != NULL );
+    err = SetApplicationDockTileImage(pImage);
+    
+    wxASSERT(err == 0);

     
     if (pImage != NULL)
         CGImageRelease(pImage);
     
     if (pImage != NULL)
         CGImageRelease(pImage);

-
-       return m_iconAdded = err == noErr;
-    #endif
+    
+    return m_iconAdded = err == noErr;

 }
 }

-       
+    

 bool wxTaskBarIcon::RemoveIcon()
 {
 bool wxTaskBarIcon::RemoveIcon()
 {

+    if(m_pMenu)
+    {
+        delete m_pMenu;
+        m_pMenu = NULL;
+    }
+    
+    //restore old icon to the dock

        OSStatus err = RestoreApplicationDockTileImage();
        wxASSERT(err == 0);
        OSStatus err = RestoreApplicationDockTileImage();
        wxASSERT(err == 0);

+    
+    //restore the old menu to the dock
+    SetApplicationDockTileMenu(MAC_WXHMENU(m_theLastMenu));

 
 

-       return !(m_iconAdded = !(err == noErr));
+    return !(m_iconAdded = !(err == noErr));

 }
 }

-       
+    

 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 {
 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 {

-       wxASSERT(m_pEvent != NULL);
-    
+    wxASSERT(menu != NULL);
+

     if (m_pMenu)
     if (m_pMenu)

+    {

         delete m_pMenu;
         delete m_pMenu;

-        
-    m_pMenu = menu;
-    menu->SetEventHandler(this);
-
-       //note to self - a MenuRef IS A MenuHandle
-       MenuRef hMenu = MAC_WXHMENU(menu->GetHMenu());
-
-       //When we call SetEventParameter it will decrement
-       //the reference count of the menu - we need to make
-       //sure it stays around in the wxMenu class here
-       RetainMenu(hMenu);
+        m_pMenu = NULL;
+    }
+    
+    //
+    // NB:  Here we have to perform a deep copy of the menu,
+    // copying each and every menu item from menu to m_pMenu.
+    // Other implementations use wxWindow::PopupMenu here, 
+    // which idle execution until the user selects something,
+    // but since the mac handles this internally, we can't - 
+    // and have no way at all to idle it while the dock menu
+    // is being shown before menu goes out of scope (it may
+    // not be on the heap, and may expire right after this function
+    // is done - we need it to last until the carbon event is triggered - 
+    // that's when the user right clicks).
+    //
+    // Also, since there is no equal (assignment) operator 
+    // on either wxMenu or wxMenuItem, we have to do all the
+    // dirty work ourselves.
+    //
+   
+    //Perform a deep copy of the menu
+    wxMenuItemList& theList = menu->GetMenuItems();
+    wxMenuItemList::compatibility_iterator theNode = theList.GetFirst();
+    
+    //create the main menu
+    m_pMenu = new wxMenu(menu->GetTitle());
+    
+    while(theNode != NULL)
+    {
+        wxMenuItem* theItem = theNode->GetData();
+        m_pMenu->Append(new wxMenuItem(        m_pMenu, //parent menu
+                                        theItem->GetId(), //id
+                                        theItem->GetText(), //text label
+                                        theItem->GetHelp(), //status bar help string
+                                        theItem->GetKind(), //menu flags - checkable, seperator, etc.
+                                        theItem->GetSubMenu() //submenu
+                                        ));
+        theNode = theNode->GetNext();
+    }
+    
+    m_pMenu->SetEventHandler(this);
+    return true;
+}

 
 

-       //set the actual dock menu
-       OSStatus err = SetEventParameter((EventRef) m_pEvent, kEventParamMenuRef, 
-                                       typeMenuRef, sizeof(MenuRef), 
-                                        &hMenu);
-       wxASSERT(err == 0);
-       
-       return err == noErr;
+//Skip the event so that popupmenu isn't called in parent, avoiding double-creation of the menus
+void wxTaskBarIcon::OnRightDown(wxTaskBarIconEvent& evt)
+{
+    evt.Skip();

 }
 
 #endif //wxHAS_TASK_BAR_ICON
 }
 
 #endif //wxHAS_TASK_BAR_ICON