document various enumerations defined in defs.h; give a name to the anonymous enum...

[wxWidgets.git] / include / wx / msw / taskbar.h

diff --git a/include/wx/msw/taskbar.h b/include/wx/msw/taskbar.h
index 36703ce96d686309d1277a9573a1f1332013b840..629b5407630320f1a95d07050e7ccff78104823b 100644 (file)
--- a/include/wx/msw/taskbar.h
+++ b/include/wx/msw/taskbar.h
@@ -1,66 +1,71 @@
 /////////////////////////////////////////////////////////////////////////
-// File:        taskbar.h
-// Purpose:        Defines wxTaskBarIcon class for manipulating icons on the
+// File:        wx/msw/taskbar.h
+// 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)
-// Licence:    wxWindows licence
+// 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/list.h>
-#include <wx/icon.h>
+// private helper class:
+class WXDLLIMPEXP_FWD_ADV wxTaskBarIconWindow;
 
-class wxTaskBarIcon: public wxObject
+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
-    bool SetIcon(const wxIcon& icon, const wxString& tooltip = "");
+    // Operations
+    bool SetIcon(const wxIcon& icon, const wxString& tooltip = wxEmptyString);
     bool RemoveIcon(void);
+    bool PopupMenu(wxMenu *menu);
 
-// Overridables
-    virtual void OnMouseMove(void);
-    virtual void OnLButtonDown(void);
-    virtual void OnLButtonUp(void);
-    virtual void OnRButtonDown(void);
-    virtual void OnRButtonUp(void);
-    virtual void OnLButtonDClick(void);
-    virtual void OnRButtonDClick(void);
+    // MSW-specific class methods
 
-// 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 );
+#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;
+
+    long WindowProc(unsigned int msg, unsigned int wParam, long lParam);
+    void RegisterWindowMessages();
+
 
-#endif
-    // _TASKBAR_H_
+    wxTaskBarIconWindow *m_win;
+    bool                 m_iconAdded;
+    wxIcon               m_icon;
+    wxString             m_strTooltip;
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTaskBarIcon)
+};
 
+#endif // _WX_TASKBAR_H_