Heading Class Reference

Inheritance diagram for Heading:

Public Types
enum class	Type { Normal , Primary , Secondary }

Properties
int	level
int	type

Detailed Description

A heading label used for subsections of texts.

The characteristics of the text will be automatically set according to the Kirigami.Theme. Use this components for section titles or headings in your UI, for example page or section titles.

Example usage:

import org.kde.kirigami as Kirigami
[...]
Column {
    Kirigami.Heading {
        text: "Apples in the sunlight"
        level: 2
    }
  [...]
}

The most important property is "text", which applies to the text property of Label. See the Label component from QtQuick.Controls 2 and primitive QML Text element API for additional properties, methods and signals.

Definition at line 35 of file Heading.qml.

Member Enumeration Documentation

Type

enum class Heading::Type

strong

This enumeration defines heading types.

This enum helps with heading visibility (making it less or more important).

Definition at line 52 of file Heading.qml.

Property Documentation

level

int Heading::level

read

This property holds the level of the heading, which determines its size.

This property holds the level, which determines how large the header is.

Acceptable values range from 1 (big) to 5 (small).

default: 1

Definition at line 46 of file Heading.qml.

type

int Heading::type

read

This property holds the heading type.

The type of the heading. This can be:

• Kirigami.Heading.Type.Normal: Create a normal heading (default)
• Kirigami.Heading.Type.Primary: Makes the heading more prominent. Useful when making the heading bigger is not enough.
• Kirigami.Heading.Type.Secondary: Makes the heading less prominent. Useful when an heading is for a less important section in an application.

Since

5.82

Definition at line 70 of file Heading.qml.

---

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

• Heading.qml