Тип QML ToolTip

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

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

Свойства

• delay : int
• text : строка
• timeout : int

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

• delay : int
• text : строка
• timeout : int
• toolTip : ToolTip
• visible : bool

Методы

• void hide()
• void show(строка text, int timeout)

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

• void hide()
• void show(строка 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)
    }
}

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

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

delay : int

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

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

text : строка

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

timeout : int

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

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

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

ToolTip.delay : int

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

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

ToolTip.text : строка

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

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

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(строка text, int timeout)

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

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

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

void hide()

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

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

void show(строка text, int timeout = -1)

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

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