X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c3b6f606364ae8bd86eeeb3e129636c5294ea85..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/richtooltip.h?ds=sidebyside diff --git a/interface/wx/richtooltip.h b/interface/wx/richtooltip.h index 6e0a014411..e88c5bbdca 100644 --- a/interface/wx/richtooltip.h +++ b/interface/wx/richtooltip.h @@ -3,7 +3,6 @@ // Purpose: wxRichToolTip class documentation // Author: Vadim Zeitlin // Created: 2011-10-18 -// RCS-ID: $Id$ // Copyright: (c) 2011 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -175,15 +174,22 @@ public: void SetTitleFont(const wxFont& font); /** - Show the tooltip for the given window. + Show the tooltip for the given window and optionally specify where to + show the tooltip. - The tooltip tip points to the (middle of the) specified window which - must be non-@NULL. + By default the tooltip tip points to the (middle of the) specified + window which must be non-@NULL or, if @a rect is non-@NULL, the middle + of the specified wxRect. + + The coordinates of the @a rect parameter are relative to the given window. Currently the native MSW implementation is used only if @a win is a - wxTextCtrl. This limitation may be removed in the future. + wxTextCtrl and @a rect is @NULL. This limitation may be removed in the + future. + + Parameter @a rect is new since wxWidgets 2.9.5. */ - void ShowFor(wxWindow* win); + void ShowFor(wxWindow* win, const wxRect* rect = NULL); /** Destructor.