X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..b09857ae000a60704207d63290be937584805fb0:/interface/wx/tooltip.h?ds=sidebyside diff --git a/interface/wx/tooltip.h b/interface/wx/tooltip.h index 6d6779198a..bb255cd08b 100644 --- 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);