Fix typo in wxStandardPathsBase::ResourceCat description and document it.

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

diff --git a/interface/wx/tooltip.h b/interface/wx/tooltip.h
index 4dc2a448fc6e33679b4f9c600e24107d445005ed..372b7941693b1055d6596e50f3f7b7fdd1fd9914 100644 (file)
--- a/interface/wx/tooltip.h
+++ b/interface/wx/tooltip.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxToolTip
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -59,6 +59,21 @@ 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.