/////////////////////////////////////////////////////////////////////////
-// File: taskbar.cpp
+// 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
/////////////////////////////////////////////////////////////////////////
-#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 <string.h>
#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 <winreg.h>
- #include <shellapi.h>
+#ifndef NIM_SETVERSION
+ #define NIM_SETVERSION 0x00000004
#endif
-#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxTaskBarIconList);
-
-LRESULT APIENTRY _EXPORT
-wxTaskBarIconWindowProc( HWND hWnd, unsigned msg, UINT wParam, LONG lParam );
+#ifndef NIF_INFO
+ #define NIF_INFO 0x00000010
+#endif
-wxChar *wxTaskBarWindowClass = (wxChar*) wxT("wxTaskBarWindowClass");
+#ifndef NOTIFYICONDATA_V1_SIZE
+ #ifdef UNICODE
+ #define NOTIFYICONDATA_V1_SIZE 0x0098
+ #else
+ #define NOTIFYICONDATA_V1_SIZE 0x0058
+ #endif
+#endif
-wxTaskBarIconList wxTaskBarIcon::sm_taskBarIcons;
+#ifndef NOTIFYICONDATA_V2_SIZE
+ #ifdef UNICODE
+ #define NOTIFYICONDATA_V2_SIZE 0x03A8
+ #else
+ #define NOTIFYICONDATA_V2_SIZE 0x01E8
+ #endif
+#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()
-#endif
+static UINT gs_msgTaskbar = 0;
+static UINT gs_msgRestartTaskbar = 0;
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
+// ----------------------------------------------------------------------------
+
+// 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;
+};
+
+
// ----------------------------------------------------------------------------
// NotifyIconData: wrapper around 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;
// wxTaskBarIcon
// ----------------------------------------------------------------------------
-wxTaskBarIcon::wxTaskBarIcon()
+wxTaskBarIcon::wxTaskBarIcon(wxTaskBarIconType WXUNUSED(iconType))
{
- m_hWnd = 0;
+ m_win = NULL;
m_iconAdded = false;
-
- AddObject(this);
-
- if (RegisterWindowClass())
- m_hWnd = CreateTaskBarWindow();
+ RegisterWindowMessages();
}
wxTaskBarIcon::~wxTaskBarIcon()
{
- RemoveObject(this);
-
- if (m_iconAdded)
- {
+ if ( m_iconAdded )
RemoveIcon();
- }
- if (m_hWnd)
+ 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(m_hWnd);
+ 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;
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)
m_iconAdded = false;
- NotifyIconData notifyData(m_hWnd);
+ 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, wxT("taskbar icon not initialized") );
+
static bool s_inPopup = false;
if (s_inPopup)
s_inPopup = true;
- wxWindow* win;
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();
- // 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;
}
+#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;
- 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;
- }
+ // Taskbar restart msg will be sent to us if the icon needs to be redrawn
+ gs_msgRestartTaskbar = RegisterWindowMessage(wxT("TaskbarCreated"));
- s_registered = true;
+ // Also register the taskbar message here
+ gs_msgTaskbar = ::RegisterWindowMessage(wxT("wxTaskBarIconMessage"));
- return 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;
+ s_registered = true;
+ }
}
// ----------------------------------------------------------------------------
// 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;
-
- 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;
}
- 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)
+ wxEventType eventType = 0;
+ switch ( lParam )
{
case WM_LBUTTONDOWN:
eventType = wxEVT_TASKBAR_LEFT_DOWN;
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);
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__
projects / wxWidgets.git / blobdiff