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 6c297edf07dfa5d34c0886fe66d862d84baf3e93..629b5407630320f1a95d07050e7ccff78104823b 100644 (file)
--- a/include/wx/msw/taskbar.h
+++ b/include/wx/msw/taskbar.h
@@ -33,6 +33,26 @@ public:
     bool RemoveIcon(void);
     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
+
 protected:
     friend class wxTaskBarIconWindow;