ToolTip QML Type

Affiche des infobulles pour n'importe quel contrôle. En savoir plus...

• Liste de tous les membres, y compris les membres hérités

Propriétés

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

Propriétés associées

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

Méthodes

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

Méthodes jointes

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

Description détaillée

Une info-bulle est un court texte qui informe l'utilisateur de la fonction d'un contrôle. Elle est généralement placée au-dessus ou en dessous du contrôle parent. Le texte de l'info-bulle peut être n'importe quelle chaîne de caractères au format RTF.

Infobulles associées

La manière la plus simple de configurer des info-bulles pour les contrôles consiste à spécifier les propriétés « text » et « visibility » via les propriétés attachées. L'exemple suivant illustre cette approche :

Button {
    text: qsTr("Save")

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

Dans des conditions normales, une seule info-bulle est visible à la fois. Afin d’économiser des ressources, tous les éléments qui utilisent la propriété associée `ToolTip` partagent la même instance visuelle de libellé d’info-bulle. Même si les éléments visuels sont partagés, les propriétés text, timeout et delay sont stockées individuellement pour chaque élément utilisant la propriété associée correspondante. Cependant, plusieurs éléments ne peuvent pas rendre l’info-bulle partagée visible simultanément. L’info-bulle partagée n’est affichée que pour le dernier élément qui l’a rendue visible. La position de l’info-bulle partagée est déterminée par le framework.

Délai et délai d’expiration

Les infobulles sont généralement éphémères dans la mesure où elles s’affichent à la suite d’un certain événement externe ou d’une interaction de l’utilisateur, et elles disparaissent généralement après un certain délai d’expiration. Il est possible de contrôler le délai d’affichage d’une infobulle, ainsi que le délai d’expiration avant sa disparition. Cela permet de mettre en œuvre différentes stratégies d’affichage et de masquage des infobulles.

Par exemple, sur les écrans tactiles, il est courant d’afficher une info-bulle lorsqu’on appuie sur un bouton et qu’on le maintient enfoncé. L’exemple suivant montre comment retarder l’affichage d’une info-bulle jusqu’à ce que la durée de maintien soit atteinte. Dans cet exemple, l’info-bulle disparaît dès que le bouton est relâché.

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

Avec les périphériques de pointage, en revanche, on peut souhaiter afficher une info-bulle lorsque le curseur reste un certain temps au-dessus d’un bouton. L’exemple suivant montre comment afficher une info-bulle après avoir survolé un bouton pendant une seconde, puis la masquer après un délai de cinq secondes.

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

Infobulles personnalisées

Si l’on a besoin d’un contrôle plus fin sur la position de l’info-bulle, ou si plusieurs instances d’info-bulle simultanées sont nécessaires, il est également possible de créer des instances d’info-bulle locales. De cette manière, il est possible de personnaliser l’info-bulle, et l’ensemble de l’API Popup est disponible. L’exemple suivant présente une info-bulle qui affiche la valeur d’un curseur lorsque la poignée est déplacée.

Slider {
    id: slider
    value: 0.5

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

Voir également Personnalisation des info-bulles, Contrôles contextuels et closePolicy.

Documentation sur les propriétés

delay : int

Cette propriété définit le délai (en millisecondes) après lequel l'info-bulle s'affiche. Une info-bulle avec un délai négatif s'affiche immédiatement. La valeur par défaut est 0.

Voir également Delay and Timeout.

text : string

Cette propriété contient le texte affiché dans l'info-bulle.

timeout : int

Cette propriété définit le délai (en millisecondes) au bout duquel l'info-bulle est masquée. Une info-bulle dont le délai est négatif ne se masque pas automatiquement. La valeur par défaut est -1.

Voir également Delay and Timeout.

Documentation sur les propriétés associées

ToolTip.delay : int [attached]

Cette propriété associée contient le délai (en millisecondes) de l'info-bulle partagée. Elle peut être associée à n'importe quel élément.

La valeur par défaut est « 0 » si « policy » vaut « ToolTip.Manual », sinon elle est « QStyleHints::toolTipWakeUpDelay() ».

Voir également Attached Tool Tips et Delay and Timeout.

ToolTip.policy : enumeration [attached, since 6.12]

Cette propriété associée détermine si la visibilité de l'shared tool tip instance est gérée automatiquement. Elle n'a d'effet que sur les éléments pour lesquels la propriété « ToolTip.visible » n'a pas été définie. Seuls les éléments pour lesquels la propriété « ToolTip.text » est définie seront rendus visibles. Elle n'a d'effet que sur les éléments suivants et leurs types dérivés : « Control », « TextArea » et « TextField ». Pour tous les autres types, la propriété « visible » doit être définie manuellement.

Elle détermine également les valeurs par défaut des propriétés delay et timeout de l’instance partagée de l’info-bulle (que ToolTip.visible ou ToolTip.text aient été définies ou non).

Cette propriété est répercutée sur les enfants de type « ToolTip » associés.

Valeurs disponibles :

La valeur par défaut est ` ToolTip.Automatic`.

Cette propriété permet de désactiver les valeurs par défaut des infobulles partagées introduites dans Qt 6.12. Cela s'avère particulièrement pertinent pour le code hérité qui ne définit pas explicitement la propriété « visible » avant toute interaction avec un élément. Pour les applications qui définissent la propriété `visible` de manière déclarative et qui jugent acceptables les nouvelles valeurs par défaut de `delay` et `timeout`, ` policy ` n’est pas nécessaire.

Cette propriété a été introduite dans Qt 6.12.

Voir également Attached Tool Tips.

ToolTip.text : string [attached]

Cette propriété associée contient le texte de l'info-bulle partagée. Elle peut être associée à n'importe quel élément.

Voir également Attached Tool Tips.

ToolTip.timeout : int [attached]

Cette propriété associée contient le délai d'expiration (en millisecondes) de l'info-bulle partagée. Elle peut être associée à n'importe quel élément.

La valeur par défaut dépend de la longueur du texte et est toujours d'au moins 10 secondes.

Voir également Attached Tool Tips et Delay and Timeout.

ToolTip.toolTip : ToolTip [attached]

Cette propriété associée contient l'instance de l'info-bulle partagée. Elle peut être associée à n'importe quel élément.

Voir également Attached Tool Tips.

ToolTip.visible : bool [attached]

Cette propriété associée indique si l'info-bulle partagée est visible. Elle peut être associée à n'importe quel élément.

Voir également Attached Tool Tips.

Documentation sur les méthodes

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

Cette méthode masque l'info-bulle.

Cette méthode a été introduite dans QtQuick.Controls 2.5 (Qt 5.12).

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

Cette méthode affiche l'text sous forme d'info-bulle, dont la durée d'affichage est définie en « timeout » (millisecondes).

Cette méthode a été introduite dans QtQuick.Controls 2.5 (Qt 5.12).

Documentation de la méthode ci-jointe

[attached] void hide()

Cette méthode associée masque l'infobulle partagée. Elle peut être associée à n'importe quel élément.

Voir également Attached Tool Tips.

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

La méthode ci-jointe affiche l'info-bulle partagée avec les valeurs « text » et « timeout » (en millisecondes). Cette méthode peut être associée à n'importe quel élément.

Voir également Attached Tool Tips.