Eliminate a warning

[wxWidgets.git] / src / msw / taskbar.cpp

diff --git a/src/msw/taskbar.cpp b/src/msw/taskbar.cpp
index da4ab58764ea18e4179e26338b6674c6c4582295..cc52113434070e94a6a1e188e3c1e4f5dd76e1d3 100644 (file)
--- a/src/msw/taskbar.cpp
+++ b/src/msw/taskbar.cpp
@@ -1,168 +1,272 @@
 /////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////

-// File:        taskbar.cpp
+// File:        src/msw/taskbar.cpp

 // Purpose:     Implements wxTaskBarIcon class for manipulating icons on
 //              the Windows task bar.
 // Author:      Julian Smart
 // Purpose:     Implements wxTaskBarIcon class for manipulating icons on
 //              the Windows task bar.
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Vaclav Slavik

 // Created:     24/3/98
 // RCS-ID:      $Id$
 // Copyright:   (c)
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////
 
 // Created:     24/3/98
 // RCS-ID:      $Id$
 // Copyright:   (c)
 // 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"
+    #include "wx/window.h"
+    #include "wx/frame.h"
+    #include "wx/utils.h"
+    #include "wx/menu.h"

 #endif
 
 #endif
 

-#if defined(__WIN95__) && !defined(__TWIN32__)
-
-#include <windows.h>
-
-#include "wx/msw/winundef.h"
+#include "wx/msw/wrapshl.h"

 
 #include <string.h>
 #include "wx/taskbar.h"
 
 #include <string.h>
 #include "wx/taskbar.h"

-#include "wx/msw/private.h"
+#include "wx/dynlib.h"

 
 

-#ifndef __TWIN32__
-    #ifdef __GNUWIN32_OLD__
-        #include "wx/msw/gnuwin32/extra.h"
-    #endif
+#ifndef NIN_BALLOONTIMEOUT
+    #define NIN_BALLOONTIMEOUT      0x0404
+    #define NIN_BALLOONUSERCLICK    0x0405

 #endif
 
 #endif
 

-#ifdef __SALFORDC__
-    #include <shellapi.h>
+#ifndef NIM_SETVERSION
+    #define NIM_SETVERSION  0x00000004

 #endif
 
 #endif
 

-#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxTaskBarIconList);
-
-LRESULT APIENTRY _EXPORT wxTaskBarIconWindowProc( HWND hWnd, unsigned msg,
-                                     UINT wParam, LONG lParam );
-
-wxChar *wxTaskBarWindowClass = (wxChar*) wxT("wxTaskBarWindowClass");
+#ifndef NIF_INFO
+    #define NIF_INFO        0x00000010
+#endif

 
 

-wxTaskBarIconList wxTaskBarIcon::sm_taskBarIcons;
-bool   wxTaskBarIcon::sm_registeredClass = FALSE;
-UINT   wxTaskBarIcon::sm_taskbarMsg = 0;

 
 

-#if WXWIN_COMPATIBILITY_2_4
-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()
-#endif
+// initialized on demand
+static UINT gs_msgTaskbar = 0;
+static UINT gs_msgRestartTaskbar = 0;

 
 
 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
 
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
 

+// ============================================================================
+// 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 *);

 
 

-    AddObject(this);
+    static Shell_NotifyIcon_t s_pfnShell_NotifyIcon = NULL;
+    static bool s_initialized = false;
+    if ( !s_initialized )
+    {
+        s_initialized = true;

 
 

-    if (RegisterWindowClass())
-        m_hWnd = CreateTaskBarWindow();
+        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
+    }
+
+    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);
+        }

     }
 
     }
 

-    if (m_hWnd)
+private:
+    wxTaskBarIcon *m_icon;
+};
+
+
+// ----------------------------------------------------------------------------
+// NotifyIconData: wrapper around NOTIFYICONDATA
+// ----------------------------------------------------------------------------
+
+struct NotifyIconData : public NOTIFYICONDATA
+{
+    NotifyIconData(WXHWND hwnd)

     {
     {

-        ::DestroyWindow((HWND) m_hWnd);
-        m_hWnd = 0;
+        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;
+    }
+};
+
+// ----------------------------------------------------------------------------
+// wxTaskBarIcon
+// ----------------------------------------------------------------------------
+
+wxTaskBarIcon::wxTaskBarIcon()
+{
+    m_win = NULL;
+    m_iconAdded = false;
+    RegisterWindowMessages();
+}
+
+wxTaskBarIcon::~wxTaskBarIcon()
+{
+    if ( m_iconAdded )
+        RemoveIcon();
+
+    if ( m_win )
+    {
+        // 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);
+    }
+
+    m_icon = icon;
+    m_strTooltip = tooltip;

 
 

-    NOTIFYICONDATA notifyData;
+    NotifyIconData notifyData(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 ;

     if (icon.Ok())
     {
         notifyData.uFlags |= NIF_ICON;
     if (icon.Ok())
     {
         notifyData.uFlags |= NIF_ICON;

-        notifyData.hIcon = (HICON) icon.GetHICON();
+        notifyData.hIcon = GetHiconOf(icon);

     }
 
     }
 

-    if (((const wxChar*) tooltip != NULL) && (tooltip != wxT("")))
+    // 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, WXSTRINGCAST 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)
+{
+    wxCHECK_MSG( m_iconAdded, false,
+                    _T("can't be used before the icon is created") );
+
+    const HWND hwnd = GetHwndOf(m_win);
+
+    // 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 */;
+
+    wxShellNotifyIcon(NIM_SETVERSION, &notifyData);
+
+
+    // 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));
+
+    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;
+
+    return wxShellNotifyIcon(NIM_MODIFY, &notifyData) != 0;
+}
+
+#endif // wxUSE_TASKBARICON_BALLOONS
+
+bool wxTaskBarIcon::RemoveIcon()

 {
     if (!m_iconAdded)
         return false;
 
 {
     if (!m_iconAdded)
         return false;
 

-    NOTIFYICONDATA notifyData;
-
-    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;
 
     m_iconAdded = false;
 

-    return (Shell_NotifyIcon(NIM_DELETE, & notifyData) != 0);
+    NotifyIconData notifyData(GetHwndOf(m_win));
+
+    return wxShellNotifyIcon(NIM_DELETE, &notifyData) != 0;

 }
 
 }
 

-bool wxTaskBarIcon::PopupMenu(wxMenu *menu) //, int x, int y);
+#if wxUSE_MENUS
+bool wxTaskBarIcon::PopupMenu(wxMenu *menu)

 {
 {

-    // OK, so I know this isn't thread-friendly, but
-    // what to do? We need this check.
+    wxASSERT_MSG( m_win != NULL, _T("taskbar icon not initialized") );

 
     static bool s_inPopup = false;
 
 
     static bool s_inPopup = false;
 


@@ -171,140 +275,68 @@ bool wxTaskBarIcon::PopupMenu(wxMenu *menu) //, int x, int y);
 
     s_inPopup = true;
 
 
     s_inPopup = true;
 

-    bool        rval = false;
-    wxWindow*   win;

     int         x, y;
     wxGetMousePosition(&x, &y);
 
     int         x, y;
     wxGetMousePosition(&x, &y);
 

-    // is wxFrame the best window type to use???
-    win = new wxFrame(NULL, -1, wxEmptyString, wxPoint(x,y), wxSize(-1,-1), 0);
-    win->PushEventHandler(this);
+    m_win->Move(x, y);

 
 

-    // Remove from record of top-level windows, or will confuse wxWindows
-    // if we try to exit right now.
-    wxTopLevelWindows.DeleteObject(win);
+    m_win->PushEventHandler(this);

 
     menu->UpdateUI();
 
 
     menu->UpdateUI();
 

-    // Work around a WIN32 bug
-    ::SetForegroundWindow ((HWND) win->GetHWND ());
+    // 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));

 
 

-    rval = win->PopupMenu(menu, 0, 0);
+    bool rval = m_win->PopupMenu(menu, 0, 0);

 
 

-    // Work around a WIN32 bug
-    ::PostMessage ((HWND) win->GetHWND(),WM_NULL,0,0L);
+    ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L);

 
 

-    win->PopEventHandler(false);
-    win->Destroy();
-    delete win;
+    m_win->PopEventHandler(false);

 
     s_inPopup = false;
 
     return rval;
 }
 
     s_inPopup = false;
 
     return rval;
 }

+#endif // wxUSE_MENUS

 
 

-#if WXWIN_COMPATIBILITY_2_4
-// Overridables
-void wxTaskBarIcon::OnMouseMove(wxEvent&)         {}
-void wxTaskBarIcon::OnLButtonDown(wxEvent&)       {}
-void wxTaskBarIcon::OnLButtonUp(wxEvent&)         {}
-void wxTaskBarIcon::OnRButtonDown(wxEvent&)       {}
-void wxTaskBarIcon::OnRButtonUp(wxEvent&)         {}
-void wxTaskBarIcon::OnLButtonDClick(wxEvent&)     {}
-void wxTaskBarIcon::OnRButtonDClick(wxEvent&)     {}
-
-void wxTaskBarIcon::_OnMouseMove(wxEvent& e)      { OnMouseMove(e);     }
-void wxTaskBarIcon::_OnLButtonDown(wxEvent& e)    { OnLButtonDown(e);   }
-void wxTaskBarIcon::_OnLButtonUp(wxEvent& e)      { OnLButtonUp(e);     }
-void wxTaskBarIcon::_OnRButtonDown(wxEvent& e)    { OnRButtonDown(e);   }
-void wxTaskBarIcon::_OnRButtonUp(wxEvent& e)      { OnRButtonUp(e);     }
-void wxTaskBarIcon::_OnLButtonDClick(wxEvent& e)  { OnLButtonDClick(e); }
-void wxTaskBarIcon::_OnRButtonDClick(wxEvent& e)  { OnRButtonDClick(e); }
-#endif
-
-wxTaskBarIcon* wxTaskBarIcon::FindObjectForHWND(WXHWND hWnd)
+void wxTaskBarIcon::RegisterWindowMessages()

 {
 {

-    wxTaskBarIconList::Node *node = sm_taskBarIcons.GetFirst();
-    while (node)
-    {
-        wxTaskBarIcon *obj = node->GetData();
-        if (obj->GetHWND() == hWnd)
-            return obj;
-        node = node->GetNext();
-    }
-    return NULL;
-}
+    static bool s_registered = false;

 
 

-void wxTaskBarIcon::AddObject(wxTaskBarIcon* obj)
-{
-    sm_taskBarIcons.Append(obj);
-}
+    if ( !s_registered )
+    {
+        // Taskbar restart msg will be sent to us if the icon needs to be redrawn
+        gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));

 
 

-void wxTaskBarIcon::RemoveObject(wxTaskBarIcon* obj)
-{
-    sm_taskBarIcons.DeleteObject(obj);
-}
+        // Also register the taskbar message here
+        gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));

 
 

-bool wxTaskBarIcon::RegisterWindowClass()
-{
-    if (sm_registeredClass)
-        return true;
-
-    // Also register the taskbar message here
-    sm_taskbarMsg = ::RegisterWindowMessage(wxT("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) );
+        s_registered = true;
+    }

 }
 
 }
 

-WXHWND wxTaskBarIcon::CreateTaskBarWindow()
-{
-    HINSTANCE hInstance = GetModuleHandle(NULL);
-
-    HWND hWnd = CreateWindowEx (0, wxTaskBarWindowClass,
-            wxT("wxTaskBarWindow"),
-            WS_OVERLAPPED,
-            0,
-            0,
-            10,
-            10,
-            NULL,
-            (HMENU) 0,
-            hInstance,
-            NULL);
-
-    return (WXHWND) hWnd;
-}
+// ----------------------------------------------------------------------------
+// wxTaskBarIcon window proc
+// ----------------------------------------------------------------------------

 
 

-long wxTaskBarIcon::WindowProc( WXHWND hWnd, unsigned int msg, unsigned int wParam, long lParam )
+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:
             eventType = wxEVT_TASKBAR_LEFT_DOWN;
     {
         case WM_LBUTTONDOWN:
             eventType = wxEVT_TASKBAR_LEFT_DOWN;


@@ -334,27 +366,24 @@ long wxTaskBarIcon::WindowProc( WXHWND hWnd, unsigned int msg, unsigned int wPar
             eventType = wxEVT_TASKBAR_MOVE;
             break;
 
             eventType = wxEVT_TASKBAR_MOVE;
             break;
 

-        default:
+        case NIN_BALLOONTIMEOUT:
+            eventType = wxEVT_TASKBAR_BALLOON_TIMEOUT;

             break;
             break;

-        }

 
 

-    if (eventType) {
+        case NIN_BALLOONUSERCLICK:
+            eventType = wxEVT_TASKBAR_BALLOON_CLICK;
+            break;
+    }
+
+    if ( eventType )
+    {

         wxTaskBarIconEvent event(eventType, this);
 
         ProcessEvent(event);
     }
         wxTaskBarIconEvent event(eventType, this);
 
         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__