ToolTip QML Type

Stellt Tooltips für jedes Steuerelement bereit. Mehr...

• Liste aller Elemente, einschließlich geerbter Elemente

Eigenschaften

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

Zugehörige Eigenschaften

• delay : int
• policy : enumeration (since 6.12)
• text : string
• timeout : int
• toolTip : ToolTip
• visible : bool

Methoden

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

Beigefügte Methoden

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

Ausführliche Beschreibung

Ein Tooltip ist ein kurzer Text, der den Benutzer über die Funktion eines Steuerelements informiert. Er wird in der Regel oberhalb oder unterhalb des übergeordneten Steuerelements platziert. Der Tooltip-Text kann eine beliebige, als Rich Text formatierte Zeichenfolge sein.

Angehängte Tooltips

Die einfachste Möglichkeit, Tooltips für Steuerelemente einzurichten, besteht darin, die Eigenschaften „ text “ und „ visibility “ über angehängte Eigenschaften festzulegen. Das folgende Beispiel veranschaulicht diesen Ansatz:

Button {
    text: qsTr("Save")

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

Unter normalen Umständen ist jeweils nur ein Tooltip sichtbar. Um Ressourcen zu sparen, nutzen alle Elemente, die die angehängte Eigenschaft „ToolTip“ verwenden, dieselbe visuelle Tooltip-Label-Instanz. Auch wenn die visuellen Elemente gemeinsam genutzt werden, werden „ text “, „ timeout “ und „ delay “ für jedes Element, das die jeweilige angehängte Eigenschaft verwendet, individuell gespeichert. Es ist jedoch nicht möglich, dass mehrere Elemente den gemeinsam genutzten Tooltip gleichzeitig sichtbar machen. Der gemeinsam genutzte Tooltip wird nur für das letzte Element angezeigt, das ihn sichtbar gemacht hat. Die Position des gemeinsam genutzten Tooltips wird vom Framework festgelegt.

Verzögerung und Zeitlimit

Tooltips sind in der Regel vorübergehend, da sie als Reaktion auf ein bestimmtes externes Ereignis oder eine Benutzerinteraktion angezeigt werden und sich normalerweise nach einer bestimmten Zeit ausblenden. Es ist möglich, die Verzögerung bis zur Anzeige eines Tooltips sowie die Zeit bis zu dessen Ausblendung zu steuern. Dadurch lassen sich verschiedene Strategien zum Ein- und Ausblenden von Tooltips umsetzen.

Auf Touchscreens ist es beispielsweise üblich, einen Tooltip anzuzeigen, wenn eine Schaltfläche gedrückt und gehalten wird. Das folgende Beispiel zeigt, wie die Anzeige eines Tooltips verzögert werden kann, bis die Dauer des Gedrückthaltens erreicht ist. In diesem Beispiel wird der Tooltip ausgeblendet, sobald die Schaltfläche losgelassen wird.

Button {
    text: qsTr("Button")

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

Bei Zeigegeräten kann es jedoch wünschenswert sein, einen Tooltip anzuzeigen, wenn der Mauszeiger eine Weile über einer Schaltfläche verweilt. Das folgende Beispiel zeigt, wie ein Tooltip angezeigt wird, nachdem der Mauszeiger eine Sekunde lang über einer Schaltfläche verweilt hat, und wie er nach einer Zeitüberschreitung von fünf Sekunden ausgeblendet wird.

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.")
}

Benutzerdefinierte Tooltips

Sollte eine feinere Steuerung der Tooltip-Position erforderlich sein oder sollten mehrere Tooltip-Instanzen gleichzeitig benötigt werden, ist es auch möglich, lokale Tooltip-Instanzen zu erstellen. Auf diese Weise lässt sich der Tooltip individuell anpassen, und die gesamte „ Popup “-API steht zur Verfügung. Das folgende Beispiel zeigt einen Tooltip, der den Wert eines Schiebereglers anzeigt, wenn der Schieberegler gezogen wird.

Slider {
    id: slider
    value: 0.5

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

Siehe auch „Anpassen von Tooltips“, „Popup-Steuerelemente“ und „ closePolicy “.

Dokumentation zu den Eigenschaften

delay : int

Diese Eigenschaft legt die Verzögerung (in Millisekunden) fest, nach der der Tooltip angezeigt wird. Ein Tooltip mit einer negativen Verzögerung wird sofort angezeigt. Der Standardwert ist „ 0 “.

Siehe auch „ Delay and Timeout “.

text : string

Diese Eigenschaft enthält den Text, der im Tooltip angezeigt wird.

timeout : int

Diese Eigenschaft legt die Zeit (in Millisekunden) fest, nach deren Ablauf der Tooltip ausgeblendet wird. Ein Tooltip mit einem negativen Zeitwert wird nicht automatisch ausgeblendet. Der Standardwert lautet „ -1 “.

Siehe auch „ Delay and Timeout “.

Dokumentation zu den angehängten Eigenschaften

ToolTip.delay : int [attached]

Diese angehängte Eigenschaft enthält die Verzögerung (in Millisekunden) des gemeinsamen Tooltips. Die Eigenschaft kann an jedes Element angehängt werden.

Der Standardwert lautet „ 0 “, wenn „ policy “ auf „ ToolTip.Manual “ gesetzt ist; andernfalls lautet er „ QStyleHints::toolTipWakeUpDelay()“.

Siehe auch „ Attached Tool Tips “ und „ Delay and Timeout “.

ToolTip.policy : enumeration [attached, since 6.12]

Diese zugeordnete Eigenschaft steuert, ob die Sichtbarkeit des „ shared tool tip instance “ automatisch geregelt wird. Sie wirkt sich nur auf Elemente aus, für die „ ToolTip.visible “ nicht festgelegt wurde. Nur Elemente, für die „ ToolTip.text “ festgelegt ist, werden sichtbar gemacht. Sie wirkt sich nur auf die folgenden Elemente und deren abgeleitete Typen aus: „ Control “, „ TextArea “ und „ TextField “. Bei allen anderen Typen muss „ visible “ manuell festgelegt werden.

Außerdem legt es die Standardwerte für die Eigenschaften „delay“ und „timeout“ der gemeinsam genutzten Tooltip-Instanz fest (unabhängig davon, ob „ ToolTip.visible “ oder „ ToolTip.text “ gesetzt wurde).

Diese Eigenschaft wird an angehängte untergeordnete „ ToolTip “-Elemente weitergegeben.

Mögliche Werte:

Der Standardwert ist ` ToolTip.Automatic`.

Die Eigenschaft bietet eine Möglichkeit, die in Qt 6.12 eingeführten Standardwerte für gemeinsame Tooltips zu umgehen. Dies ist insbesondere für Legacy-Code relevant, der die Eigenschaft „visible“ nicht explizit setzt, bevor mit einem Element interagiert wird. Für Anwendungen, die die Eigenschaft „visible“ deklarativ festlegen und die neuen Standardwerte für „delay“ und „timeout“ als akzeptabel erachten, ist „ policy “ nicht erforderlich.

Diese Eigenschaft wurde in Qt 6.12 eingeführt.

Siehe auch „ Attached Tool Tips “.

ToolTip.text : string [attached]

Diese angehängte Eigenschaft enthält den Text des gemeinsamen Tooltips. Die Eigenschaft kann an jedes Element angehängt werden.

Siehe auch Attached Tool Tips.

ToolTip.timeout : int [attached]

Diese angehängte Eigenschaft enthält die Zeitüberschreitung (in Millisekunden) des gemeinsamen Tooltips. Die Eigenschaft kann an jedes Element angehängt werden.

Der Standardwert richtet sich nach der Länge des Textes und beträgt immer mindestens 10 Sekunden.

Siehe auch Attached Tool Tips und Delay and Timeout.

ToolTip.toolTip : ToolTip [attached]

Diese angehängte Eigenschaft enthält die Instanz des gemeinsamen Tooltips. Die Eigenschaft kann an jedes beliebige Element angehängt werden.

Siehe auch Attached Tool Tips.

ToolTip.visible : bool [attached]

Diese angehängte Eigenschaft gibt an, ob der gemeinsame Tooltip sichtbar ist. Die Eigenschaft kann an jedes Element angehängt werden.

Siehe auch „ Attached Tool Tips “.

Methodendokumentation

[since QtQuick.Controls 2.5 (Qt 5.12)] void hide()

Diese Methode blendet den Tooltip aus.

Diese Methode wurde in QtQuick.Controls 2.5 (Qt 5.12) eingeführt.

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

Diese Methode zeigt die „ text “ als Tooltip an, der nach timeout (Millisekunden) ausgeblendet wird.

Diese Methode wurde in QtQuick.Controls 2.5 (Qt 5.12) eingeführt.

Beigefügte Methodendokumentation

[attached] void hide()

Diese angehängte Methode blendet den gemeinsamen Tooltip aus. Die Methode kann an jedes beliebige Element angehängt werden.

Siehe auch Attached Tool Tips.

[attached] void show(string text, int timeout = -1)

Die beigefügte Methode zeigt den gemeinsamen Tooltip mit „ text “ und „ timeout “ (Millisekunden) an. Die Methode kann an jedes beliebige Element angehängt werden.

Siehe auch Attached Tool Tips.