/////////////////////////////////////////////////////////////////////////////
// SystemTray.cpp : implementation file
//
// This is a conglomeration of ideas from the MSJ "Webster" application,
// sniffing round the online docs, and from other implementations such
// as PJ Naughter's "CTrayNotifyIcon" (http://indigo.ie/~pjn/ntray.html)
// especially the "CSystemTray::OnTrayNotification" member function.
// Joerg Koenig suggested the icon animation stuff
//
// This class is a light wrapper around the windows system tray stuff. It
// adds an icon to the system tray with the specified ToolTip text and
// callback notification value, which is sent back to the Parent window.
//
// The tray icon can be instantiated using either the constructor or by
// declaring the object and creating (and displaying) it later on in the
// program. eg.
//
// CSystemTray m_SystemTray; // Member variable of some class
//
// ...
// // in some member function maybe...
// m_SystemTray.Create(pParentWnd, WM_MY_NOTIFY, "Click here",
// hIcon, nSystemTrayID);
//
// Written by Chris Maunder (chrismaunder@codeguru.com)
// Copyright (c) 1998.
//
// Updated: 25 Jul 1998 - Added icon animation, and derived class
// from CWnd in order to handle messages. (CJM)
// (icon animation suggested by Joerg Koenig.
// Added API to set default menu item. Code provided
// by Enrico Lelina.
//
// This code may be used in compiled form in any way you desire. This
// file may be redistributed unmodified by any means PROVIDING it is
// not sold for profit without the authors written consent, and
// providing that this notice and the authors name is included. If
// the source code in this file is used in any commercial application
// then acknowledgement must be made to the author of this file
// (in whatever form you wish).
//
// This file is provided "as is" with no expressed or implied warranty.
// The author accepts no liability if it causes any damage to your
// computer, causes your pet cat to fall ill, increases baldness or
// makes you car start emitting strange noises when you start it up.
//
// Expect bugs.
//
// Please use and enjoy. Please let me know of any bugs/mods/improvements
// that you have found/implemented and I will fix/incorporate them into this
// file.
//
/////////////////////////////////////////////////////////////////////////////
#include "stdafx.h"
#include "SystemTray.h"
#ifdef _DEBUG
#define new DEBUG_NEW
#undef THIS_FILE
static char THIS_FILE[] = __FILE__;
#endif
IMPLEMENT_DYNAMIC(CSystemTray, CWnd)
//##ModelId=3A45CC7701AB
UINT CSystemTray::m_nIDEvent = 4567;
/////////////////////////////////////////////////////////////////////////////
// CSystemTray construction/creation/destruction
//##ModelId=3A45CC770119
CSystemTray::CSystemTray()
{
Initialise();
}
//##ModelId=3A45CC77011A
CSystemTray::CSystemTray(CWnd* pParent, UINT uCallbackMessage, LPCTSTR szToolTip,
HICON icon, UINT uID)
{
Initialise();
Create(pParent, uCallbackMessage, szToolTip, icon, uID);
}
//##ModelId=3A45CC770168
void CSystemTray::Initialise()
{
memset(&m_tnd, 0, sizeof(m_tnd));
m_bEnabled = FALSE;
m_bHidden = FALSE;
m_uIDTimer = 0;
m_hSavedIcon = NULL;
m_DefaultMenuItemID = 0;
m_DefaultMenuItemByPos = TRUE;
}
//##ModelId=3A45CC770124
BOOL CSystemTray::Create(CWnd* pParent, UINT uCallbackMessage, LPCTSTR szToolTip,
HICON icon, UINT uID)
{
// this is only for Windows 95 (or higher)
VERIFY(m_bEnabled = ( GetVersion() & 0xff ) >= 4);
if (!m_bEnabled) return FALSE;
// Make sure Notification window is valid (not needed - CJM)
// VERIFY(m_bEnabled = (pParent && ::IsWindow(pParent->GetSafeHwnd())));
// if (!m_bEnabled) return FALSE;
// Make sure we avoid conflict with other messages
ASSERT(uCallbackMessage >= WM_USER);
// Tray only supports tooltip text up to 64 characters
ASSERT(_tcslen(szToolTip) <= 64);
// Create an invisible window
CWnd::CreateEx(0, AfxRegisterWndClass(0), _T(""), WS_POPUP, 0,0,10,10, NULL, 0);
// load up the NOTIFYICONDATA structure
m_tnd.cbSize = sizeof(NOTIFYICONDATA);
m_tnd.hWnd = pParent->GetSafeHwnd()? pParent->GetSafeHwnd() : m_hWnd;
m_tnd.uID = uID;
m_tnd.hIcon = icon;
m_tnd.uFlags = NIF_MESSAGE | NIF_ICON | NIF_TIP;
m_tnd.uCallbackMessage = uCallbackMessage;
_tcscpy(m_tnd.szTip, szToolTip);
// Set the tray icon
VERIFY(m_bEnabled = Shell_NotifyIcon(NIM_ADD, &m_tnd));
if (!m_menu.LoadMenu(m_tnd.uID)) return FALSE;
return m_bEnabled;
}
//##ModelId=3A45CC770120
CSystemTray::~CSystemTray()
{
RemoveIcon();
m_IconList.RemoveAll();
DestroyWindow();
m_menu.DestroyMenu();
}
/////////////////////////////////////////////////////////////////////////////
// CSystemTray icon manipulation
//##ModelId=3A45CC770143
void CSystemTray::MoveToRight()
{
HideIcon();
ShowIcon();
}
//##ModelId=3A45CC770142
void CSystemTray::RemoveIcon()
{
if (!m_bEnabled) return;
m_tnd.uFlags = 0;
Shell_NotifyIcon(NIM_DELETE, &m_tnd);
m_bEnabled = FALSE;
}
//##ModelId=3A45CC770140
void CSystemTray::HideIcon()
{
if (m_bEnabled && !m_bHidden) {
m_tnd.uFlags = NIF_ICON;
Shell_NotifyIcon (NIM_DELETE, &m_tnd);
m_bHidden = TRUE;
}
}
//##ModelId=3A45CC770141
void CSystemTray::ShowIcon()
{
if (m_bEnabled && m_bHidden) {
m_tnd.uFlags = NIF_MESSAGE | NIF_ICON | NIF_TIP;
Shell_NotifyIcon(NIM_ADD, &m_tnd);
m_bHidden = FALSE;
}
}
//##ModelId=3A45CC770133
BOOL CSystemTray::SetIcon(HICON hIcon)
{
if (!m_bEnabled) return FALSE;
m_tnd.uFlags = NIF_ICON;
m_tnd.hIcon = hIcon;
return Shell_NotifyIcon(NIM_MODIFY, &m_tnd);
}
//##ModelId=3A45CC770135
BOOL CSystemTray::SetIcon(LPCTSTR lpszIconName)
{
HICON hIcon = AfxGetApp()->LoadIcon(lpszIconName);
return SetIcon(hIcon);
}
//##ModelId=3A45CC770138
BOOL CSystemTray::SetIcon(UINT nIDResource)
{
HICON hIcon = AfxGetApp()->LoadIcon(nIDResource);
return SetIcon(hIcon);
}
//##ModelId=3A45CC77013A
BOOL CSystemTray::SetStandardIcon(LPCTSTR lpIconName)
{
HICON hIcon = LoadIcon(NULL, lpIconName);
return SetIcon(hIcon);
}
//##ModelId=3A45CC77013C
BOOL CSystemTray::SetStandardIcon(UINT nIDResource)
{
HICON hIcon = LoadIcon(NULL, MAKEINTRESOURCE(nIDResource));
return SetIcon(hIcon);
}
//##ModelId=3A45CC77013E
HICON CSystemTray::GetIcon() const
{
return (m_bEnabled)? m_tnd.hIcon : NULL;
}
//##ModelId=3A45CC770147
BOOL CSystemTray::SetIconList(UINT uFirstIconID, UINT uLastIconID)
{
if (uFirstIconID > uLastIconID)
return FALSE;
UINT uIconArraySize = uLastIconID - uFirstIconID + 1;
const CWinApp * pApp = AfxGetApp();
ASSERT(pApp != 0);
m_IconList.RemoveAll();
try {
for (UINT i = uFirstIconID; i <= uLastIconID; i++)
m_IconList.Add(pApp->LoadIcon(i));
}
catch (CMemoryException *e)
{
e->ReportError();
e->Delete();
m_IconList.RemoveAll();
return FALSE;
}
return TRUE;
}
//##ModelId=3A45CC77014A
BOOL CSystemTray::SetIconList(HICON* pHIconList, UINT nNumIcons)
{
m_IconList.RemoveAll();
try {
for (UINT i = 0; i <= nNumIcons; i++)
m_IconList.Add(pHIconList[i]);
}
catch (CMemoryException *e)
{
e->ReportError();
e->Delete();
m_IconList.RemoveAll();
return FALSE;
}
return TRUE;
}
//##ModelId=3A45CC77014D
BOOL CSystemTray::Animate(UINT nDelayMilliSeconds, int nNumSeconds /*=-1*/)
{
StopAnimation();
m_nCurrentIcon = 0;
m_StartTime = COleDateTime::GetCurrentTime();
m_nAnimationPeriod = nNumSeconds;
m_hSavedIcon = GetIcon();
// Setup a timer for the animation
m_uIDTimer = SetTimer(m_nIDEvent, nDelayMilliSeconds, NULL);
return (m_uIDTimer != 0);
}
//##ModelId=3A45CC770150
BOOL CSystemTray::StepAnimation()
{
if (!m_IconList.GetSize())
return FALSE;
m_nCurrentIcon++;
if (m_nCurrentIcon >= m_IconList.GetSize())
m_nCurrentIcon = 0;
return SetIcon(m_IconList[m_nCurrentIcon]);
}
//##ModelId=3A45CC770151
BOOL CSystemTray::StopAnimation()
{
BOOL bResult = FALSE;
if (m_uIDTimer)
bResult = KillTimer(m_uIDTimer);
m_uIDTimer = 0;
if (m_hSavedIcon)
SetIcon(m_hSavedIcon);
m_hSavedIcon = NULL;
return bResult;
}
/////////////////////////////////////////////////////////////////////////////
// CSystemTray tooltip text manipulation
//##ModelId=3A45CC77012D
BOOL CSystemTray::SetTooltipText(LPCTSTR pszTip)
{
if (!m_bEnabled) return FALSE;
m_tnd.uFlags = NIF_TIP;
_tcscpy(m_tnd.szTip, pszTip);
return Shell_NotifyIcon(NIM_MODIFY, &m_tnd);
}
//##ModelId=3A45CC77012F
BOOL CSystemTray::SetTooltipText(UINT nID)
{
CString strText;
VERIFY(strText.LoadString(nID));
return SetTooltipText(strText);
}
//##ModelId=3A45CC770131
CString CSystemTray::GetTooltipText() const
{
CString strText;
if (m_bEnabled)
strText = m_tnd.szTip;
return strText;
}
/////////////////////////////////////////////////////////////////////////////
// CSystemTray notification window stuff
//##ModelId=3A45CC77015A
BOOL CSystemTray::SetNotificationWnd(CWnd* pWnd)
{
if (!m_bEnabled) return FALSE;
// Make sure Notification window is valid
ASSERT(pWnd && ::IsWindow(pWnd->GetSafeHwnd()));
m_tnd.hWnd = pWnd->GetSafeHwnd();
m_tnd.uFlags = 0;
return Shell_NotifyIcon(NIM_MODIFY, &m_tnd);
}
//##ModelId=3A45CC77015C
CWnd* CSystemTray::GetNotificationWnd() const
{
return CWnd::FromHandle(m_tnd.hWnd);
}
/////////////////////////////////////////////////////////////////////////////
// CSystemTray menu manipulation
//##ModelId=3A45CC770157
BOOL CSystemTray::SetMenuDefaultItem(UINT uItem, BOOL bByPos)
{
if ((m_DefaultMenuItemID == uItem) && (m_DefaultMenuItemByPos == bByPos))
return TRUE;
m_DefaultMenuItemID = uItem;
m_DefaultMenuItemByPos = bByPos;
CMenu menu, *pSubMenu;
// if (!menu.LoadMenu(m_tnd.uID)) return FALSE;
if (!(pSubMenu = m_menu.GetSubMenu(0))) return FALSE;
::SetMenuDefaultItem(pSubMenu->m_hMenu, m_DefaultMenuItemID, m_DefaultMenuItemByPos);
return TRUE;
}
//##ModelId=3A45CC770152
void CSystemTray::GetMenuDefaultItem(UINT& uItem, BOOL& bByPos)
{
uItem = m_DefaultMenuItemID;
bByPos = m_DefaultMenuItemByPos;
}
/////////////////////////////////////////////////////////////////////////////
// CSystemTray message handlers
BEGIN_MESSAGE_MAP(CSystemTray, CWnd)
//{{AFX_MSG_MAP(CSystemTray)
ON_WM_TIMER()
//}}AFX_MSG_MAP
END_MESSAGE_MAP()
//##ModelId=3A45CC7701D4
void CSystemTray::OnTimer(UINT nIDEvent)
{
ASSERT(nIDEvent == m_nIDEvent);
COleDateTime CurrentTime = COleDateTime::GetCurrentTime();
COleDateTimeSpan period = CurrentTime - m_StartTime;
if (m_nAnimationPeriod > 0 && m_nAnimationPeriod < period.GetTotalSeconds())
{
StopAnimation();
return;
}
StepAnimation();
}
LRESULT CSystemTray::OnTrayNotification(UINT wParam, LONG lParam)
{
//Return quickly if its not for this tray icon
if (wParam != m_tnd.uID)
return 0L;
CMenu menu, *pSubMenu;
CWnd* pTarget = AfxGetMainWnd();
// Clicking with right button brings up a context menu
if (LOWORD(lParam) == WM_RBUTTONUP)
{
// if (!menu.LoadMenu(m_tnd.uID)) return 0;
if (!(pSubMenu = m_menu.GetSubMenu(0))) return 0;
// Make chosen menu item the default (bold font)
::SetMenuDefaultItem(pSubMenu->m_hMenu, m_DefaultMenuItemID, m_DefaultMenuItemByPos);
// Display and track the popup menu
CPoint pos;
GetCursorPos(&pos);
pTarget->SetForegroundWindow();
::TrackPopupMenu(pSubMenu->m_hMenu, 0, pos.x, pos.y, 0,
pTarget->GetSafeHwnd(), NULL);
// BUGFIX: See "PRB: Menus for Notification Icons Don't Work Correctly"
pTarget->PostMessage(WM_NULL, 0, 0);
// menu.DestroyMenu();
}
else if (LOWORD(lParam) == WM_LBUTTONDBLCLK)
{
// double click received, the default action is to execute default menu item
pTarget->SetForegroundWindow();
UINT uItem;
if (m_DefaultMenuItemByPos)
{
// if (!menu.LoadMenu(m_tnd.uID)) return 0;
if (!(pSubMenu = m_menu.GetSubMenu(0))) return 0;
uItem = pSubMenu->GetMenuItemID(m_DefaultMenuItemID);
}
else
uItem = m_DefaultMenuItemID;
pTarget->SendMessage(WM_COMMAND, uItem, 0);
// menu.DestroyMenu();
}
return 1;
}
//##ModelId=3A45CC770162
LRESULT CSystemTray::WindowProc(UINT message, WPARAM wParam, LPARAM lParam)
{
if (message == m_tnd.uCallbackMessage)
return OnTrayNotification(wParam, lParam);
return CWnd::WindowProc(message, wParam, lParam);
}
BOOL CSystemTray::ModifyMenu(UINT nPosition,
UINT nFlags,
UINT_PTR nIDNewItem,
LPCTSTR lpszNewItem)
{
CMenu menu, *pSubMenu;
// if (!menu.LoadMenu(m_tnd.uID)) return FALSE;
if (!(pSubMenu = m_menu.GetSubMenu(0))) return FALSE;
return pSubMenu->ModifyMenu(nPosition,nFlags,nIDNewItem,lpszNewItem);
}