ToolTip QML Type

Proporciona consejos sobre herramientas para cualquier control. Más...

• Lista de todos los miembros, incluidos los heredados

Propiedades

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

Propiedades anexas

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

Métodos

• 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étodos adjuntos

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

Descripción detallada

Un tool tip es un breve fragmento de texto que informa al usuario de la función de un control. Suele colocarse encima o debajo del control principal. El texto del consejo puede ser cualquier cadena con formato de texto enriquecido.

Consejos de herramientas adjuntos

La forma más sencilla de configurar los tool tips para los controles es especificar text y visibility a través de las propiedades adjuntas. El siguiente ejemplo ilustra este enfoque:

Button {
    text: qsTr("Save")

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

En circunstancias normales, sólo hay un tool tip visible a la vez. Para ahorrar recursos, todos los elementos que utilizan la propiedad adjunta ToolTip comparten la misma instancia visual de etiqueta de tool tip. Aunque los visuales se comparten, text, timeout y delay se almacenan individualmente para cada elemento que utiliza la propiedad adjunta respectiva. Sin embargo, varios elementos no pueden hacer visible el tool tip compartido al mismo tiempo. El tool tip compartido sólo se muestra para el último elemento que lo hizo visible. La posición del tool tip compartido está determinada por el framework.

Retraso y tiempo de espera

Los tool tips son típicamente transitorios en el sentido de que se muestran como resultado de un cierto evento externo o interacción del usuario, y normalmente se ocultan después de un cierto tiempo de espera. Es posible controlar el retardo con el que se muestra un tool tip y el tiempo de espera con el que se oculta. Esto permite aplicar distintas estrategias para mostrar y ocultar las sugerencias.

Por ejemplo, en las pantallas táctiles, es habitual que se muestre una información sobre herramientas al pulsar y mantener pulsado un botón. El siguiente ejemplo muestra cómo retrasar la aparición de una punta de herramienta hasta que se alcanza el intervalo de pulsación y mantenimiento. En este ejemplo, la punta de la herramienta se oculta en cuanto se suelta el botón.

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

Sin embargo, en el caso de los dispositivos de puntero, es posible que se desee mostrar una punta de herramienta como resultado de mantener pulsado un botón durante un tiempo. El siguiente ejemplo muestra cómo mostrar un tool tip después de pasar el ratón por encima de un botón durante un segundo, y ocultarlo después de un tiempo de espera de cinco segundos.

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

Sugerencias personalizadas

Si se necesita un control más preciso sobre la posición de la punta de la herramienta, o se necesitan múltiples instancias simultáneas de la punta de la herramienta, también es posible crear instancias locales de la punta de la herramienta. De esta manera, es posible personalizar la punta de la herramienta, y toda la API Popup está disponible. El siguiente ejemplo presenta una punta de herramienta que presenta el valor de un deslizador cuando se arrastra la manija.

Slider {
    id: slider
    value: 0.5

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

Véase también Personalización de ToolTip, Controles emergentes y closePolicy.

Documentación de propiedades

delay : int

Esta propiedad contiene el retardo (milisegundos) tras el cual se muestra la información sobre herramientas. Un tooltip con un retardo negativo se muestra inmediatamente. El valor por defecto es 0.

Véase también Delay and Timeout.

text : string

Esta propiedad contiene el texto mostrado en la punta de la herramienta.

timeout : int

Esta propiedad contiene el tiempo de espera (milisegundos) tras el cual se oculta la información sobre herramientas. Un tooltip con un tiempo de espera negativo no se oculta automáticamente. El valor por defecto es -1.

Véase también Delay and Timeout.

Documentación de la propiedad Attached

ToolTip.delay : int

Esta propiedad adjunta contiene el retardo (milisegundos) de la punta de la herramienta compartida. La propiedad puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips y Delay and Timeout.

ToolTip.text : string

Esta propiedad adjunta contiene el texto del tool tip compartido. La propiedad puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips.

ToolTip.timeout : int

Esta propiedad adjunta contiene el tiempo de espera (milisegundos) de la punta de la herramienta compartida. La propiedad puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips y Delay and Timeout.

ToolTip.toolTip : ToolTip

Esta propiedad adjunta contiene la instancia compartida de la punta de la herramienta. La propiedad puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips.

ToolTip.visible : bool

Esta propiedad adjunta indica si la punta de la herramienta compartida es visible. La propiedad puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips.

Documentación del método

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

Este método oculta el tooltip.

Este método se introdujo en QtQuick.Controls 2.5 (Qt 5.12).

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

Este método muestra el text como un tooltip, que se agota en timeout (milisegundos).

Este método fue introducido en QtQuick.Controls 2.5 (Qt 5.12).

Documentación del método adjunto

void hide()

Este método adjunto oculta el tooltip compartido. El método puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips.

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

Este método adjunto muestra el tooltip compartido con text y timeout (milisegundos). El método puede adjuntarse a cualquier elemento.

Véase también Attached Tool Tips.