X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0ae2df30524bb07bcca824bd0a842bd54a305ff3..b4607e897c31cd59c5ede98c3b5b5d3910902930:/src/msw/taskbar.cpp diff --git a/src/msw/taskbar.cpp b/src/msw/taskbar.cpp index 0fa9ef3a20..91bd88cfaa 100644 --- a/src/msw/taskbar.cpp +++ b/src/msw/taskbar.cpp @@ -1,361 +1,437 @@ ///////////////////////////////////////////////////////////////////////// -// 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 -// Modified by: +// Modified by: Vaclav Slavik // 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__ -#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__) && !defined(__TWIN32__) +#include "wx/msw/wrapshl.h" -#include #include -#include -#include +#include "wx/taskbar.h" +#include "wx/msw/private.h" +#include "wx/dynlib.h" -#ifndef __TWIN32__ -#ifdef __GNUWIN32__ -#ifndef wxUSE_NORLANDER_HEADERS -#include -#endif -#endif +#ifndef NIN_BALLOONTIMEOUT + #define NIN_BALLOONTIMEOUT 0x0404 + #define NIN_BALLOONUSERCLICK 0x0405 #endif -#ifdef __SALFORDC__ -#include +#ifndef NIM_SETVERSION + #define NIM_SETVERSION 0x00000004 #endif -LRESULT APIENTRY _EXPORT wxTaskBarIconWindowProc( HWND hWnd, unsigned msg, - UINT wParam, LONG lParam ); - -wxChar *wxTaskBarWindowClass = _T("wxTaskBarWindowClass"); +#ifndef NIF_INFO + #define NIF_INFO 0x00000010 +#endif -wxList wxTaskBarIcon::sm_taskBarIcons; -bool wxTaskBarIcon::sm_registeredClass = FALSE; -UINT wxTaskBarIcon::sm_taskbarMsg = 0; +#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 -#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) -#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 *); - AddObject(this); + 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); + } - if (RegisterWindowClass()) - m_hWnd = CreateTaskBarWindow(); + // 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); + } + } + +private: + wxTaskBarIcon *m_icon; +}; + + +// ---------------------------------------------------------------------------- +// NotifyIconData: wrapper around NOTIFYICONDATA +// ---------------------------------------------------------------------------- + +struct NotifyIconData : public NOTIFYICONDATA +{ + NotifyIconData(WXHWND hwnd) + { + memset(this, 0, 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; + + // 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) { - 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(¬ifyData, 0, sizeof(notifyData)); - notifyData.cbSize = sizeof(notifyData); - notifyData.hWnd = (HWND) m_hWnd; - notifyData.uCallbackMessage = sm_taskbarMsg; - notifyData.uFlags = NIF_MESSAGE ; - if (icon.Ok()) + if (icon.Ok()) { - notifyData.uFlags |= NIF_ICON; - notifyData.hIcon = (HICON) icon.GetHICON(); + notifyData.uFlags |= NIF_ICON; + notifyData.hIcon = GetHiconOf(icon); } - if (((const wxChar*) tooltip != NULL) && (tooltip != _T(""))) + // 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)); + wxStrlcpy(notifyData.szTip, tooltip.wx_str(), WXSIZEOF(notifyData.szTip)); } - notifyData.uID = 99; + bool ok = wxShellNotifyIcon(m_iconAdded ? NIM_MODIFY + : NIM_ADD, ¬ifyData) != 0; - if (m_iconAdded) - return (Shell_NotifyIcon(NIM_MODIFY, & notifyData) != 0); - else + if ( !ok ) { - m_iconAdded = (Shell_NotifyIcon(NIM_ADD, & notifyData) != 0); - return m_iconAdded; + wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY/ADD)")); } + + 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, + 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 */; - NOTIFYICONDATA notifyData; + if ( !wxShellNotifyIcon(NIM_SETVERSION, ¬ifyData) ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_SETVERSION)")); + } - memset(¬ifyData, 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; + // do show the balloon now + notifyData = NotifyIconData(hwnd); + notifyData.uFlags |= NIF_INFO; + notifyData.uTimeout = msec; + wxStrlcpy(notifyData.szInfo, text.wx_str(), WXSIZEOF(notifyData.szInfo)); + wxStrlcpy(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; + + bool ok = wxShellNotifyIcon(NIM_MODIFY, ¬ifyData) != 0; + if ( !ok ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_MODIFY)")); + } - return (Shell_NotifyIcon(NIM_DELETE, & notifyData) != 0); + return ok; } -bool wxTaskBarIcon::PopupMenu(wxMenu *menu) //, int x, int y); +#endif // wxUSE_TASKBARICON_BALLOONS + +bool wxTaskBarIcon::RemoveIcon() { - bool rval = FALSE; - wxWindow* win; - int x, y; - wxGetMousePosition(&x, &y); + if (!m_iconAdded) + return false; - // is wxFrame the best window type to use??? - win = new wxFrame(NULL, -1, "", wxPoint(x,y), wxSize(-1,-1), 0); - win->PushEventHandler(this); + m_iconAdded = false; - // Remove from record of top-level windows, or will confuse wxWindows - // if we try to exit right now. - wxTopLevelWindows.DeleteObject(win); + NotifyIconData notifyData(GetHwndOf(m_win)); - menu->UpdateUI(); + bool ok = wxShellNotifyIcon(NIM_DELETE, ¬ifyData) != 0; + if ( !ok ) + { + wxLogLastError(wxT("wxShellNotifyIcon(NIM_DELETE)")); + } - rval = win->PopupMenu(menu, 0, 0); + return ok; +} - win->PopEventHandler(FALSE); - win->Destroy(); - //delete win; +#if wxUSE_MENUS +bool wxTaskBarIcon::PopupMenu(wxMenu *menu) +{ + wxASSERT_MSG( m_win != NULL, wxT("taskbar icon not initialized") ); - return rval; -} + static bool s_inPopup = false; + if (s_inPopup) + return false; -// Overridables -void wxTaskBarIcon::OnMouseMove(wxEvent&) -{ -} + s_inPopup = true; -void wxTaskBarIcon::OnLButtonDown(wxEvent&) -{ -} + int x, y; + wxGetMousePosition(&x, &y); -void wxTaskBarIcon::OnLButtonUp(wxEvent&) -{ -} + m_win->Move(x, y); -void wxTaskBarIcon::OnRButtonDown(wxEvent&) -{ -} + m_win->PushEventHandler(this); -void wxTaskBarIcon::OnRButtonUp(wxEvent&) -{ -} + menu->UpdateUI(); -void wxTaskBarIcon::OnLButtonDClick(wxEvent&) -{ -} + // 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)); -void wxTaskBarIcon::OnRButtonDClick(wxEvent&) -{ -} + bool rval = m_win->PopupMenu(menu, 0, 0); -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); } + ::PostMessage(GetHwndOf(m_win), WM_NULL, 0, 0L); + m_win->PopEventHandler(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; -} + s_inPopup = false; -void wxTaskBarIcon::AddObject(wxTaskBarIcon* obj) -{ - sm_taskBarIcons.Append(obj); + return rval; } +#endif // wxUSE_MENUS -void wxTaskBarIcon::RemoveObject(wxTaskBarIcon* obj) +void wxTaskBarIcon::RegisterWindowMessages() { - sm_taskBarIcons.DeleteObject(obj); -} + static bool s_registered = false; -bool wxTaskBarIcon::RegisterWindowClass() -{ - if (sm_registeredClass) - return TRUE; - - // Also register the taskbar message here - sm_taskbarMsg = ::RegisterWindowMessage(_T("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) ); -} + if ( !s_registered ) + { + // Taskbar restart msg will be sent to us if the icon needs to be redrawn + gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated")); -WXHWND wxTaskBarIcon::CreateTaskBarWindow() -{ - HINSTANCE hInstance = GetModuleHandle(NULL); - - HWND hWnd = CreateWindowEx (0, wxTaskBarWindowClass, - _T("wxTaskBarWindow"), - WS_OVERLAPPED, - 0, - 0, - 10, - 10, - NULL, - (HMENU) 0, - hInstance, - NULL); - - return (WXHWND) hWnd; + // 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; - case WM_LBUTTONUP: + case WM_LBUTTONUP: eventType = wxEVT_TASKBAR_LEFT_UP; break; - case WM_RBUTTONDOWN: + case WM_RBUTTONDOWN: eventType = wxEVT_TASKBAR_RIGHT_DOWN; break; - case WM_RBUTTONUP: + case WM_RBUTTONUP: eventType = wxEVT_TASKBAR_RIGHT_UP; break; - case WM_LBUTTONDBLCLK: + case WM_LBUTTONDBLCLK: eventType = wxEVT_TASKBAR_LEFT_DCLICK; break; - case WM_RBUTTONDBLCLK: + case WM_RBUTTONDBLCLK: eventType = wxEVT_TASKBAR_RIGHT_DCLICK; break; - case WM_MOUSEMOVE: + case WM_MOUSEMOVE: 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) { - wxEvent event; - event.SetEventType(eventType); - event.SetEventObject(this); + if ( eventType ) + { + wxTaskBarIconEvent event(eventType, this); ProcessEvent(event); } + 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__