workaround because regions that were built up, were sometimes being drawn on the...

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

diff --git a/src/mac/carbon/taskbar.cpp b/src/mac/carbon/taskbar.cpp
index df0eb5a9b76bb798d4ecb8641e6f5afe008eb40f..a37330054691de5caf9b4a58decd2ed45587bd17 100644 (file)
--- a/src/mac/carbon/taskbar.cpp
+++ b/src/mac/carbon/taskbar.cpp
@@ -1,70 +1,300 @@
-/////////////////////////////////////////////////////////////////////////
-// File:        taskbar.cpp
-// Purpose:        Implements wxTaskBarIcon class for manipulating icons on
-//              the task bar. Optional.
-// Author:      Stefan Csomor
+/////////////////////////////////////////////////////////////////////////////
+// Name:        taskbar.cpp
+// Purpose:     wxTaskBarIcon OSX Implementation
+// Author:      Ryan Norton

 // Modified by:
 // Modified by:

-// Created:     1998-01-01
+// Created:     09/25/2004

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

-// Copyright:   (c)
-// Licence:       wxWindows licence
-/////////////////////////////////////////////////////////////////////////
+// Copyright:   (c) 2004 Ryan Norton
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////

 
 

-#ifdef __GNUG__
-#pragma implementation "taskbar.h"
-#endif
+#include "wx/wxprec.h"
+
+#ifdef wxHAS_TASK_BAR_ICON
+
+#include "wx/mac/private.h"

 
 #include "wx/taskbar.h"
 
 #include "wx/taskbar.h"

+#include "wx/menu.h"
+#include "wx/icon.h"
+#include "wx/dcmemory.h"

 
 

-wxTaskBarIcon::wxTaskBarIcon()
-{
-    // TODO
-}
+IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)

 
 

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

 {
 {

-    // TODO
-}
+    wxTaskBarIcon*& pTB = (wxTaskBarIcon*&) pData;

 
 

-// Operations
-bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
-{
-    // TODO
-    return FALSE;
-}
+    const UInt32 eventClass = GetEventClass(inEvent);
+    const UInt32 eventKind = GetEventKind(inEvent);
+            
+    if (eventClass == kEventClassCommand && eventKind == kEventCommandProcess) 
+    {
+        //TODO:        This is a complete copy of 
+        //static pascal OSStatus wxMacAppCommandEventHandler( EventHandlerCallRef handler , EventRef event , void *data )

 
 

-bool wxTaskBarIcon::RemoveIcon()
-{
-    // TODO
-    return FALSE;
+        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);
+        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 ;
+        
+            wxMenuBar* mbar = wxMenuBar::MacGetInstalledMenuBar() ;
+            
+            if ( mbar )
+            {
+                wxMenu* menu = NULL ;
+                item = mbar->FindItem( id , &menu ) ;
+            }
+        }
+        else if (id != 0)
+            GetMenuItemRefCon( hMenu , menuItemIndex , (UInt32*) &item ) ;
+
+        if ( item )
+        {
+            if (item->IsCheckable())
+            {
+                item->Check( !item->IsChecked() ) ;
+            }
+
+            item->GetMenu()->SendEvent( id , item->IsCheckable() ? item->IsChecked() : -1 ) ;
+            result = noErr ;
+        }
+    
+        return result ;
+    }
+    
+    wxASSERT(eventClass == kEventClassApplication && eventKind == kEventAppGetDockTileMenu);
+                       
+       //process the right click events
+       wxTaskBarIconEvent downevt(wxEVT_TASKBAR_RIGHT_DOWN,NULL);
+       pTB->ProcessEvent(downevt);
+               
+       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());
+
+        //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;

 }
 
 }
 

-// Overridables
-void wxTaskBarIcon::OnMouseMove()
+DEFINE_ONE_SHOT_HANDLER_GETTER( wxDockEventHandler );
+
+wxTaskBarIcon::wxTaskBarIcon(const wxTaskBarIconType& nType)
+    : 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
+    EventTypeSpec tbEventList[] = { { kEventClassCommand, kEventProcessCommand },
+                                    { kEventClassApplication, kEventAppGetDockTileMenu } };
+    
+#ifdef __WXDEBUG__
+    OSStatus err =
+#endif
+    InstallApplicationEventHandler(
+            GetwxDockEventHandlerUPP(),
+            GetEventTypeCount(tbEventList), tbEventList, 
+            this, (&(EventHandlerRef&)m_pEventHandlerRef));
+            
+    wxASSERT(err == noErr);
+    
+    Connect(wxEVT_TASKBAR_RIGHT_DOWN, wxTaskBarIconEventHandler(wxTaskBarIcon::OnRightDown));

 }
 
 }
 

-void wxTaskBarIcon::OnLButtonDown()
+wxTaskBarIcon::~wxTaskBarIcon()

 {
 {

+    //clean up event handler
+    RemoveEventHandler((EventHandlerRef&)m_pEventHandlerRef);
+
+    //restore old icon and menu to the dock
+    RemoveIcon();    

 }
 
 }
 

-void wxTaskBarIcon::OnLButtonUp()
+wxMenu* wxTaskBarIcon::GetCurrentMenu()

 {
 {

+    return m_pMenu;

 }
 
 }
 

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

 }
 
 }
 

-void wxTaskBarIcon::OnRButtonUp()
+// Operations:
+bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)

 {
 {

+    wxBitmap bmp( icon ) ;
+    OSStatus err = noErr ;
+
+    CGImageRef pImage;
+    
+#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)
+    {
+        // 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 ) ;
+    } 
+    
+    //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);
+    
+    return m_iconAdded = err == noErr;

 }
 }

+    
+bool wxTaskBarIcon::RemoveIcon()
+{
+    if(m_pMenu)
+    {
+        delete m_pMenu;
+        m_pMenu = NULL;
+    }
+    
+    //restore old icon to the dock
+       OSStatus err = RestoreApplicationDockTileImage();
+       wxASSERT(err == 0);
+    
+    //restore the old menu to the dock
+    SetApplicationDockTileMenu(MAC_WXHMENU(m_theLastMenu));

 
 

-void wxTaskBarIcon::OnLButtonDClick()
+    return !(m_iconAdded = !(err == noErr));
+}
+    
+bool wxTaskBarIcon::PopupMenu(wxMenu *menu)

 {
 {

+    wxASSERT(menu != NULL);
+
+    if (m_pMenu)
+    {
+        delete m_pMenu;
+        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, separator, etc.
+                                        theItem->GetSubMenu() //submenu
+                                        ));
+        theNode = theNode->GetNext();
+    }
+    
+    m_pMenu->SetEventHandler(this);
+    return true;

 }
 
 }
 

-void wxTaskBarIcon::OnRButtonDClick()
+//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