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 9533b19bc492f38366aab9fef5193885516c7765..629b5407630320f1a95d07050e7ccff78104823b 100644 (file)
--- a/include/wx/msw/taskbar.h
+++ b/include/wx/msw/taskbar.h
@@ -10,44 +10,62 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////
 
-#ifndef _TASKBAR_H_
-#define _TASKBAR_H_
+#ifndef _WX_TASKBAR_H_
+#define _WX_TASKBAR_H_
 
 #include "wx/icon.h"
 
 // private helper class:
-class WXDLLIMPEXP_ADV wxTaskBarIconWindow;
+class WXDLLIMPEXP_FWD_ADV wxTaskBarIconWindow;
 
-class WXDLLIMPEXP_ADV wxTaskBarIcon: public wxTaskBarIconBase
+class WXDLLIMPEXP_ADV wxTaskBarIcon : public wxTaskBarIconBase
 {
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTaskBarIcon)
 public:
     wxTaskBarIcon();
     virtual ~wxTaskBarIcon();
 
-// Accessors
-    inline bool IsOk() const { return true; }
-    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);
+    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
 
-// Implementation
 protected:
     friend class wxTaskBarIconWindow;
+
     long WindowProc(unsigned int msg, unsigned int wParam, long lParam);
     void RegisterWindowMessages();
 
-// Data members
-protected:
+
     wxTaskBarIconWindow *m_win;
     bool                 m_iconAdded;
     wxIcon               m_icon;
     wxString             m_strTooltip;
 
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxTaskBarIcon)
 };
 
-#endif
-    // _TASKBAR_H_
+#endif // _WX_TASKBAR_H_