ToolTip QML Type

Provides tool tips for any control. More...

• List of all members, including inherited members

Properties

• delay : int
• text : string
• timeout : int

Attached Properties

• delay : int
• text : string
• timeout : int
• toolTip : ToolTip
• visible : bool

Methods

• void hide() (since QtQuick.Controls 2.5 (Qt 5.12))
• void show(string text, int timeout) (since QtQuick.Controls 2.5 (Qt 5.12))

Attached Methods

• void hide()
• void show(string text, int timeout)

Detailed Description

A tool tip is a short piece of text that informs the user of a control's function. It is typically placed above or below the parent control. The tip text can be any rich text formatted string.

Attached Tool Tips

The most straight-forward way to setup tool tips for controls is to specify text and visibility via attached properties. The following example illustrates this approach:

 Button {
     text: qsTr("Save")

     ToolTip.visible: down
     ToolTip.text: qsTr("Save the active project")
 }

Under normal circumstances, there is only one tool tip visible at a time. In order to save resources, all items that use the ToolTip attached property share the same visual tool tip label instance. Even though the visuals are shared, text, timeout and delay are stored individually for each item that uses the respective attached property. However, multiple items cannot make the shared tool tip visible at the same time. The shared tool tip is only shown for the last item that made it visible. The position of the shared tool tip is determined by the framework.

Delay and Timeout

Tool tips are typically transient in a sense that they are shown as a result of a certain external event or user interaction, and they usually hide after a certain timeout. It is possible to control the delay when a tool tip is shown, and the timeout when it is hidden. This makes it possible to implement varying strategies for showing and hiding tool tips.

For example, on touch screens, it is a common pattern to show a tool tip as a result of pressing and holding down a button. The following example demonstrates how to delay showing a tool tip until the press-and-hold interval is reached. In this example, the tool tip hides as soon as the button is released.

 Button {
     text: qsTr("Button")

     ToolTip.visible: pressed
     ToolTip.delay: Qt.styleHints.mousePressAndHoldInterval
     ToolTip.text: qsTr("This tool tip is shown after pressing and holding the button down.")
 }

With pointer devices, however, it might be desired to show a tool tip as a result of hovering a button for a while. The following example presents how to show a tool tip after hovering a button for a second, and hide it after a timeout of five seconds.

 Button {
     text: qsTr("Button")
     hoverEnabled: true

     ToolTip.delay: 1000
     ToolTip.timeout: 5000
     ToolTip.visible: hovered
     ToolTip.text: qsTr("This tool tip is shown after hovering the button for a second.")
 }

Custom Tool Tips

Should one need more fine-grained control over the tool tip position, or multiple simultaneous tool tip instances are needed, it is also possible to create local tool tip instances. This way, it is possible to customize the tool tip, and the whole Popup API is available. The following example presents a tool tip that presents the value of a slider when the handle is dragged.

 Slider {
     id: slider
     value: 0.5

     ToolTip {
         parent: slider.handle
         visible: slider.pressed
         text: slider.value.toFixed(1)
     }
 }

See also Customizing ToolTip, Popup Controls, and closePolicy.

Property Documentation

Attached Property Documentation

Method Documentation

Attached Method Documentation