src/mac/carbon/taskbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        taskbar.cpp
   3 // Purpose:     wxTaskBarIcon OSX Implementation
   4 // Author:      Ryan Norton
   5 // Modified by:
   6 // Created:     09/25/2004
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2004 Ryan Norton
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #include "wx/wxprec.h"
  13
  14 #ifdef wxHAS_TASK_BAR_ICON
  15
  16 #include "wx/mac/private.h"
  17
  18 #include "wx/taskbar.h"
  19 #include "wx/menu.h"
  20 #include "wx/icon.h"
  21 #include "wx/dcmemory.h"
  22
  23 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
  24
  25 pascal OSStatus wxDockEventHandler( EventHandlerCallRef inHandlerCallRef,
  26                                     EventRef inEvent, void* pData)
  27 {
  28     wxTaskBarIcon*& pTB = (wxTaskBarIcon*&) pData;
  29
  30     const UInt32 eventClass = GetEventClass(inEvent);
  31     const UInt32 eventKind = GetEventKind(inEvent);
  32
  33     if (eventClass == kEventClassCommand && eventKind == kEventCommandProcess)
  34     {
  35         //TODO: This is a complete copy of
  36         //static pascal OSStatus wxMacAppCommandEventHandler( EventHandlerCallRef handler , EventRef event , void *data )
  37
  38         if (! pTB->GetCurrentMenu() )
  39         {
  40             return eventNotHandledErr;
  41         }
  42
  43         MenuRef hMenu = MAC_WXHMENU(pTB->GetCurrentMenu()->GetHMenu());
  44         OSStatus result = eventNotHandledErr ;
  45
  46         HICommand command ;
  47         OSErr err;
  48
  49         err =    GetEventParameter(inEvent, kEventParamDirectObject, typeHICommand,
  50                             NULL, sizeof(HICommand), NULL, &command);
  51         wxASSERT(err == noErr);
  52
  53         MenuItemIndex menuItemIndex;
  54         err = GetIndMenuItemWithCommandID(hMenu, command.commandID, 1, NULL, &menuItemIndex);
  55         wxASSERT(err == noErr);
  56
  57
  58         MenuCommand id = command.commandID ;
  59         wxMenuItem* item = NULL;
  60
  61         // for items we don't really control
  62         if ( id == kHICommandPreferences )
  63         {
  64             id = wxApp::s_macPreferencesMenuItemId ;
  65
  66             wxMenuBar* mbar = wxMenuBar::MacGetInstalledMenuBar() ;
  67
  68             if ( mbar )
  69             {
  70                 wxMenu* menu = NULL ;
  71                 item = mbar->FindItem( id , &menu ) ;
  72             }
  73         }
  74         else if (id != 0)
  75             GetMenuItemRefCon( hMenu , menuItemIndex , (UInt32*) &item ) ;
  76
  77         if ( item )
  78         {
  79             if (item->IsCheckable())
  80             {
  81                 item->Check( !item->IsChecked() ) ;
  82             }
  83
  84             item->GetMenu()->SendEvent( id , item->IsCheckable() ? item->IsChecked() : -1 ) ;
  85             result = noErr ;
  86         }
  87
  88         return result ;
  89     }
  90
  91     wxASSERT(eventClass == kEventClassApplication && eventKind == kEventAppGetDockTileMenu);
  92
  93         //process the right click events
  94         wxTaskBarIconEvent downevt(wxEVT_TASKBAR_RIGHT_DOWN,NULL);
  95         pTB->ProcessEvent(downevt);
  96
  97         wxTaskBarIconEvent upevt(wxEVT_TASKBAR_RIGHT_UP,NULL);
  98         pTB->ProcessEvent(upevt);
  99
 100     //create popup menu
 101     wxMenu* menu = pTB->DoCreatePopupMenu();
 102
 103     OSStatus err = noErr;
 104
 105     if(menu)
 106     {
 107         //note to self - a MenuRef IS A MenuHandle
 108         MenuRef hMenu = MAC_WXHMENU(menu->GetHMenu());
 109
 110         //When we call SetEventParameter it will decrement
 111         //the reference count of the menu - we need to make
 112         //sure it stays around in the wxMenu class here
 113         RetainMenu(hMenu);
 114
 115         //set the actual dock menu
 116         err = SetEventParameter((EventRef) inEvent, kEventParamMenuRef,
 117                     typeMenuRef, sizeof(MenuRef),
 118                      &hMenu);
 119         wxASSERT(err == 0);
 120
 121         return err;
 122     }
 123     else
 124         return eventNotHandledErr;
 125 }
 126
 127 DEFINE_ONE_SHOT_HANDLER_GETTER( wxDockEventHandler );
 128
 129 wxTaskBarIcon::wxTaskBarIcon(const wxTaskBarIconType& nType)
 130     : m_nType(nType), m_pEventHandlerRef(NULL), m_pMenu(NULL),
 131         m_theLastMenu((WXHMENU)GetApplicationDockTileMenu()), m_iconAdded(false)
 132 {
 133     //Register the events that will return the dock menu
 134     EventTypeSpec tbEventList[] = { { kEventClassCommand, kEventProcessCommand },
 135                                     { kEventClassApplication, kEventAppGetDockTileMenu } };
 136
 137 #ifdef __WXDEBUG__
 138     OSStatus err =
 139 #endif
 140     InstallApplicationEventHandler(
 141             GetwxDockEventHandlerUPP(),
 142             GetEventTypeCount(tbEventList), tbEventList,
 143             this, (&(EventHandlerRef&)m_pEventHandlerRef));
 144
 145     wxASSERT(err == noErr);
 146
 147     Connect(wxEVT_TASKBAR_RIGHT_DOWN, wxTaskBarIconEventHandler(wxTaskBarIcon::OnRightDown));
 148 }
 149
 150 wxTaskBarIcon::~wxTaskBarIcon()
 151 {
 152     //clean up event handler
 153     RemoveEventHandler((EventHandlerRef&)m_pEventHandlerRef);
 154
 155     //restore old icon and menu to the dock
 156     RemoveIcon();
 157 }
 158
 159 wxMenu* wxTaskBarIcon::GetCurrentMenu()
 160 {
 161     return m_pMenu;
 162 }
 163
 164 wxMenu* wxTaskBarIcon::DoCreatePopupMenu()
 165 {
 166     wxMenu* theNewMenu = CreatePopupMenu();
 167
 168     if (theNewMenu)
 169     {
 170         delete m_pMenu;
 171         m_pMenu = theNewMenu;
 172         m_pMenu->SetEventHandler(this);
 173     }
 174
 175     return m_pMenu;
 176 }
 177
 178 // Operations:
 179 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 180 {
 181     wxBitmap bmp( icon ) ;
 182     OSStatus err = noErr ;
 183
 184     CGImageRef pImage;
 185
 186 #if 0 // is always available under OSX now -- crashes on 10.2 in CFRetain() - RN
 187     pImage = (CGImageRef) bmp.CGImageCreate() ;
 188 #else
 189     WXHBITMAP iconport ;
 190     WXHBITMAP maskport ;
 191     iconport = bmp.GetHBITMAP( &maskport ) ;
 192
 193     if (!maskport)
 194     {
 195         // Make a mask with no transparent pixels
 196         wxBitmap   mbmp(icon.GetWidth(), icon.GetHeight());
 197         wxMemoryDC dc;
 198         dc.SelectObject(mbmp);
 199         dc.SetBackground(*wxBLACK_BRUSH);
 200         dc.Clear();
 201         dc.SelectObject(wxNullBitmap);
 202         bmp.SetMask( new wxMask(mbmp, *wxWHITE) ) ;
 203         iconport = bmp.GetHBITMAP( &maskport ) ;
 204     }
 205
 206     //create the icon from the bitmap and mask bitmap contained within
 207     err = CreateCGImageFromPixMaps(
 208                                             GetGWorldPixMap(MAC_WXHBITMAP(iconport)),
 209                                             GetGWorldPixMap(MAC_WXHBITMAP(maskport)),
 210                                             &pImage
 211                                             );
 212     wxASSERT(err == 0);
 213 #endif
 214     wxASSERT(pImage != NULL );
 215     err = SetApplicationDockTileImage(pImage);
 216
 217     wxASSERT(err == 0);
 218
 219     if (pImage != NULL)
 220         CGImageRelease(pImage);
 221
 222     return m_iconAdded = err == noErr;
 223 }
 224
 225 bool wxTaskBarIcon::RemoveIcon()
 226 {
 227     if(m_pMenu)
 228     {
 229         delete m_pMenu;
 230         m_pMenu = NULL;
 231     }
 232
 233     //restore old icon to the dock
 234         OSStatus err = RestoreApplicationDockTileImage();
 235         wxASSERT(err == 0);
 236
 237     //restore the old menu to the dock
 238     SetApplicationDockTileMenu(MAC_WXHMENU(m_theLastMenu));
 239
 240     return !(m_iconAdded = !(err == noErr));
 241 }
 242
 243 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 244 {
 245     wxASSERT(menu != NULL);
 246
 247     if (m_pMenu)
 248     {
 249         delete m_pMenu;
 250         m_pMenu = NULL;
 251     }
 252
 253     //
 254     // NB:  Here we have to perform a deep copy of the menu,
 255     // copying each and every menu item from menu to m_pMenu.
 256     // Other implementations use wxWindow::PopupMenu here,
 257     // which idle execution until the user selects something,
 258     // but since the mac handles this internally, we can't -
 259     // and have no way at all to idle it while the dock menu
 260     // is being shown before menu goes out of scope (it may
 261     // not be on the heap, and may expire right after this function
 262     // is done - we need it to last until the carbon event is triggered -
 263     // that's when the user right clicks).
 264     //
 265     // Also, since there is no equal (assignment) operator
 266     // on either wxMenu or wxMenuItem, we have to do all the
 267     // dirty work ourselves.
 268     //
 269
 270     //Perform a deep copy of the menu
 271     wxMenuItemList& theList = menu->GetMenuItems();
 272     wxMenuItemList::compatibility_iterator theNode = theList.GetFirst();
 273
 274     //create the main menu
 275     m_pMenu = new wxMenu(menu->GetTitle());
 276
 277     while(theNode != NULL)
 278     {
 279         wxMenuItem* theItem = theNode->GetData();
 280         m_pMenu->Append(new wxMenuItem( m_pMenu, //parent menu
 281                                         theItem->GetId(), //id
 282                                         theItem->GetText(), //text label
 283                                         theItem->GetHelp(), //status bar help string
 284                                         theItem->GetKind(), //menu flags - checkable, separator, etc.
 285                                         theItem->GetSubMenu() //submenu
 286                                         ));
 287         theNode = theNode->GetNext();
 288     }
 289
 290     m_pMenu->SetEventHandler(this);
 291     return true;
 292 }
 293
 294 //Skip the event so that popupmenu isn't called in parent, avoiding double-creation of the menus
 295 void wxTaskBarIcon::OnRightDown(wxTaskBarIconEvent& evt)
 296 {
 297     evt.Skip();
 298 }
 299
 300 #endif //wxHAS_TASK_BAR_ICON