CSysTray Class Reference

#include <csystray.h>

Inheritance diagram for CSysTray:

Collaboration diagram for CSysTray:

Public Member Functions
HRESULT	NotifyIcon (INT code, UINT uId, HICON hIcon, LPCWSTR szTip, DWORD dwstate=0)
HWND	GetHWnd ()
VOID	EnableService (DWORD dwServiceFlag, BOOL bEnable)
BOOL	IsServiceEnabled (DWORD dwServiceFlag)
	CSysTray ()
virtual	~CSysTray ()
virtual HRESULT STDMETHODCALLTYPE	QueryStatus (const GUID *pguidCmdGroup, ULONG cCmds, OLECMD prgCmds [], OLECMDTEXT *pCmdText)
virtual HRESULT STDMETHODCALLTYPE	Exec (const GUID *pguidCmdGroup, DWORD nCmdID, DWORD nCmdexecopt, VARIANT *pvaIn, VARIANT *pvaOut)
Public Member Functions inherited from ATL::CComObjectRootEx< CComMultiThreadModelNoCS >
	~CComObjectRootEx ()
ULONG	InternalAddRef ()
ULONG	InternalRelease ()
void	Lock ()
void	Unlock ()
HRESULT	_AtlInitialConstruct ()
Public Member Functions inherited from ATL::CComObjectRootBase
	CComObjectRootBase ()
	~CComObjectRootBase ()
void	SetVoid (void *)
HRESULT	_AtlFinalConstruct ()
HRESULT	FinalConstruct ()
void	InternalFinalConstructAddRef ()
void	InternalFinalConstructRelease ()
void	FinalRelease ()
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Protected Member Functions
BOOL	ProcessWindowMessage (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT &lResult, DWORD dwMsgMapID=0)

Private Member Functions
HRESULT	SysTrayMessageLoop ()
HRESULT	SysTrayThreadProc ()
HRESULT	CreateSysTrayThread ()
HRESULT	DestroySysTrayWindow ()
HRESULT	InitIcons ()
HRESULT	ShutdownIcons ()
HRESULT	UpdateIcons ()
HRESULT	ProcessIconMessage (UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT &lResult)
HRESULT	InitNetShell ()
HRESULT	ShutdownNetShell ()
VOID	GetServicesEnabled ()

Static Private Member Functions
static DWORD WINAPI	s_SysTrayThreadProc (PVOID param)

Private Attributes
CComPtr< IOleCommandTarget >	pctNetShell
DWORD	dwServicesEnabled
UINT	wm_SHELLHOOK
UINT	wm_DESTROYWINDOW

Additional Inherited Members
Public Types inherited from IOleCommandTarget
enum	OLECMDF {   OLECMDF_SUPPORTED = 0x1, OLECMDF_ENABLED = 0x2, OLECMDF_LATCHED = 0x4, OLECMDF_NINCHED = 0x8,   OLECMDF_INVISIBLE = 0x10, OLECMDF_DEFHIDEONCTXTMENU = 0x20 }
enum	OLECMDTEXTF { OLECMDTEXTF_NONE = 0, OLECMDTEXTF_NAME = 1, OLECMDTEXTF_STATUS = 2 }
enum	OLECMDEXECOPT { OLECMDEXECOPT_DODEFAULT = 0, OLECMDEXECOPT_PROMPTUSER = 1, OLECMDEXECOPT_DONTPROMPTUSER = 2, OLECMDEXECOPT_SHOWHELP = 3 }
enum	OLECMDID {   OLECMDID_OPEN = 1, OLECMDID_NEW = 2, OLECMDID_SAVE = 3, OLECMDID_SAVEAS = 4,   OLECMDID_SAVECOPYAS = 5, OLECMDID_PRINT = 6, OLECMDID_PRINTPREVIEW = 7, OLECMDID_PAGESETUP = 8,   OLECMDID_SPELL = 9, OLECMDID_PROPERTIES = 10, OLECMDID_CUT = 11, OLECMDID_COPY = 12,   OLECMDID_PASTE = 13, OLECMDID_PASTESPECIAL = 14, OLECMDID_UNDO = 15, OLECMDID_REDO = 16,   OLECMDID_SELECTALL = 17, OLECMDID_CLEARSELECTION = 18, OLECMDID_ZOOM = 19, OLECMDID_GETZOOMRANGE = 20,   OLECMDID_UPDATECOMMANDS = 21, OLECMDID_REFRESH = 22, OLECMDID_STOP = 23, OLECMDID_HIDETOOLBARS = 24,   OLECMDID_SETPROGRESSMAX = 25, OLECMDID_SETPROGRESSPOS = 26, OLECMDID_SETPROGRESSTEXT = 27, OLECMDID_SETTITLE = 28,   OLECMDID_SETDOWNLOADSTATE = 29, OLECMDID_STOPDOWNLOAD = 30, OLECMDID_ONTOOLBARACTIVATED = 31, OLECMDID_FIND = 32,   OLECMDID_DELETE = 33, OLECMDID_HTTPEQUIV = 34, OLECMDID_HTTPEQUIV_DONE = 35, OLECMDID_ENABLE_INTERACTION = 36,   OLECMDID_ONUNLOAD = 37, OLECMDID_PROPERTYBAG2 = 38, OLECMDID_PREREFRESH = 39, OLECMDID_SHOWSCRIPTERROR = 40,   OLECMDID_SHOWMESSAGE = 41, OLECMDID_SHOWFIND = 42, OLECMDID_SHOWPAGESETUP = 43, OLECMDID_SHOWPRINT = 44,   OLECMDID_CLOSE = 45, OLECMDID_ALLOWUILESSSAVEAS = 46, OLECMDID_DONTDOWNLOADCSS = 47, OLECMDID_UPDATEPAGESTATUS = 48,   OLECMDID_PRINT2 = 49, OLECMDID_PRINTPREVIEW2 = 50, OLECMDID_SETPRINTTEMPLATE = 51, OLECMDID_GETPRINTTEMPLATE = 52,   OLECMDID_PAGEACTIONBLOCKED = 55, OLECMDID_PAGEACTIONUIQUERY = 56, OLECMDID_FOCUSVIEWCONTROLS = 57, OLECMDID_FOCUSVIEWCONTROLSQUERY = 58,   OLECMDID_SHOWPAGEACTIONMENU = 59, OLECMDID_ADDTRAVELENTRY = 60, OLECMDID_UPDATETRAVELENTRY = 61, OLECMDID_UPDATEBACKFORWARDSTATE = 62,   OLECMDID_OPTICAL_ZOOM = 63, OLECMDID_OPTICAL_GETZOOMRANGE = 64, OLECMDID_WINDOWSTATECHANGED = 65, OLECMDID_ACTIVEXINSTALLSCOPE = 66,   OLECMDID_UPDATETRAVELENTRY_DATARECOVERY = 67, OLECMDID_SHOWTASKDLG = 68, OLECMDID_POPSTATEEVENT = 69, OLECMDID_VIEWPORT_MODE = 70,   OLECMDID_LAYOUT_VIEWPORT_WIDTH = 71, OLECMDID_VISUAL_VIEWPORT_EXCLUDE_BOTTOM = 72, OLECMDID_USER_OPTICAL_ZOOM = 73, OLECMDID_PAGEAVAILABLE = 74,   OLECMDID_GETUSERSCALABLE = 75, OLECMDID_UPDATE_CARET = 76, OLECMDID_ENABLE_VISIBILITY = 77, OLECMDID_MEDIA_PLAYBACK = 78 }
typedef IOleCommandTarget *	LPOLECOMMANDTARGET
typedef enum IOleCommandTarget::OLECMDF	OLECMDF
typedef struct IOleCommandTarget::_tagOLECMD	OLECMD
typedef struct IOleCommandTarget::_tagOLECMDTEXT	OLECMDTEXT
typedef enum IOleCommandTarget::OLECMDTEXTF	OLECMDTEXTF
typedef enum IOleCommandTarget::OLECMDEXECOPT	OLECMDEXECOPT
typedef enum IOleCommandTarget::OLECMDID	OLECMDID
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Static Public Member Functions inherited from ATL::CComObjectRootBase
static void WINAPI	ObjectMain (bool)
static const struct _ATL_CATMAP_ENTRY *	GetCategoryMap ()
static HRESULT WINAPI	InternalQueryInterface (void *pThis, const _ATL_INTMAP_ENTRY *pEntries, REFIID iid, void **ppvObject)
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 21 of file csystray.h.

Constructor & Destructor Documentation

CSysTray()

CSysTray::CSysTray

(

)

Definition at line 23 of file csystray.cpp.

                   : dwServicesEnabled(0)
{
    wm_SHELLHOOK = RegisterWindowMessageW(L"SHELLHOOK");
    wm_DESTROYWINDOW = RegisterWindowMessageW(L"CSysTray_DESTROY");
}

~CSysTray()

CSysTray::~CSysTray ( )

virtual

Definition at line 29 of file csystray.cpp.

{
}

Member Function Documentation

CreateSysTrayThread()

HRESULT CSysTray::CreateSysTrayThread ( )

private

Definition at line 271 of file csystray.cpp.

{
    TRACE("CSysTray Init TODO: Initialize tray icon handlers.\n");
    AddRef();

    HANDLE hThread = CreateThread(NULL, 0, s_SysTrayThreadProc, this, 0, NULL);

    CloseHandle(hThread);

    return S_OK;
}

Referenced by Exec().

DestroySysTrayWindow()

HRESULT CSysTray::DestroySysTrayWindow ( )

private

Definition at line 283 of file csystray.cpp.

{
    if (!DestroyWindow())
    {
        // Window is from another thread, ask it politely to destroy itself:
        SendMessage(wm_DESTROYWINDOW);
    }
    return S_OK;
}

Referenced by Exec().

EnableService()

VOID CSysTray::EnableService	(	DWORD	dwServiceFlag,
		BOOL	bEnable
	)

Definition at line 62 of file csystray.cpp.

{
    HKEY hKey;

    if (bEnable)
        this->dwServicesEnabled |= dwServiceFlag;
    else
        this->dwServicesEnabled &= ~dwServiceFlag;

    if (RegCreateKeyExW(HKEY_CURRENT_USER,
                        L"Software\\Microsoft\\Windows\\CurrentVersion\\Applets\\SysTray",
                        0,
                        NULL,
                        REG_OPTION_NON_VOLATILE,
                        KEY_WRITE,
                        NULL,
                        &hKey,
                        NULL) == ERROR_SUCCESS)
    {
        RegSetValueExW(hKey,
                       L"Services",
                       0,
                       REG_DWORD,
                       (LPBYTE)&this->dwServicesEnabled,
                       sizeof(DWORD));

        RegCloseKey(hKey);
    }
}

Exec()

HRESULT STDMETHODCALLTYPE CSysTray::Exec ( const GUID *  pguidCmdGroup, DWORD  nCmdID, DWORD  nCmdexecopt, VARIANT *  pvaIn, VARIANT *  pvaOut  )

virtual

Implements IOleCommandTarget.

Definition at line 300 of file csystray.cpp.

{
    if (!IsEqualGUID(*pguidCmdGroup, CGID_ShellServiceObject))
        return E_FAIL;

    switch (nCmdID)
    {
    case OLECMDID_NEW: // init
        return CreateSysTrayThread();
    case OLECMDID_SAVE: // shutdown
        return DestroySysTrayWindow();
    }
    return S_OK;
}

GetHWnd()

HWND CSysTray::GetHWnd ( )

inline

Definition at line 54 of file csystray.h.

{ return m_hWnd; }

Referenced by _RunHotplug(), _ShowContextMenu(), _ShowContextMenuR(), NotifyBalloon(), and ShowPowerSchemesPopupMenu().

GetServicesEnabled()

VOID CSysTray::GetServicesEnabled ( )

private

Definition at line 33 of file csystray.cpp.

{
    HKEY hKey;
    DWORD dwSize;

    /* Enable power, volume and hotplug by default */
    this->dwServicesEnabled = POWER_SERVICE_FLAG | VOLUME_SERVICE_FLAG | HOTPLUG_SERVICE_FLAG;

    if (RegCreateKeyExW(HKEY_CURRENT_USER, REGSTR_PATH_SYSTRAY,
                        0,
                        NULL,
                        REG_OPTION_NON_VOLATILE,
                        KEY_READ,
                        NULL,
                        &hKey,
                        NULL) == ERROR_SUCCESS)
    {
        dwSize = sizeof(DWORD);
        RegQueryValueExW(hKey,
                         L"Services",
                         NULL,
                         NULL,
                         (LPBYTE)&this->dwServicesEnabled,
                         &dwSize);

        RegCloseKey(hKey);
    }
}

Referenced by ProcessWindowMessage().

InitIcons()

HRESULT CSysTray::InitIcons ( )

private

Definition at line 119 of file csystray.cpp.

{
    TRACE("Initializing Notification icons...\n");
    for (int i = 0; i < g_NumIcons; i++)
    {
        if (this->dwServicesEnabled & g_IconHandlers[i].dwServiceFlag)
        {
            HRESULT hr = g_IconHandlers[i].pfnInit(this);
            if (FAILED(hr))
                return hr;
        }
    }

    MouseKeys_Init(this);

    return InitNetShell();
}

Referenced by ProcessWindowMessage().

InitNetShell()

HRESULT CSysTray::InitNetShell ( )

private

Definition at line 97 of file csystray.cpp.

{
    HRESULT hr = CoCreateInstance(CLSID_ConnectionTray, 0, 1u, IID_PPV_ARG(IOleCommandTarget, &pctNetShell));
    if (FAILED(hr))
        return hr;

    return pctNetShell->Exec(&CGID_ShellServiceObject,
                             OLECMDID_NEW,
                             OLECMDEXECOPT_DODEFAULT, NULL, NULL);
}

Referenced by InitIcons().

IsServiceEnabled()

BOOL CSysTray::IsServiceEnabled

(

DWORD

dwServiceFlag

)

Definition at line 92 of file csystray.cpp.

{
    return (this->dwServicesEnabled & dwServiceFlag);
}

NotifyIcon()

HRESULT CSysTray::NotifyIcon	(	INT	code,
		UINT	uId,
		HICON	hIcon,
		LPCWSTR	szTip,
		DWORD	dwstate = 0
	)

Definition at line 207 of file csystray.cpp.

{
    NOTIFYICONDATA nim = { 0 };

    TRACE("NotifyIcon code=%d, uId=%d, hIcon=%p, szTip=%S\n", code, uId, hIcon, szTip);

    nim.cbSize = sizeof(nim);
    nim.uFlags = NIF_MESSAGE | NIF_ICON | NIF_STATE | NIF_TIP;
    nim.hIcon = hIcon;
    nim.uID = uId;
    nim.uCallbackMessage = uId;
    nim.dwState = dwstate;
    nim.dwStateMask = NIS_HIDDEN;
    nim.hWnd = m_hWnd;
    nim.uVersion = NOTIFYICON_VERSION;
    if (szTip)
        StringCchCopy(nim.szTip, _countof(nim.szTip), szTip);
    else
        nim.szTip[0] = 0;
    BOOL ret = Shell_NotifyIcon(code, &nim);
    return ret ? S_OK : E_FAIL;
}

ProcessIconMessage()

HRESULT CSysTray::ProcessIconMessage ( UINT  uMsg, WPARAM  wParam, LPARAM  lParam, LRESULT &  lResult  )

private

Definition at line 171 of file csystray.cpp.

{
    for (int i = 0; i < g_NumIcons; i++)
    {
        HRESULT hr = g_IconHandlers[i].pfnMessage(this, uMsg, wParam, lParam, lResult);
        if (FAILED(hr))
            return hr;

        if (hr == S_OK)
            return hr;
    }

    // Not handled by anyone, so return accordingly.
    return S_FALSE;
}

Referenced by ProcessWindowMessage().

ProcessWindowMessage()

BOOL CSysTray::ProcessWindowMessage ( HWND  hWnd, UINT  uMsg, WPARAM  wParam, LPARAM  lParam, LRESULT &  lResult, DWORD  dwMsgMapID = 0  )

protected

Definition at line 315 of file csystray.cpp.

{
    HRESULT hr;

    if (hWnd != m_hWnd)
        return FALSE;

    if (wm_DESTROYWINDOW && uMsg == wm_DESTROYWINDOW)
    {
        return DestroyWindow();
    }

    if (wm_SHELLHOOK && uMsg == wm_SHELLHOOK)
    {
        if (wParam == HSHELL_ACCESSIBILITYSTATE && lParam == ACCESS_MOUSEKEYS)
        {
            MouseKeys_Update(this);
        }
        lResult = 0L;
        return TRUE;
    }

    switch (uMsg)
    {
    case WM_NCCREATE:
    case WM_NCDESTROY:
        return FALSE;

    case WM_CREATE:
        GetServicesEnabled();
        InitIcons();
        SetTimer(1, 2000, NULL);
        RegisterShellHookWindow(hWnd);
        return TRUE;

    case WM_TIMER:
        if (wParam == 1)
            UpdateIcons();
        else
            ProcessIconMessage(uMsg, wParam, lParam, lResult);
        return TRUE;

    case WM_SETTINGCHANGE:
        if (wParam == SPI_SETMOUSEKEYS)
        {
            MouseKeys_Update(this);
        }
        break;

    case WM_DESTROY:
        KillTimer(1);
        DeregisterShellHookWindow(hWnd);
        ShutdownIcons();
        PostQuitMessage(0);
        return TRUE;
    }

    TRACE("SysTray message received %u (%08p %08p)\n", uMsg, wParam, lParam);

    hr = ProcessIconMessage(uMsg, wParam, lParam, lResult);
    if (FAILED(hr))
        return FALSE;

    return (hr == S_OK);
}

QueryStatus()

HRESULT STDMETHODCALLTYPE CSysTray::QueryStatus ( const GUID *  pguidCmdGroup, ULONG  cCmds, OLECMD  prgCmds[], OLECMDTEXT *  pCmdText  )

virtual

Implements IOleCommandTarget.

Definition at line 294 of file csystray.cpp.

{
    UNIMPLEMENTED;
    return S_OK;
}

s_SysTrayThreadProc()

DWORD WINAPI CSysTray::s_SysTrayThreadProc ( PVOID  param )

staticprivate

Definition at line 230 of file csystray.cpp.

{
    CSysTray * st = (CSysTray*) param;
    return st->SysTrayThreadProc();
}

Referenced by CreateSysTrayThread().

ShutdownIcons()

HRESULT CSysTray::ShutdownIcons ( )

private

Definition at line 137 of file csystray.cpp.

{
    TRACE("Shutting down Notification icons...\n");
    for (int i = 0; i < g_NumIcons; i++)
    {
        if (this->dwServicesEnabled & g_IconHandlers[i].dwServiceFlag)
        {
            this->dwServicesEnabled &= ~g_IconHandlers[i].dwServiceFlag;
            HRESULT hr = g_IconHandlers[i].pfnShutdown(this);
            FAILED_UNEXPECTEDLY(hr);
        }
    }

    MouseKeys_Shutdown(this);

    return ShutdownNetShell();
}

Referenced by ProcessWindowMessage().

ShutdownNetShell()

HRESULT CSysTray::ShutdownNetShell ( )

private

Definition at line 108 of file csystray.cpp.

{
    if (!pctNetShell)
        return S_FALSE;
    HRESULT hr = pctNetShell->Exec(&CGID_ShellServiceObject,
                                   OLECMDID_SAVE,
                                   OLECMDEXECOPT_DODEFAULT, NULL, NULL);
    pctNetShell.Release();
    return hr;
}

Referenced by ShutdownIcons().

SysTrayMessageLoop()

HRESULT CSysTray::SysTrayMessageLoop ( )

private

Definition at line 236 of file csystray.cpp.

{
    BOOL ret;
    MSG msg;

    while ((ret = GetMessage(&msg, NULL, 0, 0)) != 0)
    {
        if (ret < 0)
            break;

        TranslateMessage(&msg);
        DispatchMessage(&msg);
    }

    return S_OK;
}

Referenced by SysTrayThreadProc().

SysTrayThreadProc()

HRESULT CSysTray::SysTrayThreadProc ( )

private

Definition at line 253 of file csystray.cpp.

{
    WCHAR strFileName[MAX_PATH];
    GetModuleFileNameW(g_hInstance, strFileName, MAX_PATH);
    HMODULE hLib = LoadLibraryW(strFileName);

    CoInitializeEx(NULL, COINIT_DISABLE_OLE1DDE | COINIT_APARTMENTTHREADED);

    Create(NULL);

    HRESULT ret = SysTrayMessageLoop();

    CoUninitialize();

    Release();
    FreeLibraryAndExitThread(hLib, ret);
}

Referenced by s_SysTrayThreadProc().

UpdateIcons()

HRESULT CSysTray::UpdateIcons ( )

private

Definition at line 155 of file csystray.cpp.

{
    TRACE("Updating Notification icons...\n");
    for (int i = 0; i < g_NumIcons; i++)
    {
        if (this->dwServicesEnabled & g_IconHandlers[i].dwServiceFlag)
        {
            HRESULT hr = g_IconHandlers[i].pfnUpdate(this);
            if (FAILED(hr))
                return hr;
        }
    }

    return S_OK;
}

Referenced by ProcessWindowMessage().

Member Data Documentation

dwServicesEnabled

DWORD CSysTray::dwServicesEnabled

private

Definition at line 31 of file csystray.h.

Referenced by EnableService(), GetServicesEnabled(), InitIcons(), IsServiceEnabled(), ShutdownIcons(), and UpdateIcons().

pctNetShell

CComPtr<IOleCommandTarget> CSysTray::pctNetShell

private

Definition at line 27 of file csystray.h.

Referenced by InitNetShell(), and ShutdownNetShell().

wm_DESTROYWINDOW

UINT CSysTray::wm_DESTROYWINDOW

private

Definition at line 33 of file csystray.h.

Referenced by CSysTray(), DestroySysTrayWindow(), and ProcessWindowMessage().

wm_SHELLHOOK

UINT CSysTray::wm_SHELLHOOK

private

Definition at line 32 of file csystray.h.

Referenced by CSysTray(), and ProcessWindowMessage().

---

The documentation for this class was generated from the following files:

• dll/shellext/stobject/csystray.h
• dll/shellext/stobject/csystray.cpp