]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/taskbar.cpp
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
use (new) safer GetTraitsIfExists() in wxMutexGuiEnter/Leave() to avoid crashing...
[wxWidgets.git] / src / msw / taskbar.cpp
diff --git a/src/msw/taskbar.cpp b/src/msw/taskbar.cpp
index 9c2d0342604232903f6d268cc5b49074a77ffb2a..cc52113434070e94a6a1e188e3c1e4f5dd76e1d3 100644 (file)
--- a/src/msw/taskbar.cpp
+++ b/src/msw/taskbar.cpp
@@ -1,313 +1,389 @@
 /////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////
-// File:        taskbar.cpp
-// Purpose:        Implements wxTaskBarIcon class for manipulating icons on
+// File:        src/msw/taskbar.cpp
+// Purpose:     Implements wxTaskBarIcon class for manipulating icons on
 //              the Windows task bar.
 // Author:      Julian Smart
 //              the Windows task bar.
 // Author:      Julian Smart
-// Modified by:
+// Modified by: Vaclav Slavik
 // Created:     24/3/98
 // RCS-ID:      $Id$
 // Copyright:   (c)
 // Created:     24/3/98
 // RCS-ID:      $Id$
 // Copyright:   (c)
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "taskbar.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #endif
 
+#if wxUSE_TASKBARICON
+
 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP
-#include "wx/defs.h"
+    #include "wx/window.h"
+    #include "wx/frame.h"
+    #include "wx/utils.h"
+    #include "wx/menu.h"
 #endif
 
 #endif
 
-#ifdef __WIN95__
+#include "wx/msw/wrapshl.h"
 
 
-#include <wx/msw/taskbar.h>
 #include <string.h>
 #include <string.h>
-#include <windows.h>
-#include <wx/msw/private.h>
+#include "wx/taskbar.h"
+#include "wx/dynlib.h"
 
 
-#ifdef __GNUWIN32__
-#include <wx/msw/gnuwin32/extra.h>
+#ifndef NIN_BALLOONTIMEOUT
+    #define NIN_BALLOONTIMEOUT      0x0404
+    #define NIN_BALLOONUSERCLICK    0x0405
 #endif
 
 #endif
 
-LRESULT APIENTRY _EXPORT wxTaskBarIconWindowProc( HWND hWnd, unsigned msg,
-                                    UINT wParam, LONG lParam );
-
-char *wxTaskBarWindowClass = "wxTaskBarWindowClass";
+#ifndef NIM_SETVERSION
+    #define NIM_SETVERSION  0x00000004
+#endif
 
 
-wxList wxTaskBarIcon::sm_taskBarIcons;
-bool   wxTaskBarIcon::sm_registeredClass = FALSE;
-UINT   wxTaskBarIcon::sm_taskbarMsg = 0;
+#ifndef NIF_INFO
+    #define NIF_INFO        0x00000010
+#endif
 
 
 
 
-#if !USE_SHARED_LIBRARY
-BEGIN_EVENT_TABLE(wxTaskBarIcon, wxEvtHandler)
-    EVT_TASKBAR_MOVE         (wxTaskBarIcon::OnMouseMove)
-    EVT_TASKBAR_LEFT_DOWN    (wxTaskBarIcon::OnLButtonDown)
-    EVT_TASKBAR_LEFT_UP      (wxTaskBarIcon::OnLButtonUp)
-    EVT_TASKBAR_RIGHT_DOWN   (wxTaskBarIcon::OnRButtonDown)
-    EVT_TASKBAR_RIGHT_UP     (wxTaskBarIcon::OnRButtonUp)
-    EVT_TASKBAR_LEFT_DCLICK  (wxTaskBarIcon::OnLButtonDClick)
-    EVT_TASKBAR_RIGHT_DCLICK (wxTaskBarIcon::OnRButtonDClick)
-END_EVENT_TABLE()
+// initialized on demand
+static UINT gs_msgTaskbar = 0;
+static UINT gs_msgRestartTaskbar = 0;
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
-#endif
 
 
+// ============================================================================
+// implementation
+// ============================================================================
 
 
-wxTaskBarIcon::wxTaskBarIcon(void)
+// wrapper around Shell_NotifyIcon(): this function is not present in Win95
+// shell32.dll so load it dynamically to allow programs using wxTaskBarIcon to
+// start under this OS
+static BOOL wxShellNotifyIcon(DWORD dwMessage, NOTIFYICONDATA *pData)
 {
 {
-    m_hWnd = 0;
-    m_iconAdded = FALSE;
+#if wxUSE_DYNLIB_CLASS
+    typedef BOOL (WINAPI *Shell_NotifyIcon_t)(DWORD, NOTIFYICONDATA *);
+
+    static Shell_NotifyIcon_t s_pfnShell_NotifyIcon = NULL;
+    static bool s_initialized = false;
+    if ( !s_initialized )
+    {
+        s_initialized = true;
 
 
-    AddObject(this);
+        wxLogNull noLog;
+        wxDynamicLibrary dllShell("shell32.dll");
+        if ( dllShell.IsLoaded() )
+        {
+            wxDL_INIT_FUNC_AW(s_pfn, Shell_NotifyIcon, dllShell);
+        }
+
+        // NB: it's ok to destroy dllShell here, we link to shell32.dll
+        //     implicitly so it won't be unloaded
+    }
 
 
-    if (RegisterWindowClass())
-        m_hWnd = CreateTaskBarWindow();
+    return s_pfnShell_NotifyIcon ? (*s_pfnShell_NotifyIcon)(dwMessage, pData)
+                                 : FALSE;
+#else // !wxUSE_DYNLIB_CLASS
+    return Shell_NotifyIcon(dwMessage, pData);
+#endif // wxUSE_DYNLIB_CLASS/!wxUSE_DYNLIB_CLASS
 }
 
 }
 
-wxTaskBarIcon::~wxTaskBarIcon(void)
+// ----------------------------------------------------------------------------
+// wxTaskBarIconWindow: helper window
+// ----------------------------------------------------------------------------
+
+// NB: this class serves two purposes:
+//     1. win32 needs a HWND associated with taskbar icon, this provides it
+//     2. we need wxTopLevelWindow so that the app doesn't exit when
+//        last frame is closed but there still is a taskbar icon
+class wxTaskBarIconWindow : public wxFrame
 {
 {
-    RemoveObject(this);
+public:
+    wxTaskBarIconWindow(wxTaskBarIcon *icon)
+        : wxFrame(NULL, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0),
+          m_icon(icon)
+    {
+    }
 
 
-    if (m_iconAdded)
+    WXLRESULT MSWWindowProc(WXUINT msg,
+                            WXWPARAM wParam, WXLPARAM lParam)
     {
     {
-        RemoveIcon();
+        if (msg == gs_msgRestartTaskbar || msg == gs_msgTaskbar)
+        {
+            return m_icon->WindowProc(msg, wParam, lParam);
+        }
+        else
+        {
+            return wxFrame::MSWWindowProc(msg, wParam, lParam);
+        }
+    }
+
+private:
+    wxTaskBarIcon *m_icon;
+};
+
+
+// ----------------------------------------------------------------------------
+// NotifyIconData: wrapper around NOTIFYICONDATA
+// ----------------------------------------------------------------------------
+
+struct NotifyIconData : public NOTIFYICONDATA
+{
+    NotifyIconData(WXHWND hwnd)
+    {
+        memset(this, 0, sizeof(NOTIFYICONDATA));
+        cbSize = sizeof(NOTIFYICONDATA);
+        hWnd = (HWND) hwnd;
+        uCallbackMessage = gs_msgTaskbar;
+        uFlags = NIF_MESSAGE;
+
+        // we use the same id for all taskbar icons as we don't need it to
+        // distinguish between them
+        uID = 99;
     }
     }
+};
 
 
-    if (m_hWnd)
+// ----------------------------------------------------------------------------
+// wxTaskBarIcon
+// ----------------------------------------------------------------------------
+
+wxTaskBarIcon::wxTaskBarIcon()
+{
+    m_win = NULL;
+    m_iconAdded = false;
+    RegisterWindowMessages();
+}
+
+wxTaskBarIcon::~wxTaskBarIcon()
+{
+    if ( m_iconAdded )
+        RemoveIcon();
+
+    if ( m_win )
     {
     {
-        ::DestroyWindow((HWND) m_hWnd);
-        m_hWnd = 0;
+        // we must use delete and not Destroy() here because the latter will
+        // only schedule the window to be deleted during the next idle event
+        // processing but we may not get any idle events if there are no other
+        // windows left in the program
+        delete m_win;
     }
 }
 
 // Operations
 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 {
     }
 }
 
 // Operations
 bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
 {
-    if (!IsOK())
-        return FALSE;
+    // NB: we have to create the window lazily because of backward compatibility,
+    //     old applications may create a wxTaskBarIcon instance before wxApp
+    //     is initialized (as samples/taskbar used to do)
+    if (!m_win)
+    {
+        m_win = new wxTaskBarIconWindow(this);
+    }
 
 
-    NOTIFYICONDATA notifyData;
+    m_icon = icon;
+    m_strTooltip = tooltip;
 
 
-    memset(&notifyData, 0, sizeof(notifyData));
-       notifyData.cbSize = sizeof(notifyData);
-       notifyData.hWnd = (HWND) m_hWnd;
-       notifyData.uCallbackMessage = sm_taskbarMsg;
-       notifyData.uFlags = NIF_MESSAGE ;
-       if (icon.Ok())
+    NotifyIconData notifyData(GetHwndOf(m_win));
+
+    if (icon.Ok())
     {
     {
-               notifyData.uFlags |= NIF_ICON;
-           notifyData.hIcon = (HICON) icon.GetHICON();
+        notifyData.uFlags |= NIF_ICON;
+        notifyData.hIcon = GetHiconOf(icon);
     }
 
     }
 
-    if (((const char*) tooltip != NULL) && (tooltip != ""))
+    // set NIF_TIP even for an empty tooltip: otherwise it would be impossible
+    // to remove an existing tooltip using this function
+    notifyData.uFlags |= NIF_TIP;
+    if ( !tooltip.empty() )
     {
     {
-        notifyData.uFlags |= NIF_TIP ;
-               lstrcpyn(notifyData.szTip, (char*) (const char*) tooltip, sizeof(notifyData.szTip));
+        wxStrncpy(notifyData.szTip, tooltip.wx_str(), WXSIZEOF(notifyData.szTip));
     }
 
     }
 
-    notifyData.uID = 99;
+    bool ok = wxShellNotifyIcon(m_iconAdded ? NIM_MODIFY
+                                            : NIM_ADD, &notifyData) != 0;
 
 
-    if (m_iconAdded)
-        return (Shell_NotifyIcon(NIM_MODIFY, & notifyData) != 0);
-    else
-    {
-        m_iconAdded = (Shell_NotifyIcon(NIM_ADD, & notifyData) != 0);
-        return m_iconAdded;
-    }
+    if ( !m_iconAdded && ok )
+        m_iconAdded = true;
+
+    return ok;
 }
 
 }
 
-bool wxTaskBarIcon::RemoveIcon(void)
+#if wxUSE_TASKBARICON_BALLOONS
+
+bool
+wxTaskBarIcon::ShowBalloon(const wxString& title,
+                           const wxString& text,
+                           unsigned msec,
+                           int flags)
 {
 {
-    if (!m_iconAdded)
-        return FALSE;
+    wxCHECK_MSG( m_iconAdded, false,
+                    _T("can't be used before the icon is created") );
 
 
-    NOTIFYICONDATA notifyData;
+    const HWND hwnd = GetHwndOf(m_win);
 
 
-    memset(&notifyData, 0, sizeof(notifyData));
-       notifyData.cbSize = sizeof(notifyData);
-       notifyData.hWnd = (HWND) m_hWnd;
-       notifyData.uCallbackMessage = sm_taskbarMsg;
-       notifyData.uFlags = NIF_MESSAGE;
-       notifyData.hIcon = 0 ; // hIcon;
-    notifyData.uID = 99;
-    m_iconAdded = FALSE;
+    // we need to enable version 5.0 behaviour to receive notifications about
+    // the balloon disappearance
+    NotifyIconData notifyData(hwnd);
+    notifyData.uFlags = 0;
+    notifyData.uVersion = 3 /* NOTIFYICON_VERSION for Windows XP */;
 
 
-    return (Shell_NotifyIcon(NIM_DELETE, & notifyData) != 0);
-}
+    wxShellNotifyIcon(NIM_SETVERSION, &notifyData);
 
 
-// Overridables
-void wxTaskBarIcon::OnMouseMove(wxEvent&)
-{
-}
 
 
-void wxTaskBarIcon::OnLButtonDown(wxEvent&)
-{
-}
+    // do show the balloon now
+    notifyData = NotifyIconData(hwnd);
+    notifyData.uFlags |= NIF_INFO;
+    notifyData.uTimeout = msec;
+    wxStrncpy(notifyData.szInfo, text.wx_str(), WXSIZEOF(notifyData.szInfo));
+    wxStrncpy(notifyData.szInfoTitle, title.wx_str(),
+                WXSIZEOF(notifyData.szInfoTitle));
 
 
-void wxTaskBarIcon::OnLButtonUp(wxEvent&)
-{
-}
+    if ( flags & wxICON_INFORMATION )
+        notifyData.dwInfoFlags |= NIIF_INFO;
+    else if ( flags & wxICON_WARNING )
+        notifyData.dwInfoFlags |= NIIF_WARNING;
+    else if ( flags & wxICON_ERROR )
+        notifyData.dwInfoFlags |= NIIF_ERROR;
 
 
-void wxTaskBarIcon::OnRButtonDown(wxEvent&)
-{
+    return wxShellNotifyIcon(NIM_MODIFY, &notifyData) != 0;
 }
 
 }
 
-void wxTaskBarIcon::OnRButtonUp(wxEvent&)
-{
-}
+#endif // wxUSE_TASKBARICON_BALLOONS
 
 
-void wxTaskBarIcon::OnLButtonDClick(wxEvent&)
+bool wxTaskBarIcon::RemoveIcon()
 {
 {
-}
+    if (!m_iconAdded)
+        return false;
 
 
-void wxTaskBarIcon::OnRButtonDClick(wxEvent&)
-{
-}
+    m_iconAdded = false;
 
 
-wxTaskBarIcon* wxTaskBarIcon::FindObjectForHWND(WXHWND hWnd)
-{
-    wxNode*node = sm_taskBarIcons.First();
-    while (node)
-    {
-        wxTaskBarIcon* obj = (wxTaskBarIcon*) node->Data();
-        if (obj->GetHWND() == hWnd)
-            return obj;
-        node = node->Next();
-    }
-    return NULL;
-}
+    NotifyIconData notifyData(GetHwndOf(m_win));
 
 
-void wxTaskBarIcon::AddObject(wxTaskBarIcon* obj)
-{
-    sm_taskBarIcons.Append(obj);
+    return wxShellNotifyIcon(NIM_DELETE, &notifyData) != 0;
 }
 
 }
 
-void wxTaskBarIcon::RemoveObject(wxTaskBarIcon* obj)
+#if wxUSE_MENUS
+bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 {
 {
-    sm_taskBarIcons.DeleteObject(obj);
-}
+    wxASSERT_MSG( m_win != NULL, _T("taskbar icon not initialized") );
 
 
-bool wxTaskBarIcon::RegisterWindowClass()
-{
-    if (sm_registeredClass)
-        return TRUE;
-
-    // Also register the taskbar message here
-    sm_taskbarMsg = ::RegisterWindowMessage("wxTaskBarIconMessage");
-
-    WNDCLASS   wc;
-    bool       rc;
-
-    HINSTANCE hInstance = GetModuleHandle(NULL);
-
-    /*
-     * set up and register window class
-     */
-    wc.style = CS_HREDRAW | CS_VREDRAW;
-    wc.lpfnWndProc = (WNDPROC) wxTaskBarIconWindowProc;
-    wc.cbClsExtra = 0;
-    wc.cbWndExtra = 0;
-    wc.hInstance = hInstance;
-    wc.hIcon = 0;
-    wc.hCursor = 0;
-    wc.hbrBackground = 0;
-    wc.lpszMenuName = NULL;
-    wc.lpszClassName = wxTaskBarWindowClass ;
-    rc = (::RegisterClass( &wc ) != 0);
-
-    sm_registeredClass = (rc != 0);
-
-    return( (rc != 0) );
+    static bool s_inPopup = false;
+
+    if (s_inPopup)
+        return false;
+
+    s_inPopup = true;
+
+    int         x, y;
+    wxGetMousePosition(&x, &y);
+
+    m_win->Move(x, y);
+
+    m_win->PushEventHandler(this);
+
+    menu->UpdateUI();
+
+    // the SetForegroundWindow() and PostMessage() calls are needed to work
+    // around Win32 bug with the popup menus shown for the notifications as
+    // documented at http://support.microsoft.com/kb/q135788/
+    ::SetForegroundWindow(GetHwndOf(m_win));
+
+    bool rval = m_win->PopupMenu(menu, 0, 0);
+
+    ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L);
+
+    m_win->PopEventHandler(false);
+
+    s_inPopup = false;
+
+    return rval;
 }
 }
+#endif // wxUSE_MENUS
 
 
-WXHWND wxTaskBarIcon::CreateTaskBarWindow()
+void wxTaskBarIcon::RegisterWindowMessages()
 {
 {
-    HINSTANCE hInstance = GetModuleHandle(NULL);
-
-    HWND hWnd = CreateWindowEx (0, wxTaskBarWindowClass,
-            "wxTaskBarWindow",
-            WS_OVERLAPPED,
-            0,
-            0,
-            10,
-            10,
-            NULL,
-            (HMENU) 0,
-            hInstance,
-            NULL);
-
-    return (WXHWND) hWnd;
+    static bool s_registered = false;
+
+    if ( !s_registered )
+    {
+        // Taskbar restart msg will be sent to us if the icon needs to be redrawn
+        gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));
+
+        // Also register the taskbar message here
+        gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));
+
+        s_registered = true;
+    }
 }
 
 }
 
-long wxTaskBarIcon::WindowProc( WXHWND hWnd, unsigned int msg, unsigned int wParam, long lParam )
+// ----------------------------------------------------------------------------
+// wxTaskBarIcon window proc
+// ----------------------------------------------------------------------------
+
+long wxTaskBarIcon::WindowProc(unsigned int msg,
+                               unsigned int WXUNUSED(wParam),
+                               long lParam)
 {
 {
-    wxEventType eventType = 0;
+    if ( msg == gs_msgRestartTaskbar )   // does the icon need to be redrawn?
+    {
+        m_iconAdded = false;
+        SetIcon(m_icon, m_strTooltip);
+        return 0;
+    }
 
 
-    if (msg != sm_taskbarMsg)
-        return DefWindowProc((HWND) hWnd, msg, wParam, lParam);
+    // this function should only be called for gs_msg(Restart)Taskbar messages
+    wxASSERT( msg == gs_msgTaskbar );
 
 
-    switch (lParam)
+    wxEventType eventType = 0;
+    switch ( lParam )
     {
     {
-       case WM_LBUTTONDOWN:
+        case WM_LBUTTONDOWN:
             eventType = wxEVT_TASKBAR_LEFT_DOWN;
             break;
 
             eventType = wxEVT_TASKBAR_LEFT_DOWN;
             break;
 
-       case WM_LBUTTONUP:
+        case WM_LBUTTONUP:
             eventType = wxEVT_TASKBAR_LEFT_UP;
             break;
 
             eventType = wxEVT_TASKBAR_LEFT_UP;
             break;
 
-       case WM_RBUTTONDOWN:
+        case WM_RBUTTONDOWN:
             eventType = wxEVT_TASKBAR_RIGHT_DOWN;
             break;
 
             eventType = wxEVT_TASKBAR_RIGHT_DOWN;
             break;
 
-       case WM_RBUTTONUP:
+        case WM_RBUTTONUP:
             eventType = wxEVT_TASKBAR_RIGHT_UP;
             break;
 
             eventType = wxEVT_TASKBAR_RIGHT_UP;
             break;
 
-       case WM_LBUTTONDBLCLK:
+        case WM_LBUTTONDBLCLK:
             eventType = wxEVT_TASKBAR_LEFT_DCLICK;
             break;
 
             eventType = wxEVT_TASKBAR_LEFT_DCLICK;
             break;
 
-       case WM_RBUTTONDBLCLK:
+        case WM_RBUTTONDBLCLK:
             eventType = wxEVT_TASKBAR_RIGHT_DCLICK;
             break;
 
             eventType = wxEVT_TASKBAR_RIGHT_DCLICK;
             break;
 
-       case WM_MOUSEMOVE:
+        case WM_MOUSEMOVE:
             eventType = wxEVT_TASKBAR_MOVE;
             break;
 
             eventType = wxEVT_TASKBAR_MOVE;
             break;
 
-       default:
+        case NIN_BALLOONTIMEOUT:
+            eventType = wxEVT_TASKBAR_BALLOON_TIMEOUT;
             break;
             break;
-       }
 
 
-    if (eventType) {
-        wxEvent event;
-        event.SetEventType(eventType);
-        event.SetEventObject(this);
+        case NIN_BALLOONUSERCLICK:
+            eventType = wxEVT_TASKBAR_BALLOON_CLICK;
+            break;
+    }
+
+    if ( eventType )
+    {
+        wxTaskBarIconEvent event(eventType, this);
 
         ProcessEvent(event);
     }
 
         ProcessEvent(event);
     }
+
     return 0;
 }
 
     return 0;
 }
 
-LRESULT APIENTRY _EXPORT wxTaskBarIconWindowProc( HWND hWnd, unsigned msg,
-                                    UINT wParam, LONG lParam )
-{
-    wxTaskBarIcon* obj = wxTaskBarIcon::FindObjectForHWND((WXHWND) hWnd);
-    if (obj)
-        return obj->WindowProc((WXHWND) hWnd, msg, wParam, lParam);
-    else
-        return DefWindowProc(hWnd, msg, wParam, lParam);
-}
+#endif // wxUSE_TASKBARICON
 
 
-#endif
-    // __WIN95__
wxWidgets (Impactor)