Content

ITrayIcon

Describes minimum required functionality from TrayIcon component.

You can find more information in comments below. Overrided methods can be found in corresponding base interface.

class ITrayIcon :public virtual IComponent
{
public:
    // Keyboard input events 
    void(*OnKeyDown)(ITrayIcon *sender, const MessageKey &m); // Event called when tray icon is focused and key is down 
    void(*OnKeyUp)(ITrayIcon *sender, const MessageKey &m); // Event called when tray icon is focused and key is up 
    void(*OnChar)(ITrayIcon *sender, const MessageChar &m); // Event called when tray icon is focused and char translated 
    void(*OnDeadChar)(ITrayIcon *sender, const MessageChar &m); // Event called when tray icon is focused and dead char translated 

    // Mouse input events 
    void(*OnMouseMove)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and mouse moves 
    void(*OnLeftMouseButtonDown)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and left mouse button down 
    void(*OnLeftMouseButtonUp)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and left mouse button up 
    void(*OnLeftMouseButtonDoubleClick)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and left mouse button double clicked 
    void(*OnRightMouseButtonDown)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and right mouse button down 
    void(*OnRightMouseButtonUp)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and right mouse button up 
    void(*OnRightMouseButtonDoubleClick)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and right mouse mutton double clicked 
    void(*OnMiddleMouseButtonDown)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and middle mouse button down 
    void(*OnMiddleMouseButtonUp)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and middle mouse button up 
    void(*OnMiddleMouseButtonDoubleClick)(ITrayIcon *sender, const MessagePosition &m); // Event called when tray icon is under mouse pointer and middle mouse button double clicked 

    // Notification events 
    void(*OnNotificationShow)(ITrayIcon *sender); // Event called when notification is shown 
    void(*OnNotificationHide)(ITrayIcon *sender); // Event called when notification is hidden(programmatically) 
    void(*OnNotificationTimeout)(ITrayIcon *sender); // Event called when notification is hidden due to timeout 
    void(*OnNotificationClick)(ITrayIcon *sender); // Event called when user clicks on notification 

    // Popup events 
    void(*OnPopupOpen)(ITrayIcon *sender); // Event called when popup opens 
    void(*OnPopupClose)(ITrayIcon *sender); // Event called when popup closes 

    virtual String getTip() = 0; // Return tip 
    virtual Image *getIcon() = 0; // Return icon 
    virtual String getTitle() = 0; // Return notification title 
    virtual String getMessage() = 0; // Return notification message 

    virtual bool setTip(const String &value) = 0; // Set tip 
    virtual bool setTitle(const String &value) = 0; // Set notification title 
    virtual bool setMessage(const String &value) = 0; // Set notification message 

    virtual bool ShowNotification() = 0; // Show notification. Allowed only when icon is added into tray 
    virtual bool HideNotification() = 0; // Hide shown notification 
    virtual void Update() = 0; // Should be called after updating icon 
};