[haiku-commits] haiku: hrev48594 - docs/user/interface
- From: jscipione@xxxxxxxxx
- To: haiku-commits@xxxxxxxxxxxxx
- Date: Sat, 3 Jan 2015 00:16:41 +0100 (CET)
hrev48594 adds 1 changeset to branch 'master'
old head: 985d0a7b8a15e5b63ed522f5c4b6251832f6f938
new head: 4536c6033b1d74b169191300fbce2f1334ae09ad
overview: http://cgit.haiku-os.org/haiku/log/?qt=range&q=4536c60+%5E985d0a7
----------------------------------------------------------------------------
4536c60: Update BToolTip class docs, added credit.
with remarks from Axel and PulkoMandy, thanks guys.
[ John Scipione <jscipione@xxxxxxxxx> ]
----------------------------------------------------------------------------
Revision: hrev48594
Commit: 4536c6033b1d74b169191300fbce2f1334ae09ad
URL: http://cgit.haiku-os.org/haiku/commit/?id=4536c60
Author: John Scipione <jscipione@xxxxxxxxx>
Date: Fri Jan 2 23:15:25 2015 UTC
----------------------------------------------------------------------------
1 file changed, 19 insertions(+), 5 deletions(-)
docs/user/interface/ToolTip.dox | 24 +++++++++++++++++++-----
----------------------------------------------------------------------------
diff --git a/docs/user/interface/ToolTip.dox b/docs/user/interface/ToolTip.dox
index 180ee11..e64f54b 100644
--- a/docs/user/interface/ToolTip.dox
+++ b/docs/user/interface/ToolTip.dox
@@ -3,6 +3,8 @@
* Distributed under the terms of the MIT License.
*
* Authors:
+ * Adrien Destugues, pulkomandy@xxxxxxxxxxxxxxxxx
+ * Axel Dörfler, axeld@xxxxxxxxxxxxxxxx
* John Scipione, jscipione@xxxxxxxxx
*
* Corresponds to:
@@ -25,9 +27,13 @@
\ingroup libbe
\brief Displays help text on hover.
- \attention Use at your own risk! This class is private and may change
before release.
+ \attention Use at your own risk! This class is private and may change
+ before release.
- \since Haiku R1A3
+ This class is for advanced uses of tool tips with custom contents or
+ behavior. The simple way to use tooltips is via BView::SetToolTip().
+
+ \since Haiku R1
*/
@@ -75,7 +81,8 @@
/*!
\fn void BToolTip::SetSticky(bool enable)
- \brief Turns sticky flag on and off.
+ \brief Turns sticky flag on or off which determines whether or not the
+ tool tip stays visible when the mouse moves.
\since Haiku R1
*/
@@ -93,6 +100,11 @@
\fn void BToolTip::SetMouseRelativeLocation(BPoint location)
\brief Set the location of the tooltip relative to the current mouse
position.
+ The position is relative to the mouse cursor location at the time the
+ tool tip is shown. It should be as close as possible to the mouse cursor
+ without hiding important parts of the UI near the cursor while the
parent
+ view remains visible and reachable.
+
\since Haiku R1
*/
@@ -107,7 +119,9 @@
/*!
\fn void BToolTip::SetAlignment(BAlignment alignment)
- \brief Set the alignment of the tool tip.
+ \brief Set the alignment of the tool tip which determines where the tool
+ tip should appear i.e. left or right from the current mouse
cursor
+ position, etc.
\since Haiku R1
*/
@@ -123,7 +137,7 @@
/*!
\fn bool BToolTip::Lock()
- \brief Allows derived classes to lock the tool tip while changing it.
+ \brief Allows derived classes to lock the tool tip while modifying it.
\since Haiku R1
*/
Other related posts:
- » [haiku-commits] haiku: hrev48594 - docs/user/interface - jscipione
