added vendor display name (for consistency with app display name &c) (patch 1831303)

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

diff --git a/src/msw/taskbar.cpp b/src/msw/taskbar.cpp
index 23e002515465976cd64f8c0b5ec7a50e621cf2d6..52e05fee6941fb24159fe8b1a2d4ad0033bd1ad0 100644 (file)
--- a/src/msw/taskbar.cpp
+++ b/src/msw/taskbar.cpp
@@ -1,83 +1,114 @@
 /////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////

-// 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
 /////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#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__)
-
-#include "wx/msw/private.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/dynlib.h"

 
 

-#ifdef __GNUWIN32_OLD__
-    #include "wx/msw/gnuwin32/extra.h"
-#endif
+// initialized on demand
+static UINT gs_msgTaskbar = 0;
+static UINT gs_msgRestartTaskbar = 0;

 
 

-#ifdef __WXWINCE__
-    #include <winreg.h>
-    #include <shellapi.h>
-#endif

 
 

-#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxTaskBarIconList);
+IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)

 
 

-LRESULT APIENTRY _EXPORT
-wxTaskBarIconWindowProc( HWND hWnd, unsigned msg, UINT wParam, LONG lParam );
+// ============================================================================
+// implementation
+// ============================================================================

 
 

-wxChar *wxTaskBarWindowClass = (wxChar*) wxT("wxTaskBarWindowClass");
+// 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)
+{
+#if wxUSE_DYNLIB_CLASS
+    typedef BOOL (WINAPI *Shell_NotifyIcon_t)(DWORD, NOTIFYICONDATA *);

 
 

-wxTaskBarIconList wxTaskBarIcon::sm_taskBarIcons;
+    static Shell_NotifyIcon_t s_pfnShell_NotifyIcon = NULL;
+    static bool s_initialized = false;
+    if ( !s_initialized )
+    {
+        s_initialized = true;

 
 

-// initialized on demand
-UINT   gs_msgTaskbar = 0;
-UINT   gs_msgRestartTaskbar = 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
+        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
+    }

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler)
+    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
+}
+
+// ----------------------------------------------------------------------------
+// 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
+{
+public:
+    wxTaskBarIconWindow(wxTaskBarIcon *icon)
+        : wxFrame(NULL, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0),
+          m_icon(icon)
+    {
+    }
+
+    WXLRESULT MSWWindowProc(WXUINT msg,
+                            WXWPARAM wParam, WXLPARAM lParam)
+    {
+        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;
+};

 
 

-// ============================================================================
-// implementation
-// ============================================================================

 
 // ----------------------------------------------------------------------------
 // NotifyIconData: wrapper around NOTIFYICONDATA
 
 // ----------------------------------------------------------------------------
 // NotifyIconData: wrapper around NOTIFYICONDATA


@@ -105,41 +136,35 @@ struct NotifyIconData : public NOTIFYICONDATA
 
 wxTaskBarIcon::wxTaskBarIcon()
 {
 
 wxTaskBarIcon::wxTaskBarIcon()
 {

-    m_hWnd = 0;
+    m_win = NULL;

     m_iconAdded = false;
     m_iconAdded = false;

-
-    AddObject(this);
-
-    if (RegisterWindowClass())
-        m_hWnd = CreateTaskBarWindow();
+    RegisterWindowMessages();

 }
 
 wxTaskBarIcon::~wxTaskBarIcon()
 {
 }
 
 wxTaskBarIcon::~wxTaskBarIcon()
 {

-    RemoveObject(this);
-

     if (m_iconAdded)
     if (m_iconAdded)

-    {

         RemoveIcon();
         RemoveIcon();

-    }

 
 

-    if (m_hWnd)
-    {
-        ::DestroyWindow((HWND) m_hWnd);
-        m_hWnd = 0;
-    }
+    if (m_win)
+        m_win->Destroy();

 }
 
 // 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;
 
 
     m_icon = icon;
     m_strTooltip = tooltip;
 

-    NotifyIconData notifyData(m_hWnd);
+    NotifyIconData notifyData(GetHwndOf(m_win));

 
     if (icon.Ok())
     {
 
     if (icon.Ok())
     {


@@ -147,15 +172,16 @@ bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip)
         notifyData.hIcon = GetHiconOf(icon);
     }
 
         notifyData.hIcon = GetHiconOf(icon);
     }
 

+    // 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() )
     {
     if ( !tooltip.empty() )
     {

-        notifyData.uFlags |= NIF_TIP;
-//        lstrcpyn(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));

         wxStrncpy(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));
     }
 
         wxStrncpy(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip));
     }
 

-    bool ok = Shell_NotifyIcon(m_iconAdded ? NIM_MODIFY
-                                           : NIM_ADD, &notifyData) != 0;
+    bool ok = wxShellNotifyIcon(m_iconAdded ? NIM_MODIFY
+                                            : NIM_ADD, &notifyData) != 0;

 
     if ( !m_iconAdded && ok )
         m_iconAdded = true;
 
     if ( !m_iconAdded && ok )
         m_iconAdded = true;


@@ -170,13 +196,16 @@ bool wxTaskBarIcon::RemoveIcon()
 
     m_iconAdded = false;
 
 
     m_iconAdded = false;
 

-    NotifyIconData notifyData(m_hWnd);
+    NotifyIconData notifyData(GetHwndOf(m_win));

 
 

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

 }
 
 }
 

+#if wxUSE_MENUS

 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 {
 bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 {

+    wxASSERT_MSG( m_win != NULL, _T("taskbar icon not initialized") );
+

     static bool s_inPopup = false;
 
     if (s_inPopup)
     static bool s_inPopup = false;
 
     if (s_inPopup)


@@ -184,143 +213,54 @@ bool wxTaskBarIcon::PopupMenu(wxMenu *menu)
 
     s_inPopup = true;
 
 
     s_inPopup = true;
 

-    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));

 
 

-    bool 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)
-{
-    wxTaskBarIconList::compatibility_iterator node = sm_taskBarIcons.GetFirst();
-    while (node)
-    {
-        wxTaskBarIcon *obj = node->GetData();
-        if (obj->GetHWND() == hWnd)
-            return obj;
-        node = node->GetNext();
-    }
-    return NULL;
-}
-
-void wxTaskBarIcon::AddObject(wxTaskBarIcon* obj)
-{
-    sm_taskBarIcons.Append(obj);
-}
-
-void wxTaskBarIcon::RemoveObject(wxTaskBarIcon* obj)
-{
-    sm_taskBarIcons.DeleteObject(obj);
-}
-
-bool wxTaskBarIcon::RegisterWindowClass()
+void wxTaskBarIcon::RegisterWindowMessages()

 {
     static bool s_registered = false;
 
 {
     static bool s_registered = false;
 

-    if ( s_registered )
-        return true;
-
-    // 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"));
-
-    // set up and register window class
-    WNDCLASS wc;
-    wc.style = CS_HREDRAW | CS_VREDRAW;
-    wc.lpfnWndProc = (WNDPROC) wxTaskBarIconWindowProc;
-    wc.cbClsExtra = 0;
-    wc.cbWndExtra = 0;
-    wc.hInstance = wxGetInstance();
-    wc.hIcon = 0;
-    wc.hCursor = 0;
-    wc.hbrBackground = 0;
-    wc.lpszMenuName = NULL;
-    wc.lpszClassName = wxTaskBarWindowClass;
-
-    if ( !::RegisterClass(&wc) )
+    if ( !s_registered )

     {
     {

-        wxLogLastError(_T("RegisterClass(taskbar icon)"));
-
-        return false;
-    }
-
-    s_registered = true;
+        // Taskbar restart msg will be sent to us if the icon needs to be redrawn
+        gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));

 
 

-    return true;
-}
+        // Also register the taskbar message here
+        gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));

 
 

-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;
+        s_registered = true;
+    }

 }
 
 // ----------------------------------------------------------------------------
 // wxTaskBarIcon window proc
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxTaskBarIcon window proc
 // ----------------------------------------------------------------------------
 

-long wxTaskBarIcon::WindowProc(WXHWND hWnd,
-                               unsigned int msg,
-                               unsigned int wParam,
+long wxTaskBarIcon::WindowProc(unsigned int msg,
+                               unsigned int WXUNUSED(wParam),

                                long lParam)
 {
     wxEventType eventType = 0;
                                long lParam)
 {
     wxEventType eventType = 0;


@@ -331,8 +271,8 @@ long wxTaskBarIcon::WindowProc(WXHWND hWnd,
         SetIcon(m_icon, m_strTooltip);
     }
 
         SetIcon(m_icon, m_strTooltip);
     }
 

-    if (msg != gs_msgTaskbar)
-        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)
     {
 
     switch (lParam)
     {


@@ -378,15 +318,5 @@ long wxTaskBarIcon::WindowProc(WXHWND hWnd,
     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__