X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/77ffb5937e89927b621128789401db8921fe580f..4e15d1caa03346c126015019c1fdf093033ef40b:/src/msw/taskbar.cpp?ds=sidebyside diff --git a/src/msw/taskbar.cpp b/src/msw/taskbar.cpp index d6ce0d0eb9..4141b0e3c8 100644 --- a/src/msw/taskbar.cpp +++ b/src/msw/taskbar.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////// -// File: taskbar.cpp +// File: src/msw/taskbar.cpp // Purpose: Implements wxTaskBarIcon class for manipulating icons on // the Windows task bar. // Author: Julian Smart @@ -7,61 +7,66 @@ // Created: 24/3/98 // RCS-ID: $Id$ // Copyright: (c) -// Licence: wxWidgets licence +// 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__ -#pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_TASKBARICON + #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" + #include "wx/app.h" #endif -#if defined(__WIN95__) - -#include "wx/msw/private.h" -#include "wx/msw/winundef.h" +#include "wx/msw/wrapshl.h" #include #include "wx/taskbar.h" +#include "wx/msw/private.h" +#include "wx/dynlib.h" -#ifdef __GNUWIN32_OLD__ - #include "wx/msw/gnuwin32/extra.h" +#ifndef NIN_BALLOONTIMEOUT + #define NIN_BALLOONTIMEOUT 0x0404 + #define NIN_BALLOONUSERCLICK 0x0405 #endif -#ifdef __WXWINCE__ - #include - #include +#ifndef NIM_SETVERSION + #define NIM_SETVERSION 0x00000004 #endif -// 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() +#ifndef NIF_INFO + #define NIF_INFO 0x00000010 +#endif + +#ifndef NOTIFYICONDATA_V1_SIZE + #ifdef UNICODE + #define NOTIFYICONDATA_V1_SIZE 0x0098 + #else + #define NOTIFYICONDATA_V1_SIZE 0x0058 + #endif +#endif + +#ifndef NOTIFYICONDATA_V2_SIZE + #ifdef UNICODE + #define NOTIFYICONDATA_V2_SIZE 0x03A8 + #else + #define NOTIFYICONDATA_V2_SIZE 0x01E8 + #endif #endif +// initialized on demand +static UINT gs_msgTaskbar = 0; +static UINT gs_msgRestartTaskbar = 0; + IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler) @@ -69,6 +74,38 @@ IMPLEMENT_DYNAMIC_CLASS(wxTaskBarIcon, wxEvtHandler) // implementation // ============================================================================ +// 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 *); + + static Shell_NotifyIcon_t s_pfnShell_NotifyIcon = NULL; + static bool s_initialized = false; + if ( !s_initialized ) + { + s_initialized = true; + + 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 +} + // ---------------------------------------------------------------------------- // wxTaskBarIconWindow: helper window // ---------------------------------------------------------------------------- @@ -81,11 +118,11 @@ class wxTaskBarIconWindow : public wxFrame { public: wxTaskBarIconWindow(wxTaskBarIcon *icon) - : wxFrame(NULL, -1, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0), + : wxFrame(NULL, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0), m_icon(icon) { } - + WXLRESULT MSWWindowProc(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam) { @@ -103,7 +140,7 @@ private: wxTaskBarIcon *m_icon; }; - + // ---------------------------------------------------------------------------- // NotifyIconData: wrapper around NOTIFYICONDATA // ---------------------------------------------------------------------------- @@ -113,7 +150,19 @@ struct NotifyIconData : public NOTIFYICONDATA NotifyIconData(WXHWND hwnd) { memset(this, 0, sizeof(NOTIFYICONDATA)); - cbSize = sizeof(NOTIFYICONDATA); + + // Do _not_ use sizeof(NOTIFYICONDATA) here, it may be too big if we're + // compiled with newer headers but running on an older system and while + // we could do complicated tests for the exact system version it's + // easier to just use an old size which should be supported everywhere + // from Windows 2000 up and which is all we need as we don't use any + // newer features so far. But if we're running under a really ancient + // system (Win9x), fall back to even smaller size -- then the balloon + // related features won't be available but the rest will still work. + cbSize = wxTheApp->GetShell32Version() >= 500 + ? NOTIFYICONDATA_V2_SIZE + : NOTIFYICONDATA_V1_SIZE; + hWnd = (HWND) hwnd; uCallbackMessage = gs_msgTaskbar; uFlags = NIF_MESSAGE; @@ -128,7 +177,7 @@ struct NotifyIconData : public NOTIFYICONDATA // wxTaskBarIcon // ---------------------------------------------------------------------------- -wxTaskBarIcon::wxTaskBarIcon() +wxTaskBarIcon::wxTaskBarIcon(wxTaskBarIconType WXUNUSED(iconType)) { m_win = NULL; m_iconAdded = false; @@ -137,18 +186,24 @@ wxTaskBarIcon::wxTaskBarIcon() wxTaskBarIcon::~wxTaskBarIcon() { - if (m_iconAdded) + if ( m_iconAdded ) RemoveIcon(); - if (m_win) - m_win->Destroy(); + 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) { - // NB: we have to create the window lazily because of backward compatiblity, - // old aplications may create wxTaskBarIcon instance before wxApp + // 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) { @@ -158,23 +213,29 @@ bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip) m_icon = icon; m_strTooltip = tooltip; - NotifyIconData notifyData((HWND)m_win->GetHWND()); + NotifyIconData notifyData(GetHwndOf(m_win)); - if (icon.Ok()) + if (icon.IsOk()) { notifyData.uFlags |= NIF_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() ) { - notifyData.uFlags |= NIF_TIP; -// lstrcpyn(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip)); - wxStrncpy(notifyData.szTip, tooltip.c_str(), WXSIZEOF(notifyData.szTip)); + wxStrlcpy(notifyData.szTip, tooltip.t_str(), WXSIZEOF(notifyData.szTip)); } - bool ok = Shell_NotifyIcon(m_iconAdded ? NIM_MODIFY - : NIM_ADD, ¬ifyData) != 0; + bool ok = wxShellNotifyIcon(m_iconAdded ? NIM_MODIFY + : NIM_ADD, ¬ifyData) != 0; + + if ( !ok ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY/ADD)")); + } if ( !m_iconAdded && ok ) m_iconAdded = true; @@ -182,6 +243,56 @@ bool wxTaskBarIcon::SetIcon(const wxIcon& icon, const wxString& tooltip) return ok; } +#if wxUSE_TASKBARICON_BALLOONS + +bool +wxTaskBarIcon::ShowBalloon(const wxString& title, + const wxString& text, + unsigned msec, + int flags) +{ + wxCHECK_MSG( m_iconAdded, false, + wxT("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 2000/XP */; + + if ( !wxShellNotifyIcon(NIM_SETVERSION, ¬ifyData) ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_SETVERSION)")); + } + + // do show the balloon now + notifyData = NotifyIconData(hwnd); + notifyData.uFlags |= NIF_INFO; + notifyData.uTimeout = msec; + wxStrlcpy(notifyData.szInfo, text.t_str(), WXSIZEOF(notifyData.szInfo)); + wxStrlcpy(notifyData.szInfoTitle, title.t_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; + + bool ok = wxShellNotifyIcon(NIM_MODIFY, ¬ifyData) != 0; + if ( !ok ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY)")); + } + + return ok; +} + +#endif // wxUSE_TASKBARICON_BALLOONS + bool wxTaskBarIcon::RemoveIcon() { if (!m_iconAdded) @@ -189,14 +300,21 @@ bool wxTaskBarIcon::RemoveIcon() m_iconAdded = false; - NotifyIconData notifyData((HWND)m_win->GetHWND()); + NotifyIconData notifyData(GetHwndOf(m_win)); + + bool ok = wxShellNotifyIcon(NIM_DELETE, ¬ifyData) != 0; + if ( !ok ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_DELETE)")); + } - return Shell_NotifyIcon(NIM_DELETE, ¬ifyData) != 0; + return ok; } +#if wxUSE_MENUS bool wxTaskBarIcon::PopupMenu(wxMenu *menu) { - wxASSERT_MSG( m_win != NULL, _T("taskbar icon not initialized") ); + wxASSERT_MSG( m_win != NULL, wxT("taskbar icon not initialized") ); static bool s_inPopup = false; @@ -209,18 +327,19 @@ bool wxTaskBarIcon::PopupMenu(wxMenu *menu) wxGetMousePosition(&x, &y); m_win->Move(x, y); - + m_win->PushEventHandler(this); menu->UpdateUI(); - // Work around a WIN32 bug - ::SetForegroundWindow((HWND)m_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 = m_win->PopupMenu(menu, 0, 0); - // Work around a WIN32 bug - ::PostMessage((HWND)m_win->GetHWND(), WM_NULL, 0, 0L); + ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L); m_win->PopEventHandler(false); @@ -228,32 +347,14 @@ bool wxTaskBarIcon::PopupMenu(wxMenu *menu) return rval; } - -#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 +#endif // wxUSE_MENUS void wxTaskBarIcon::RegisterWindowMessages() { 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")); @@ -272,18 +373,18 @@ 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? + if ( msg == gs_msgRestartTaskbar ) // does the icon need to be redrawn? { m_iconAdded = false; SetIcon(m_icon, m_strTooltip); + return 0; } // this function should only be called for gs_msg(Restart)Taskbar messages - wxASSERT(msg == gs_msgTaskbar); + wxASSERT( msg == gs_msgTaskbar ); - switch (lParam) + wxEventType eventType = 0; + switch ( lParam ) { case WM_LBUTTONDOWN: eventType = wxEVT_TASKBAR_LEFT_DOWN; @@ -313,11 +414,16 @@ long wxTaskBarIcon::WindowProc(unsigned int msg, eventType = wxEVT_TASKBAR_MOVE; break; - default: + case NIN_BALLOONTIMEOUT: + eventType = wxEVT_TASKBAR_BALLOON_TIMEOUT; + break; + + case NIN_BALLOONUSERCLICK: + eventType = wxEVT_TASKBAR_BALLOON_CLICK; break; } - if (eventType) + if ( eventType ) { wxTaskBarIconEvent event(eventType, this); @@ -327,4 +433,5 @@ long wxTaskBarIcon::WindowProc(unsigned int msg, return 0; } -#endif // __WIN95__ +#endif // wxUSE_TASKBARICON +