ContextualHelpButton Class Reference

Inherits QtQuick::Controls::ToolButton.

Properties
alias	toolTipText
bool	toolTipVisible

Detailed Description

An inline help button that shows a tooltip when clicked.

Use this component when you want to explain details or usage of a feature of the UI, but the explanation is too long to fit in an inline label, and too important to put in a hover tooltip and risk the user missing it.

Example of ContextualHelpButton usage

Example usage:

import QtQuick.Controls as QQC2
import QtQuick.Layouts
import org.kde.kirigami as Kirigami
 
RowLayout {
    spacing: Kirigami.Units.smallSpacing
 
    QQC2.CheckBox {
        text: i18n("Allow screen tearing in fullscreen windows")
    }
 
    Kirigami.ContextualHelpButton {
        toolTipText: i18n("With most displays, screen tearing reduces latency at the cost of some visual fidelity at high framerates. Note that not all graphics drivers support this setting.")
    }
}

Definition at line 41 of file ContextualHelpButton.qml.

Property Documentation

toolTipText

alias ContextualHelpButton::toolTipText

read

Definition at line 44 of file ContextualHelpButton.qml.

toolTipVisible

bool ContextualHelpButton::toolTipVisible

read

Definition at line 46 of file ContextualHelpButton.qml.

---

The documentation for this class was generated from the following file:

• ContextualHelpButton.qml