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

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

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

delay : int

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

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

text : строка

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

timeout : int

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

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

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

ToolTip.delay : int

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

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

ToolTip.text : строка

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

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

ToolTip.timeout : int

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

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

ToolTip.toolTip : ToolTip

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

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

ToolTip.visible : bool

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

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

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

void hide()

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

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

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