src/msw/taskbar.cpp

   1 /////////////////////////////////////////////////////////////////////////
   2 // File:        taskbar.cpp
   3 // Purpose:     Implements wxTaskBarIcon class for manipulating icons on
   4 //              the Windows task bar.
   5 // Author:      Julian Smart
   6 // Modified by:
   7 // Created:     24/3/98
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c)
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////
  12
  13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  14 #pragma implementation "taskbar.h"
  15 #endif
  16
  17 // For compilers that support precompilation, includes "wx.h".
  18 #include "wx/wxprec.h"
  19
  20 #ifdef __BORLANDC__
  21 #pragma hdrstop
  22 #endif
  23
  24 #ifndef WX_PRECOMP
  25 #include "wx/defs.h"
  26 #include "wx/window.h"
  27 #include "wx/frame.h"
  28 #include "wx/utils.h"
  29 #include "wx/menu.h"
  30 #endif
  31
  32 #if defined(__WIN95__)
  33
  34 #include "wx/msw/private.h"
  35 #include "wx/msw/winundef.h"
  36
  37 #include <string.h>
  38 #include "wx/taskbar.h"
  39
  40 #ifdef __GNUWIN32_OLD__
  41     #include "wx/msw/gnuwin32/extra.h"
  42 #endif
  43
  44 #ifdef __WXWINCE__
  45     #include <winreg.h>
  46     #include <shellapi.h>
  47 #endif
  48
  49 #include "wx/listimpl.cpp"
  50 WX_DEFINE_LIST(wxTaskBarIconList);
  51
  52 LRESULT APIENTRY _EXPORT
  53 wxTaskBarIconWindowProc( HWND hWnd, unsigned msg, UINT wParam, LONG lParam );
  54
  55 wxChar *wxTaskBarWindowClass = (wxChar*) wxT("wxTaskBarWindowClass");
  56
  57 wxTaskBarIconList wxTaskBarIcon::sm_taskBarIcons;
  58
  59 // initialized on demand
  60 UINT   gs_msgTaskbar = 0;
  61 UINT   gs_msgRestartTaskbar = 0;
  62
  63 #if WXWIN_COMPATIBILITY_2_4
  64 BEGIN_EVENT_TABLE(wxTaskBarIcon, wxEvtHandler)
  65     EVT_TASKBAR_MOVE         (wxTaskBarIcon::_OnMouseMove)
  66     EVT_TASKBAR_LEFT_DOWN    (wxTaskBarIcon::_OnLButtonDown)
  67     EVT_TASKBAR_LEFT_UP      (wxTaskBarIcon::_OnLButtonUp)
  68     EVT_TASKBAR_RIGHT_DOWN   (wxTaskBarIcon::_OnRButtonDown)
  69     EVT_TASKBAR_RIGHT_UP     (wxTaskBarIcon::_OnRButtonUp)
  70     EVT_TASKBAR_LEFT_DCLICK  (wxTaskBarIcon::_OnLButtonDClick)
  71     EVT_TASKBAR_RIGHT_DCLICK (wxTaskBarIcon::_OnRButtonDClick)
  72 END_EVENT_TABLE()
  73 #endif
  74
  75
  76 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
  77
  78 // ============================================================================
  79 // implementation
  80 // ============================================================================
  81
  82 // ----------------------------------------------------------------------------
  83 // NotifyIconData: wrapper around NOTIFYICONDATA
  84 // ----------------------------------------------------------------------------
  85
  86 struct NotifyIconData : public NOTIFYICONDATA
  87 {
  88     NotifyIconData(WXHWND hwnd)
  89     {
  90         memset(this, 0, sizeof(NOTIFYICONDATA));
  91         cbSize = sizeof(NOTIFYICONDATA);
  92         hWnd = (HWND) hwnd;
  93         uCallbackMessage = gs_msgTaskbar;
  94         uFlags = NIF_MESSAGE;
  95
  96         // we use the same id for all taskbar icons as we don't need it to
  97         // distinguish between them
  98         uID = 99;
  99     }
 100 };
 101
 102 // ----------------------------------------------------------------------------
 103 // wxTaskBarIcon
 104 // ----------------------------------------------------------------------------
 105
 106 wxTaskBarIcon::wxTaskBarIcon()
 107 {
 108     m_hWnd = 0;
 109     m_iconAdded = false;
 110
 111     AddObject(this);
 112
 113     if (RegisterWindowClass())
 114         m_hWnd = CreateTaskBarWindow();
 115 }
 116
 117 wxTaskBarIcon::~wxTaskBarIcon()
 118 {
 119     RemoveObject(this);
 120
 121     if (m_iconAdded)
 122     {
 123         RemoveIcon();
 124     }
 125
 126     if (m_hWnd)
 127     {
 128         ::DestroyWindow((HWND) m_hWnd);
 129         m_hWnd = 0;
 130     }
 131 }
 132
 133 // Operations
 134 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 135 {
 136     if (!IsOk())
 137         return false;
 138
 139     m_icon = icon;
 140     m_strTooltip = tooltip;
 141
 142     NotifyIconData notifyData(m_hWnd);
 143
 144     if (icon.Ok())
 145     {
 146         notifyData.uFlags |= NIF_ICON;
 147         notifyData.hIcon = GetHiconOf(icon);
 148     }
 149
 150     if ( !tooltip.empty() )
 151     {
 152         notifyData.uFlags |= NIF_TIP;
 153 //        lstrcpyn(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));
 154         wxStrncpy(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));
 155     }
 156
 157     bool ok = Shell_NotifyIcon(m_iconAdded ? NIM_MODIFY
 158                                            : NIM_ADD, &notifyData) != 0;
 159
 160     if ( !m_iconAdded && ok )
 161         m_iconAdded = true;
 162
 163     return ok;
 164 }
 165
 166 bool wxTaskBarIcon::RemoveIcon()
 167 {
 168     if (!m_iconAdded)
 169         return false;
 170
 171     m_iconAdded = false;
 172
 173     NotifyIconData notifyData(m_hWnd);
 174
 175     return Shell_NotifyIcon(NIM_DELETE, &notifyData) != 0;
 176 }
 177
 178 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 179 {
 180     static bool s_inPopup = false;
 181
 182     if (s_inPopup)
 183         return false;
 184
 185     s_inPopup = true;
 186
 187     wxWindow*   win;
 188     int         x, y;
 189     wxGetMousePosition(&x, &y);
 190
 191     // is wxFrame the best window type to use???
 192     win = new wxFrame(NULL, -1, wxEmptyString, wxPoint(x,y), wxSize(-1,-1), 0);
 193     win->PushEventHandler(this);
 194
 195     // Remove from record of top-level windows, or will confuse wxWindows
 196     // if we try to exit right now.
 197     wxTopLevelWindows.DeleteObject(win);
 198
 199     menu->UpdateUI();
 200
 201     // Work around a WIN32 bug
 202     ::SetForegroundWindow ((HWND) win->GetHWND ());
 203
 204     bool rval = win->PopupMenu(menu, 0, 0);
 205
 206     // Work around a WIN32 bug
 207     ::PostMessage ((HWND) win->GetHWND(),WM_NULL,0,0L);
 208
 209     win->PopEventHandler(false);
 210     win->Destroy();
 211     delete win;
 212
 213     s_inPopup = false;
 214
 215     return rval;
 216 }
 217
 218 #if WXWIN_COMPATIBILITY_2_4
 219 // Overridables
 220 void wxTaskBarIcon::OnMouseMove(wxEvent&)         {}
 221 void wxTaskBarIcon::OnLButtonDown(wxEvent&)       {}
 222 void wxTaskBarIcon::OnLButtonUp(wxEvent&)         {}
 223 void wxTaskBarIcon::OnRButtonDown(wxEvent&)       {}
 224 void wxTaskBarIcon::OnRButtonUp(wxEvent&)         {}
 225 void wxTaskBarIcon::OnLButtonDClick(wxEvent&)     {}
 226 void wxTaskBarIcon::OnRButtonDClick(wxEvent&)     {}
 227
 228 void wxTaskBarIcon::_OnMouseMove(wxEvent& e)      { OnMouseMove(e);     }
 229 void wxTaskBarIcon::_OnLButtonDown(wxEvent& e)    { OnLButtonDown(e);   }
 230 void wxTaskBarIcon::_OnLButtonUp(wxEvent& e)      { OnLButtonUp(e);     }
 231 void wxTaskBarIcon::_OnRButtonDown(wxEvent& e)    { OnRButtonDown(e);   }
 232 void wxTaskBarIcon::_OnRButtonUp(wxEvent& e)      { OnRButtonUp(e);     }
 233 void wxTaskBarIcon::_OnLButtonDClick(wxEvent& e)  { OnLButtonDClick(e); }
 234 void wxTaskBarIcon::_OnRButtonDClick(wxEvent& e)  { OnRButtonDClick(e); }
 235 #endif
 236
 237 wxTaskBarIcon* wxTaskBarIcon::FindObjectForHWND(WXHWND hWnd)
 238 {
 239     wxTaskBarIconList::compatibility_iterator node = sm_taskBarIcons.GetFirst();
 240     while (node)
 241     {
 242         wxTaskBarIcon *obj = node->GetData();
 243         if (obj->GetHWND() == hWnd)
 244             return obj;
 245         node = node->GetNext();
 246     }
 247     return NULL;
 248 }
 249
 250 void wxTaskBarIcon::AddObject(wxTaskBarIcon* obj)
 251 {
 252     sm_taskBarIcons.Append(obj);
 253 }
 254
 255 void wxTaskBarIcon::RemoveObject(wxTaskBarIcon* obj)
 256 {
 257     sm_taskBarIcons.DeleteObject(obj);
 258 }
 259
 260 bool wxTaskBarIcon::RegisterWindowClass()
 261 {
 262     static bool s_registered = false;
 263
 264     if ( s_registered )
 265         return true;
 266
 267     // Taskbar restart msg will be sent to us if the icon needs to be redrawn
 268     gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));
 269
 270     // Also register the taskbar message here
 271     gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));
 272
 273     // set up and register window class
 274     WNDCLASS wc;
 275     wc.style = CS_HREDRAW | CS_VREDRAW;
 276     wc.lpfnWndProc = (WNDPROC) wxTaskBarIconWindowProc;
 277     wc.cbClsExtra = 0;
 278     wc.cbWndExtra = 0;
 279     wc.hInstance = wxGetInstance();
 280     wc.hIcon = 0;
 281     wc.hCursor = 0;
 282     wc.hbrBackground = 0;
 283     wc.lpszMenuName = NULL;
 284     wc.lpszClassName = wxTaskBarWindowClass;
 285
 286     if ( !::RegisterClass(&wc) )
 287     {
 288         wxLogLastError(_T("RegisterClass(taskbar icon)"));
 289
 290         return false;
 291     }
 292
 293     s_registered = true;
 294
 295     return true;
 296 }
 297
 298 WXHWND wxTaskBarIcon::CreateTaskBarWindow()
 299 {
 300     HINSTANCE hInstance = GetModuleHandle(NULL);
 301
 302     HWND hWnd = CreateWindowEx (0, wxTaskBarWindowClass,
 303             wxT("wxTaskBarWindow"),
 304             WS_OVERLAPPED,
 305             0,
 306             0,
 307             10,
 308             10,
 309             NULL,
 310             (HMENU) 0,
 311             hInstance,
 312             NULL);
 313
 314     return (WXHWND) hWnd;
 315 }
 316
 317 // ----------------------------------------------------------------------------
 318 // wxTaskBarIcon window proc
 319 // ----------------------------------------------------------------------------
 320
 321 long wxTaskBarIcon::WindowProc(WXHWND hWnd,
 322                                unsigned int msg,
 323                                unsigned int wParam,
 324                                long lParam)
 325 {
 326     wxEventType eventType = 0;
 327
 328     if (msg == gs_msgRestartTaskbar)   // does the icon need to be redrawn?
 329     {
 330         m_iconAdded = false;
 331         SetIcon(m_icon, m_strTooltip);
 332     }
 333
 334     if (msg != gs_msgTaskbar)
 335         return DefWindowProc((HWND) hWnd, msg, wParam, lParam);
 336
 337     switch (lParam)
 338     {
 339         case WM_LBUTTONDOWN:
 340             eventType = wxEVT_TASKBAR_LEFT_DOWN;
 341             break;
 342
 343         case WM_LBUTTONUP:
 344             eventType = wxEVT_TASKBAR_LEFT_UP;
 345             break;
 346
 347         case WM_RBUTTONDOWN:
 348             eventType = wxEVT_TASKBAR_RIGHT_DOWN;
 349             break;
 350
 351         case WM_RBUTTONUP:
 352             eventType = wxEVT_TASKBAR_RIGHT_UP;
 353             break;
 354
 355         case WM_LBUTTONDBLCLK:
 356             eventType = wxEVT_TASKBAR_LEFT_DCLICK;
 357             break;
 358
 359         case WM_RBUTTONDBLCLK:
 360             eventType = wxEVT_TASKBAR_RIGHT_DCLICK;
 361             break;
 362
 363         case WM_MOUSEMOVE:
 364             eventType = wxEVT_TASKBAR_MOVE;
 365             break;
 366
 367         default:
 368             break;
 369     }
 370
 371     if (eventType)
 372     {
 373         wxTaskBarIconEvent event(eventType, this);
 374
 375         ProcessEvent(event);
 376     }
 377
 378     return 0;
 379 }
 380
 381 LRESULT APIENTRY _EXPORT
 382 wxTaskBarIconWindowProc(HWND hWnd, unsigned msg, UINT wParam, LONG lParam)
 383 {
 384     wxTaskBarIcon *obj = wxTaskBarIcon::FindObjectForHWND((WXHWND) hWnd);
 385     if (obj)
 386         return obj->WindowProc((WXHWND) hWnd, msg, wParam, lParam);
 387     else
 388         return DefWindowProc(hWnd, msg, wParam, lParam);
 389 }
 390
 391 #endif
 392     // __WIN95__