Тип QML ToolTip

Предоставляет подсказки для любого элемента управления. Подробнее...

• Список всех членов, включая унаследованные члены

Свойства

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

Присоединенные свойства

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

Методы

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

Присоединенные методы

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

Подробное описание

Подсказка — это короткий текст, информирующий пользователя о функции элемента управления. Обычно он размещается над или под родительским элементом управления. Текст подсказки может быть любой строкой форматированного богатого текста.

Присоединенные подсказки

Самый простой способ настроить подсказки для элементов управления — указать текст и видимость через присоединенные свойства. Следующий пример демонстрирует этот подход:

Button {
    text: qsTr("Save")

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

В нормальных условиях одновременно видна только одна подсказка. Для экономии ресурсов все элементы, использующие присоединенное свойство ToolTip, используют один и тот же экземпляр метки визуальной подсказки. Несмотря на то, что визуальные элементы совместно используются, text, timeout и delay хранятся индивидуально для каждого элемента, использующего соответствующее присоединенное свойство. Однако несколько элементов не могут сделать совместно используемую подсказку видимой одновременно. Совместно используемая подсказка отображается только для последнего элемента, который сделал ее видимой. Положение совместно используемой подсказки определяется фреймворком.

Задержка и таймаут

Подсказки обычно являются временными, в том смысле, что они отображаются в результате определенного внешнего события или взаимодействия пользователя, и обычно скрываются после определенного таймаута. Можно контролировать задержку отображения подсказки и таймаут ее скрытия. Это позволяет реализовать различные стратегии отображения и скрытия подсказок.

Например, на сенсорных экранах распространенным шаблоном является отображение подсказки в результате удерживания кнопки. Следующий пример демонстрирует, как отложить отображение подсказки до достижения интервала удерживания. В этом примере подсказка скрывается сразу после отпускания кнопки.

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

Однако для устройств с указательными устройствами может потребоваться отобразить подсказку в результате наведения указателя на кнопку в течение некоторого времени. Следующий пример демонстрирует, как отобразить подсказку после наведения на кнопку в течение секунды и скрыть ее после таймаута в пять секунд.

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

Настраиваемые подсказки

Если требуется более точный контроль над положением подсказки или необходимо несколько одновременно отображаемых подсказок, можно также создать локальные экземпляры подсказок. Таким образом, можно настроить подсказку, и доступен весь API Popup.

Следующий пример демонстрирует подсказку, отображающую значение ползунка при перетаскивании ползунка.

Slider {
    id: slider
    value: 0.5

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

См. также Настройка ToolTip, Элементы управления Popup и closePolicy.

Документация по свойствам

delay : int

Это свойство содержит задержку (в миллисекундах), после которой отображается подсказка. Подсказка с отрицательной задержкой отображается немедленно. Значение по умолчанию — 0.

См. также Задержка и таймаут.

text : string

Это свойство содержит текст, отображаемый на подсказке.

timeout : int

Это свойство содержит таймаут (в миллисекундах), после которого подсказка скрывается. Подсказка с отрицательным таймаутом не скрывается автоматически. Значение по умолчанию — -1.

См. также Задержка и таймаут.

Документация по присоединенным свойствам

ToolTip.delay : int

Это присоединенное свойство содержит задержку (в миллисекундах) совместно используемой подсказки. Свойство можно прикрепить к любому элементу.

См. также Присоединенные подсказки и Задержка и таймаут.

ToolTip.text : string

Это присоединенное свойство содержит текст совместно используемой подсказки. Свойство можно прикрепить к любому элементу.

См. также Присоединенные подсказки.

ToolTip.timeout : int

Это присоединенное свойство содержит таймаут (в миллисекундах) совместно используемой подсказки. Свойство можно прикрепить к любому элементу.

См. также Присоединенные подсказки и Задержка и таймаут.

ToolTip.toolTip : ToolTip

Это присоединенное свойство содержит экземпляр совместно используемой подсказки. Свойство можно прикрепить к любому элементу.

См. также Присоединенные подсказки.

ToolTip.visible : bool

Это присоединенное свойство указывает, отображается ли совместно используемая подсказка. Свойство можно прикрепить к любому элементу.

См. также Присоединенные подсказки.

Документация по методам

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

Этот метод скрывает подсказку.

Этот метод был представлен в QtQuick.Controls 2.5 (Qt 5.12).

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

Этот метод отображает text как подсказку, которая скрывается по таймауту timeout (в миллисекундах).

Этот метод был представлен в QtQuick.Controls 2.5 (Qt 5.12).

Документация по присоединенным методам

void hide()

Этот присоединенный метод скрывает общую подсказку. Метод можно прикрепить к любому элементу.

См. также Присоединенные подсказки.

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

Этот присоединенный метод отображает общую подсказку с text и timeout (в миллисекундах). Метод можно прикрепить к любому элементу.

См. также Присоединенные подсказки.