Тип 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)

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

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

Присоединенные всплывающие подсказки

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

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

См. также Настройка всплывающей подсказки и Элементы управления Popup.

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

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 (в миллисекундах). Метод может быть присоединён к любому элементу.

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