VCF::SystemTray Class Reference

The SystemTray component provides a simple wrapper around system tray functionality. More...

#include <vcf/ApplicationKit/SystemTray.h>

Inheritance diagram for VCF::SystemTray:


Public Types
enum	SysTrayEvents { stHidden = 20031, stShown, stRemovedFromTray, stAddedToTray }
Public Member Functions
	SystemTray ()
	SystemTray (Component *owner)
void	setIconImage (Image *image)
	Sets the icon image for the system tray.
void	setPopupMenu (PopupMenu *popupMenu)
PopupMenu *	getPopupMenu ()
void	setTooltipText (const String &tooltipText)
String	getTooltipText ()
void	addToTray ()
void	removeFromTray ()
void	showInTray ()
void	hideFromTray ()
Public Attributes
VCF::Delegate	TrayIconChanged
Protected Member Functions
virtual void	destroy ()
	called by the free() method.
Protected Attributes
String	tooltipText_
PopupMenu *	popupMenu_
SystemTrayPeer *	peer_

Detailed Description

The SystemTray component provides a simple wrapper around system tray functionality.

On Win32 the system tray is the rectangular area on the lower right side of the Start bar. It contains various icons that represent some program. You can control the image used for your icon, as well as the tooltip associated with it. You can also add a popup menu that is associated with clicking on the icon.

Event Delegates for this class:

SystemTray::TrayIconChanged

Member Enumeration Documentation

enum VCF::SystemTray::SysTrayEvents

Enumerator:

stHidden

stShown

stRemovedFromTray

stAddedToTray

Constructor & Destructor Documentation

VCF::SystemTray::SystemTray ( )

VCF::SystemTray::SystemTray ( Component * owner )

Member Function Documentation

void VCF::SystemTray::addToTray ( )

virtual void VCF::SystemTray::destroy ( ) [protected, virtual]

called by the free() method.
Should be overriden and any clean up code performed here
Reimplemented from VCF::Component.