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 #ifndef WX_PRECOMP
  21     #include "wx/window.h"
  22     #include "wx/frame.h"
  23     #include "wx/utils.h"
  24     #include "wx/menu.h"
  25 #endif
  26
  27 #include "wx/msw/private.h"
  28 #include "wx/msw/winundef.h"
  29
  30 #include <string.h>
  31 #include "wx/taskbar.h"
  32
  33 #ifdef __WXWINCE__
  34     #include <winreg.h>
  35     #include <shellapi.h>
  36 #endif
  37
  38 // initialized on demand
  39 UINT   gs_msgTaskbar = 0;
  40 UINT   gs_msgRestartTaskbar = 0;
  41
  42
  43 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
  44
  45 // ============================================================================
  46 // implementation
  47 // ============================================================================
  48
  49 // ----------------------------------------------------------------------------
  50 // wxTaskBarIconWindow: helper window
  51 // ----------------------------------------------------------------------------
  52
  53 // NB: this class serves two purposes:
  54 //     1. win32 needs a HWND associated with taskbar icon, this provides it
  55 //     2. we need wxTopLevelWindow so that the app doesn't exit when
  56 //        last frame is closed but there still is a taskbar icon
  57 class wxTaskBarIconWindow : public wxFrame
  58 {
  59 public:
  60     wxTaskBarIconWindow(wxTaskBarIcon *icon)
  61         : wxFrame(NULL, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0),
  62           m_icon(icon)
  63     {
  64     }
  65
  66     WXLRESULT MSWWindowProc(WXUINT msg,
  67                             WXWPARAM wParam, WXLPARAM lParam)
  68     {
  69         if (msg == gs_msgRestartTaskbar || msg == gs_msgTaskbar)
  70         {
  71             return m_icon->WindowProc(msg, wParam, lParam);
  72         }
  73         else
  74         {
  75             return wxFrame::MSWWindowProc(msg, wParam, lParam);
  76         }
  77     }
  78
  79 private:
  80     wxTaskBarIcon *m_icon;
  81 };
  82
  83
  84 // ----------------------------------------------------------------------------
  85 // NotifyIconData: wrapper around NOTIFYICONDATA
  86 // ----------------------------------------------------------------------------
  87
  88 struct NotifyIconData : public NOTIFYICONDATA
  89 {
  90     NotifyIconData(WXHWND hwnd)
  91     {
  92         memset(this, 0, sizeof(NOTIFYICONDATA));
  93         cbSize = sizeof(NOTIFYICONDATA);
  94         hWnd = (HWND) hwnd;
  95         uCallbackMessage = gs_msgTaskbar;
  96         uFlags = NIF_MESSAGE;
  97
  98         // we use the same id for all taskbar icons as we don't need it to
  99         // distinguish between them
 100         uID = 99;
 101     }
 102 };
 103
 104 // ----------------------------------------------------------------------------
 105 // wxTaskBarIcon
 106 // ----------------------------------------------------------------------------
 107
 108 wxTaskBarIcon::wxTaskBarIcon()
 109 {
 110     m_win = NULL;
 111     m_iconAdded = false;
 112     RegisterWindowMessages();
 113 }
 114
 115 wxTaskBarIcon::~wxTaskBarIcon()
 116 {
 117     if (m_iconAdded)
 118         RemoveIcon();
 119
 120     if (m_win)
 121         m_win->Destroy();
 122 }
 123
 124 // Operations
 125 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 126 {
 127     // NB: we have to create the window lazily because of backward compatibility,
 128     //     old applications may create a wxTaskBarIcon instance before wxApp
 129     //     is initialized (as samples/taskbar used to do)
 130     if (!m_win)
 131     {
 132         m_win = new wxTaskBarIconWindow(this);
 133     }
 134
 135     m_icon = icon;
 136     m_strTooltip = tooltip;
 137
 138     NotifyIconData notifyData(GetHwndOf(m_win));
 139
 140     if (icon.Ok())
 141     {
 142         notifyData.uFlags |= NIF_ICON;
 143         notifyData.hIcon = GetHiconOf(icon);
 144     }
 145
 146     // set NIF_TIP even for an empty tooltip: otherwise it would be impossible
 147     // to remove an existing tooltip using this function
 148     notifyData.uFlags |= NIF_TIP;
 149     if ( !tooltip.empty() )
 150     {
 151         wxStrncpy(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));
 152     }
 153
 154     bool ok = Shell_NotifyIcon(m_iconAdded ? NIM_MODIFY
 155                                            : NIM_ADD, &notifyData) != 0;
 156
 157     if ( !m_iconAdded && ok )
 158         m_iconAdded = true;
 159
 160     return ok;
 161 }
 162
 163 bool wxTaskBarIcon::RemoveIcon()
 164 {
 165     if (!m_iconAdded)
 166         return false;
 167
 168     m_iconAdded = false;
 169
 170     NotifyIconData notifyData(GetHwndOf(m_win));
 171
 172     return Shell_NotifyIcon(NIM_DELETE, &notifyData) != 0;
 173 }
 174
 175 #if wxUSE_MENUS
 176 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 177 {
 178     wxASSERT_MSG( m_win != NULL, _T("taskbar icon not initialized") );
 179
 180     static bool s_inPopup = false;
 181
 182     if (s_inPopup)
 183         return false;
 184
 185     s_inPopup = true;
 186
 187     int         x, y;
 188     wxGetMousePosition(&x, &y);
 189
 190     m_win->Move(x, y);
 191
 192     m_win->PushEventHandler(this);
 193
 194     menu->UpdateUI();
 195
 196     // the SetForegroundWindow() and PostMessage() calls are needed to work
 197     // around Win32 bug with the popup menus shown for the notifications as
 198     // documented at http://support.microsoft.com/kb/q135788/
 199     ::SetForegroundWindow(GetHwndOf(m_win));
 200
 201     bool rval = m_win->PopupMenu(menu, 0, 0);
 202
 203     ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L);
 204
 205     m_win->PopEventHandler(false);
 206
 207     s_inPopup = false;
 208
 209     return rval;
 210 }
 211 #endif // wxUSE_MENUS
 212
 213 void wxTaskBarIcon::RegisterWindowMessages()
 214 {
 215     static bool s_registered = false;
 216
 217     if ( !s_registered )
 218     {
 219         // Taskbar restart msg will be sent to us if the icon needs to be redrawn
 220         gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));
 221
 222         // Also register the taskbar message here
 223         gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));
 224
 225         s_registered = true;
 226     }
 227 }
 228
 229 // ----------------------------------------------------------------------------
 230 // wxTaskBarIcon window proc
 231 // ----------------------------------------------------------------------------
 232
 233 long wxTaskBarIcon::WindowProc(unsigned int msg,
 234                                unsigned int WXUNUSED(wParam),
 235                                long lParam)
 236 {
 237     wxEventType eventType = 0;
 238
 239     if (msg == gs_msgRestartTaskbar)   // does the icon need to be redrawn?
 240     {
 241         m_iconAdded = false;
 242         SetIcon(m_icon, m_strTooltip);
 243     }
 244
 245     // this function should only be called for gs_msg(Restart)Taskbar messages
 246     wxASSERT(msg == gs_msgTaskbar);
 247
 248     switch (lParam)
 249     {
 250         case WM_LBUTTONDOWN:
 251             eventType = wxEVT_TASKBAR_LEFT_DOWN;
 252             break;
 253
 254         case WM_LBUTTONUP:
 255             eventType = wxEVT_TASKBAR_LEFT_UP;
 256             break;
 257
 258         case WM_RBUTTONDOWN:
 259             eventType = wxEVT_TASKBAR_RIGHT_DOWN;
 260             break;
 261
 262         case WM_RBUTTONUP:
 263             eventType = wxEVT_TASKBAR_RIGHT_UP;
 264             break;
 265
 266         case WM_LBUTTONDBLCLK:
 267             eventType = wxEVT_TASKBAR_LEFT_DCLICK;
 268             break;
 269
 270         case WM_RBUTTONDBLCLK:
 271             eventType = wxEVT_TASKBAR_RIGHT_DCLICK;
 272             break;
 273
 274         case WM_MOUSEMOVE:
 275             eventType = wxEVT_TASKBAR_MOVE;
 276             break;
 277
 278         default:
 279             break;
 280     }
 281
 282     if (eventType)
 283     {
 284         wxTaskBarIconEvent event(eventType, this);
 285
 286         ProcessEvent(event);
 287     }
 288
 289     return 0;
 290 }