src/msw/taskbar.cpp

   1 /////////////////////////////////////////////////////////////////////////
   2 // File:        src/msw/taskbar.cpp
   3 // Purpose:     Implements wxTaskBarIcon class for manipulating icons on
   4 //              the Windows task bar.
   5 // Author:      Julian Smart
   6 // Modified by: Vaclav Slavik
   7 // Created:     24/3/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c)
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////
  12
  13 // For compilers that support precompilation, includes "wx.h".
  14 #include "wx/wxprec.h"
  15
  16 #ifdef __BORLANDC__
  17     #pragma hdrstop
  18 #endif
  19
  20 #if wxUSE_TASKBARICON
  21
  22 #ifndef WX_PRECOMP
  23     #include "wx/window.h"
  24     #include "wx/frame.h"
  25     #include "wx/utils.h"
  26     #include "wx/menu.h"
  27 #endif
  28
  29 #include "wx/msw/wrapshl.h"
  30
  31 #include <string.h>
  32 #include "wx/taskbar.h"
  33 #include "wx/dynlib.h"
  34
  35 #ifndef NIN_BALLOONTIMEOUT
  36     #define NIN_BALLOONTIMEOUT      0x0404
  37     #define NIN_BALLOONUSERCLICK    0x0405
  38 #endif
  39
  40 #ifndef NIM_SETVERSION
  41     #define NIM_SETVERSION  0x00000004
  42 #endif
  43
  44 #ifndef NIF_INFO
  45     #define NIF_INFO        0x00000010
  46 #endif
  47
  48
  49 // initialized on demand
  50 static UINT gs_msgTaskbar = 0;
  51 static UINT gs_msgRestartTaskbar = 0;
  52
  53
  54 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
  55
  56 // ============================================================================
  57 // implementation
  58 // ============================================================================
  59
  60 // wrapper around Shell_NotifyIcon(): this function is not present in Win95
  61 // shell32.dll so load it dynamically to allow programs using wxTaskBarIcon to
  62 // start under this OS
  63 static BOOL wxShellNotifyIcon(DWORD dwMessage, NOTIFYICONDATA *pData)
  64 {
  65 #if wxUSE_DYNLIB_CLASS
  66     typedef BOOL (WINAPI *Shell_NotifyIcon_t)(DWORD, NOTIFYICONDATA *);
  67
  68     static Shell_NotifyIcon_t s_pfnShell_NotifyIcon = NULL;
  69     static bool s_initialized = false;
  70     if ( !s_initialized )
  71     {
  72         s_initialized = true;
  73
  74         wxLogNull noLog;
  75         wxDynamicLibrary dllShell("shell32.dll");
  76         if ( dllShell.IsLoaded() )
  77         {
  78             wxDL_INIT_FUNC_AW(s_pfn, Shell_NotifyIcon, dllShell);
  79         }
  80
  81         // NB: it's ok to destroy dllShell here, we link to shell32.dll
  82         //     implicitly so it won't be unloaded
  83     }
  84
  85     return s_pfnShell_NotifyIcon ? (*s_pfnShell_NotifyIcon)(dwMessage, pData)
  86                                  : FALSE;
  87 #else // !wxUSE_DYNLIB_CLASS
  88     return Shell_NotifyIcon(dwMessage, pData);
  89 #endif // wxUSE_DYNLIB_CLASS/!wxUSE_DYNLIB_CLASS
  90 }
  91
  92 // ----------------------------------------------------------------------------
  93 // wxTaskBarIconWindow: helper window
  94 // ----------------------------------------------------------------------------
  95
  96 // NB: this class serves two purposes:
  97 //     1. win32 needs a HWND associated with taskbar icon, this provides it
  98 //     2. we need wxTopLevelWindow so that the app doesn't exit when
  99 //        last frame is closed but there still is a taskbar icon
 100 class wxTaskBarIconWindow : public wxFrame
 101 {
 102 public:
 103     wxTaskBarIconWindow(wxTaskBarIcon *icon)
 104         : wxFrame(NULL, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0),
 105           m_icon(icon)
 106     {
 107     }
 108
 109     WXLRESULT MSWWindowProc(WXUINT msg,
 110                             WXWPARAM wParam, WXLPARAM lParam)
 111     {
 112         if (msg == gs_msgRestartTaskbar || msg == gs_msgTaskbar)
 113         {
 114             return m_icon->WindowProc(msg, wParam, lParam);
 115         }
 116         else
 117         {
 118             return wxFrame::MSWWindowProc(msg, wParam, lParam);
 119         }
 120     }
 121
 122 private:
 123     wxTaskBarIcon *m_icon;
 124 };
 125
 126
 127 // ----------------------------------------------------------------------------
 128 // NotifyIconData: wrapper around NOTIFYICONDATA
 129 // ----------------------------------------------------------------------------
 130
 131 struct NotifyIconData : public NOTIFYICONDATA
 132 {
 133     NotifyIconData(WXHWND hwnd)
 134     {
 135         memset(this, 0, sizeof(NOTIFYICONDATA));
 136         cbSize = sizeof(NOTIFYICONDATA);
 137         hWnd = (HWND) hwnd;
 138         uCallbackMessage = gs_msgTaskbar;
 139         uFlags = NIF_MESSAGE;
 140
 141         // we use the same id for all taskbar icons as we don't need it to
 142         // distinguish between them
 143         uID = 99;
 144     }
 145 };
 146
 147 // ----------------------------------------------------------------------------
 148 // wxTaskBarIcon
 149 // ----------------------------------------------------------------------------
 150
 151 wxTaskBarIcon::wxTaskBarIcon()
 152 {
 153     m_win = NULL;
 154     m_iconAdded = false;
 155     RegisterWindowMessages();
 156 }
 157
 158 wxTaskBarIcon::~wxTaskBarIcon()
 159 {
 160     if ( m_iconAdded )
 161         RemoveIcon();
 162
 163     if ( m_win )
 164     {
 165         // we must use delete and not Destroy() here because the latter will
 166         // only schedule the window to be deleted during the next idle event
 167         // processing but we may not get any idle events if there are no other
 168         // windows left in the program
 169         delete m_win;
 170     }
 171 }
 172
 173 // Operations
 174 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 175 {
 176     // NB: we have to create the window lazily because of backward compatibility,
 177     //     old applications may create a wxTaskBarIcon instance before wxApp
 178     //     is initialized (as samples/taskbar used to do)
 179     if (!m_win)
 180     {
 181         m_win = new wxTaskBarIconWindow(this);
 182     }
 183
 184     m_icon = icon;
 185     m_strTooltip = tooltip;
 186
 187     NotifyIconData notifyData(GetHwndOf(m_win));
 188
 189     if (icon.Ok())
 190     {
 191         notifyData.uFlags |= NIF_ICON;
 192         notifyData.hIcon = GetHiconOf(icon);
 193     }
 194
 195     // set NIF_TIP even for an empty tooltip: otherwise it would be impossible
 196     // to remove an existing tooltip using this function
 197     notifyData.uFlags |= NIF_TIP;
 198     if ( !tooltip.empty() )
 199     {
 200         wxStrlcpy(notifyData.szTip, tooltip.wx_str(), WXSIZEOF(notifyData.szTip));
 201     }
 202
 203     bool ok = wxShellNotifyIcon(m_iconAdded ? NIM_MODIFY
 204                                             : NIM_ADD, &notifyData) != 0;
 205
 206     if ( !ok )
 207     {
 208         wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY/ADD)"));
 209     }
 210
 211     if ( !m_iconAdded && ok )
 212         m_iconAdded = true;
 213
 214     return ok;
 215 }
 216
 217 #if wxUSE_TASKBARICON_BALLOONS
 218
 219 bool
 220 wxTaskBarIcon::ShowBalloon(const wxString& title,
 221                            const wxString& text,
 222                            unsigned msec,
 223                            int flags)
 224 {
 225     wxCHECK_MSG( m_iconAdded, false,
 226                     wxT("can't be used before the icon is created") );
 227
 228     const HWND hwnd = GetHwndOf(m_win);
 229
 230     // we need to enable version 5.0 behaviour to receive notifications about
 231     // the balloon disappearance
 232     NotifyIconData notifyData(hwnd);
 233     notifyData.uFlags = 0;
 234     notifyData.uVersion = 3 /* NOTIFYICON_VERSION for Windows XP */;
 235
 236     if ( !wxShellNotifyIcon(NIM_SETVERSION, &notifyData) )
 237     {
 238         wxLogLastError(wxT("wxShellNotifyIcon(NIM_SETVERSION)"));
 239     }
 240
 241     // do show the balloon now
 242     notifyData = NotifyIconData(hwnd);
 243     notifyData.uFlags |= NIF_INFO;
 244     notifyData.uTimeout = msec;
 245     wxStrlcpy(notifyData.szInfo, text.wx_str(), WXSIZEOF(notifyData.szInfo));
 246     wxStrlcpy(notifyData.szInfoTitle, title.wx_str(),
 247                 WXSIZEOF(notifyData.szInfoTitle));
 248
 249     if ( flags & wxICON_INFORMATION )
 250         notifyData.dwInfoFlags |= NIIF_INFO;
 251     else if ( flags & wxICON_WARNING )
 252         notifyData.dwInfoFlags |= NIIF_WARNING;
 253     else if ( flags & wxICON_ERROR )
 254         notifyData.dwInfoFlags |= NIIF_ERROR;
 255
 256     bool ok = wxShellNotifyIcon(NIM_MODIFY, &notifyData) != 0;
 257     if ( !ok )
 258     {
 259         wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY)"));
 260     }
 261
 262     return ok;
 263 }
 264
 265 #endif // wxUSE_TASKBARICON_BALLOONS
 266
 267 bool wxTaskBarIcon::RemoveIcon()
 268 {
 269     if (!m_iconAdded)
 270         return false;
 271
 272     m_iconAdded = false;
 273
 274     NotifyIconData notifyData(GetHwndOf(m_win));
 275
 276     bool ok = wxShellNotifyIcon(NIM_DELETE, &notifyData) != 0;
 277     if ( !ok )
 278     {
 279         wxLogLastError(wxT("wxShellNotifyIcon(NIM_DELETE)"));
 280     }
 281
 282     return ok;
 283 }
 284
 285 #if wxUSE_MENUS
 286 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 287 {
 288     wxASSERT_MSG( m_win != NULL, wxT("taskbar icon not initialized") );
 289
 290     static bool s_inPopup = false;
 291
 292     if (s_inPopup)
 293         return false;
 294
 295     s_inPopup = true;
 296
 297     int         x, y;
 298     wxGetMousePosition(&x, &y);
 299
 300     m_win->Move(x, y);
 301
 302     m_win->PushEventHandler(this);
 303
 304     menu->UpdateUI();
 305
 306     // the SetForegroundWindow() and PostMessage() calls are needed to work
 307     // around Win32 bug with the popup menus shown for the notifications as
 308     // documented at http://support.microsoft.com/kb/q135788/
 309     ::SetForegroundWindow(GetHwndOf(m_win));
 310
 311     bool rval = m_win->PopupMenu(menu, 0, 0);
 312
 313     ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L);
 314
 315     m_win->PopEventHandler(false);
 316
 317     s_inPopup = false;
 318
 319     return rval;
 320 }
 321 #endif // wxUSE_MENUS
 322
 323 void wxTaskBarIcon::RegisterWindowMessages()
 324 {
 325     static bool s_registered = false;
 326
 327     if ( !s_registered )
 328     {
 329         // Taskbar restart msg will be sent to us if the icon needs to be redrawn
 330         gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));
 331
 332         // Also register the taskbar message here
 333         gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));
 334
 335         s_registered = true;
 336     }
 337 }
 338
 339 // ----------------------------------------------------------------------------
 340 // wxTaskBarIcon window proc
 341 // ----------------------------------------------------------------------------
 342
 343 long wxTaskBarIcon::WindowProc(unsigned int msg,
 344                                unsigned int WXUNUSED(wParam),
 345                                long lParam)
 346 {
 347     if ( msg == gs_msgRestartTaskbar )   // does the icon need to be redrawn?
 348     {
 349         m_iconAdded = false;
 350         SetIcon(m_icon, m_strTooltip);
 351         return 0;
 352     }
 353
 354     // this function should only be called for gs_msg(Restart)Taskbar messages
 355     wxASSERT( msg == gs_msgTaskbar );
 356
 357     wxEventType eventType = 0;
 358     switch ( lParam )
 359     {
 360         case WM_LBUTTONDOWN:
 361             eventType = wxEVT_TASKBAR_LEFT_DOWN;
 362             break;
 363
 364         case WM_LBUTTONUP:
 365             eventType = wxEVT_TASKBAR_LEFT_UP;
 366             break;
 367
 368         case WM_RBUTTONDOWN:
 369             eventType = wxEVT_TASKBAR_RIGHT_DOWN;
 370             break;
 371
 372         case WM_RBUTTONUP:
 373             eventType = wxEVT_TASKBAR_RIGHT_UP;
 374             break;
 375
 376         case WM_LBUTTONDBLCLK:
 377             eventType = wxEVT_TASKBAR_LEFT_DCLICK;
 378             break;
 379
 380         case WM_RBUTTONDBLCLK:
 381             eventType = wxEVT_TASKBAR_RIGHT_DCLICK;
 382             break;
 383
 384         case WM_MOUSEMOVE:
 385             eventType = wxEVT_TASKBAR_MOVE;
 386             break;
 387
 388         case NIN_BALLOONTIMEOUT:
 389             eventType = wxEVT_TASKBAR_BALLOON_TIMEOUT;
 390             break;
 391
 392         case NIN_BALLOONUSERCLICK:
 393             eventType = wxEVT_TASKBAR_BALLOON_CLICK;
 394             break;
 395     }
 396
 397     if ( eventType )
 398     {
 399         wxTaskBarIconEvent event(eventType, this);
 400
 401         ProcessEvent(event);
 402     }
 403
 404     return 0;
 405 }
 406
 407 #endif // wxUSE_TASKBARICON
 408