]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/taskbar.h
fix memory leak of FrameSite (see #3935)
[wxWidgets.git] / include / wx / msw / taskbar.h
index 2da54b68940706d39cde46c73b7792441df17e57..629b5407630320f1a95d07050e7ccff78104823b 100644 (file)
 // Purpose:     Defines wxTaskBarIcon class for manipulating icons on the
 //              Windows task bar.
 // Author:      Julian Smart
-// Modified by:
+// Modified by: Vaclav Slavik
 // Created:     24/3/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////
 
-#ifndef _TASKBAR_H_
-#define _TASKBAR_H_
+#ifndef _WX_TASKBAR_H_
+#define _WX_TASKBAR_H_
 
-#ifdef __GNUG__
-#pragma interface "taskbar.h"
-#endif
+#include "wx/icon.h"
 
-#include <wx/event.h>
-#include <wx/list.h>
-#include <wx/icon.h>
+// private helper class:
+class WXDLLIMPEXP_FWD_ADV wxTaskBarIconWindow;
 
-class WXDLLEXPORT wxTaskBarIcon: public wxEvtHandler {
-    DECLARE_DYNAMIC_CLASS(wxTaskBarIcon)
+class WXDLLIMPEXP_ADV wxTaskBarIcon : public wxTaskBarIconBase
+{
 public:
-    wxTaskBarIcon(void);
-    virtual ~wxTaskBarIcon(void);
+    wxTaskBarIcon();
+    virtual ~wxTaskBarIcon();
 
-// Accessors
-    inline WXHWND GetHWND() const { return m_hWnd; }
-    inline bool IsOK() const { return (m_hWnd != 0) ; }
-    inline bool IsIconInstalled() const { return m_iconAdded; }
+    // Accessors
+    bool IsOk() const { return true; }
+    bool IsIconInstalled() const { return m_iconAdded; }
 
-// Operations
+    // Operations
     bool SetIcon(const wxIcon& icon, const wxString& tooltip = wxEmptyString);
     bool RemoveIcon(void);
-    bool PopupMenu(wxMenu *menu); //, int x, int y);
-
-// Overridables
-    virtual void OnMouseMove(wxEvent&);
-    virtual void OnLButtonDown(wxEvent&);
-    virtual void OnLButtonUp(wxEvent&);
-    virtual void OnRButtonDown(wxEvent&);
-    virtual void OnRButtonUp(wxEvent&);
-    virtual void OnLButtonDClick(wxEvent&);
-    virtual void OnRButtonDClick(wxEvent&);
-
-// Implementation
-    static wxTaskBarIcon* FindObjectForHWND(WXHWND hWnd);
-    static void AddObject(wxTaskBarIcon* obj);
-    static void RemoveObject(wxTaskBarIcon* obj);
-    static bool RegisterWindowClass();
-    static WXHWND CreateTaskBarWindow();
-    long WindowProc( WXHWND hWnd, unsigned int msg, unsigned int wParam, long lParam );
+    bool PopupMenu(wxMenu *menu);
+
+    // MSW-specific class methods
+
+#if wxUSE_TASKBARICON_BALLOONS
+    // show a balloon notification (the icon must have been already initialized
+    // using SetIcon)
+    //
+    // title and text are limited to 63 and 255 characters respectively, msec
+    // is the timeout, in milliseconds, before the balloon disappears (will be
+    // clamped down to the allowed 10-30s range by Windows if it's outside it)
+    // and flags can include wxICON_ERROR/INFO/WARNING to show a corresponding
+    // icon
+    //
+    // return true if balloon was shown, false on error (incorrect parameters
+    // or function unsupported by OS)
+    bool ShowBalloon(const wxString& title,
+                     const wxString& text,
+                     unsigned msec = 0,
+                     int flags = 0);
+#endif // wxUSE_TASKBARICON_BALLOONS
 
-// Data members
 protected:
-    WXHWND          m_hWnd;
-    bool            m_iconAdded;
-    static wxList   sm_taskBarIcons;
-    static bool     sm_registeredClass;
-    static unsigned int sm_taskbarMsg;
+    friend class wxTaskBarIconWindow;
 
-    // non-virtual default event handlers to forward events to the virtuals
-    void _OnMouseMove(wxEvent&);
-    void _OnLButtonDown(wxEvent&);
-    void _OnLButtonUp(wxEvent&);
-    void _OnRButtonDown(wxEvent&);
-    void _OnRButtonUp(wxEvent&);
-    void _OnLButtonDClick(wxEvent&);
-    void _OnRButtonDClick(wxEvent&);
+    long WindowProc(unsigned int msg, unsigned int wParam, long lParam);
+    void RegisterWindowMessages();
 
 
-    DECLARE_EVENT_TABLE()
-};
-
-
-// ----------------------------------------------------------------------------
-// wxTaskBarIcon events
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxTaskBarIconEvent : public wxEvent
-{
-public:
-    wxTaskBarIconEvent(wxEventType evtType, wxTaskBarIcon *tbIcon)
-        : wxEvent(-1, evtType)
-        {
-            SetEventObject(tbIcon);
-        }
+    wxTaskBarIconWindow *m_win;
+    bool                 m_iconAdded;
+    wxIcon               m_icon;
+    wxString             m_strTooltip;
 
-    virtual wxEvent *Clone() const { return new wxTaskBarIconEvent(*this); }
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTaskBarIcon)
 };
 
-BEGIN_DECLARE_EVENT_TYPES()
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_MOVE, 1550 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_DOWN, 1551 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_UP, 1552 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_DOWN, 1553 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_UP, 1554 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_LEFT_DCLICK, 1555 )
-DECLARE_EVENT_TYPE( wxEVT_TASKBAR_RIGHT_DCLICK, 1556 )
-END_DECLARE_EVENT_TYPES()
-
-#define EVT_TASKBAR_MOVE(fn)         DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_MOVE, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_DOWN(fn)    DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_UP(fn)      DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_DOWN(fn)   DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_UP(fn)     DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_UP, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_LEFT_DCLICK(fn)  DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-#define EVT_TASKBAR_RIGHT_DCLICK(fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_TASKBAR_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) &fn, NULL),
-
-
-#endif
-    // _TASKBAR_H_
-
-
-
-
-
+#endif // _WX_TASKBAR_H_