diff options
| author | J-P Nurmi <jpnurmi@qt.io> | 2016-10-31 12:41:04 +0100 |
|---|---|---|
| committer | J-P Nurmi <jpnurmi@qt.io> | 2016-10-31 12:11:08 +0000 |
| commit | 41c754db53f7139f351346f1659a28fa13d2eb08 (patch) | |
| tree | ee8b6d2a0af8a6120b3cae9630ec9f16ad40f384 /src/quicktemplates2/qquicktooltip.cpp | |
| parent | 45a4bafb2f0d7b177a1938f353af1ea103027c68 (diff) | |
Doc: add links to ToolTip attached properties and methods
Change-Id: Ia9edcf69ca4a36f9e50e03787fe82b79aca9d2a3
Task-number: QTBUG-55904
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/quicktemplates2/qquicktooltip.cpp')
| -rw-r--r-- | src/quicktemplates2/qquicktooltip.cpp | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/src/quicktemplates2/qquicktooltip.cpp b/src/quicktemplates2/qquicktooltip.cpp index a1601ad6..b29e806c 100644 --- a/src/quicktemplates2/qquicktooltip.cpp +++ b/src/quicktemplates2/qquicktooltip.cpp @@ -62,6 +62,8 @@ QT_BEGIN_NAMESPACE \image qtquickcontrols2-tooltip.png + \section2 Attached Tool Tips + The most straight-forward way to setup tool tips for controls is to specify \l text and \l {visible}{visibility} via attached properties. The following example illustrates this approach: @@ -358,6 +360,8 @@ QQuickToolTipAttached::QQuickToolTipAttached(QObject *parent) : This attached property holds the text of the shared tool tip. The property can be attached to any item. + + \sa {Attached Tool Tips} */ QString QQuickToolTipAttached::text() const { @@ -384,7 +388,7 @@ void QQuickToolTipAttached::setText(const QString &text) This attached property holds the delay (milliseconds) of the shared tool tip. The property can be attached to any item. - \sa {Delay and Timeout} + \sa {Attached Tool Tips}, {Delay and Timeout} */ int QQuickToolTipAttached::delay() const { @@ -411,7 +415,7 @@ void QQuickToolTipAttached::setDelay(int delay) This attached property holds the timeout (milliseconds) of the shared tool tip. The property can be attached to any item. - \sa {Delay and Timeout} + \sa {Attached Tool Tips}, {Delay and Timeout} */ int QQuickToolTipAttached::timeout() const { @@ -437,6 +441,8 @@ void QQuickToolTipAttached::setTimeout(int timeout) This attached property holds whether the shared tool tip is visible. The property can be attached to any item. + + \sa {Attached Tool Tips} */ bool QQuickToolTipAttached::isVisible() const { @@ -462,6 +468,8 @@ void QQuickToolTipAttached::setVisible(bool visible) This attached property holds the shared tool tip instance. The property can be attached to any item. + + \sa {Attached Tool Tips} */ QQuickToolTip *QQuickToolTipAttached::toolTip() const { @@ -474,6 +482,8 @@ QQuickToolTip *QQuickToolTipAttached::toolTip() const This attached method shows the shared tooltip with \a text and \a timeout (milliseconds). The method can be attached to any item. + + \sa {Attached Tool Tips} */ void QQuickToolTipAttached::show(const QString &text, int ms) { @@ -495,6 +505,8 @@ void QQuickToolTipAttached::show(const QString &text, int ms) \qmlattachedmethod void QtQuick.Controls::ToolTip::hide() This attached method hides the shared tooltip. The method can be attached to any item. + + \sa {Attached Tool Tips} */ void QQuickToolTipAttached::hide() { |