Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
interface/tipwin.h
View File

@@ -28,41 +28,36 @@ public:
Constructor. The tip is shown immediately after the window is constructed.
@param parent
The parent window, must be non-@NULL
The parent window, must be non-@NULL
@param text
The text to show, may contain the new line characters
The text to show, may contain the new line characters
@param maxLength
The length of each line, in pixels. Set to a very large
value to avoid wrapping lines
The length of each line, in pixels. Set to a very large
value to avoid wrapping lines
@param windowPtr
Simply passed to
SetTipWindowPtr below, please see its
documentation for the description of this parameter
Simply passed to
SetTipWindowPtr below, please see its
documentation for the description of this parameter
@param rectBounds
If non-@NULL, passed to
SetBoundingRect below, please see its
documentation for the description of this parameter
If non-@NULL, passed to
SetBoundingRect below, please see its
documentation for the description of this parameter
*/
wxTipWindow(wxWindow* parent, const wxString& text,
wxCoord maxLength = 100,
wxTipWindow** windowPtr,
wxRect * rectBounds = @NULL);
wxRect* rectBounds = NULL);
/**
By default, the tip window disappears when the user clicks the mouse or presses
a keyboard key or if it loses focus in any other way - for example because the
user switched to another application window.
Additionally, if a non-empty @e rectBound is provided, the tip window will
Additionally, if a non-empty @a rectBound is provided, the tip window will
also automatically close if the mouse leaves this area. This is useful to
dismiss the tip mouse when the mouse leaves the object it is associated with.
@param rectBound
The bounding rectangle for the mouse in the screen coordinates
The bounding rectangle for the mouse in the screen coordinates
*/
void SetBoundingRect(const wxRect& rectBound);