Click here to Skip to main content
Click here to Skip to main content
Go to top

WTL Tray Icon Template

, 4 Nov 2002
Rate this:
Please Sign up or sign in to vote.
A small template allowing you to easily add system tray icon support to your WTL application
<!-- Download Links --> <!-- Add the rest of your HTML here -->

Introduction

This is a small template that you can use to add system tray icon support to your WTL based application. A big nod in the direction of Chris Maunder is due, as back in my MFC days I used his excellent CSystemTray class, which was the inspiration for this WTL version (though his adds much more functionality).

This template can be used to add "default" tray icon behaviour to your application. A menu is displayed when you right-click the icon, and double-clicking the icon will execute the default menu item. Note that the first menu item will be used as the default, though you can change this by calling SetDefaultItem.

Using CTrayIconImpl

To use the CTrayIconImpl template, do the following:

Firts, include the header file:

#include "trayiconimpl"

Next. derive your main window class (usually CMainFrame for SDI/MDI apps, or CMainDlg for dialog-based apps) from CTrayIconImpl:

class CMainDlg :
    ...
    CTrayIconImpl<CMainDlg>

Next (and this is important) add a CHAIN_MSG_MAP entry to your windows message map (to ensure that the WM_TRAYICON message is processed correctly):

BEGIN_MSG_MAP(CMainDlg)
    ...
    CHAIN_MSG_MAP(CTrayIconImpl<CMainDlg>)
END_MSG_MAP()

To install an icon in the system tray, call InstallIcon from OnCreate (SDI/MDI apps) or OnInitDialog (dialog apps). Note that you supply three parameters to this call - the tooltip text, the icon handle and the resource ID of the popup menu to display when the tray icon is right-clicked.

// Load a small icon
HICON hIconSmall = (HICON)::LoadImage(_Module.GetResourceInstance(), 
                                      MAKEINTRESOURCE(IDR_MAINFRAME),
                                      IMAGE_ICON, 
                                      ::GetSystemMetrics(SM_CXSMICON), 
                                      ::GetSystemMetrics(SM_CYSMICON), 
                                      LR_DEFAULTCOLOR);
...
// Install tray icon
InstallIcon(_T("Tooltip text"), hIconSmall, IDR_POPUP);

Finally, add the necessary COMMAND_ID_HANDLERs for your popup menu commands. That's it!

Notes

Change the default menu item by calling SetDefaultItem:

// Double-clicking the tray icon will display the "About" box
SetDefaultItem(ID_APP_ABOUT);

Change the tooltip text by calling SetTooltipText.

SetTooltipText(_T("Yeeha!"));

Override the void PrepareMenu(HMENU hMenu) function in order to initialize the popup menu before it is displayed. For example, you may want to disable items, check items, etc. (see the WTLTrayIconWindow example for a demonstration).

void PrepareMenu(HMENU hMenu)
{
    CMenuHandle menu(hMenu);
    menu.EnableMenuItem(ID_TEST_DISABLED, MF_GRAYED);
    menu.CheckMenuItem(ID_TEST_CHECKED, MF_CHECKED);
}

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author


Comments and Discussions

 
GeneralOops. Multiple About boxes PinsussDrGary23-Nov-02 14:53 
In the example dialog application, if you hit the 'About...' button, the About dialog appears modally--you can't click any buttons in the main dialog until you close the About dialog. However, while the modal About dialog is shown, you can still access the tray icon popup menu. In fact, you can select 'About...' from the menu repeatedly and create multiple modal About dialogs.
 
As the original article above points out, you can disable items on the popup menu, so the problem can be fixed easily by disabling the 'About...' item when the About dialog is displayed.
 
But the popup menu still appears with other items during the modal About dialog. What's the proper interface guideline here? Should the Icon Tray menu be unavailable during a modal dialog? Should it appear, but with all of its items disabled?
 
Thanks for a nice piece of code, BTW.
 

 

GeneralRe: Oops. Multiple About boxes PinmemberRobert Edward Caldecott27-Nov-02 12:06 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140916.1 | Last Updated 5 Nov 2002
Article Copyright 2002 by Rob Caldecott
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid