Document wxBK_HITTEST_XXX values.

[wxWidgets.git] / interface / wx / tooltip.h

diff --git a/interface/wx/tooltip.h b/interface/wx/tooltip.h
index 6d6779198ac9e939e748853c3c0157c9cbe906c7..bb255cd08b60c3af5a383f3dfa0f8c9600835d52 100644 (file)
--- a/interface/wx/tooltip.h
+++ b/interface/wx/tooltip.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxToolTip
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxToolTip
-    @wxheader{tooltip.h}
 
     This class holds information about a tooltip associated with a window (see
     wxWindow::SetToolTip()).
@@ -49,7 +48,7 @@ public:
         Set the delay after which the tooltip disappears or how long a tooltip
         remains visible.
 
-        @note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
+        @note May not be supported on all platforms (eg. wxCocoa, GTK).
     */
     static void SetAutoPop(long msecs);
 
@@ -60,10 +59,25 @@ public:
     */
     static void SetDelay(long msecs);
 
+    /**
+        Set tooltip maximal width in pixels.
+
+        By default, tooltips are wrapped at a suitably chosen width. You can
+        pass -1 as @a width to disable wrapping them completely, 0 to restore
+        the default behaviour or an arbitrary positive value to wrap them at
+        the given width.
+
+        Notice that this function does not change the width of the tooltips
+        created before calling it.
+
+        @note Currently this function is wxMSW-only.
+    */
+    static void SetMaxWidth(int width);
+
     /**
         Set the delay between subsequent tooltips to appear.
 
-        @note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
+        @note May not be supported on all platforms (eg. wxCocoa, GTK).
     */
     static void SetReshow(long msecs);