// Name: tooltip.h
// 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()).
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);
*/
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);