Search for usage in LXR

org::kde::kirigami::Heading Class Reference
Inheritance diagram for org::kde::kirigami::Heading:

Public Types

enum  Type { Normal, Primary, Secondary }


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 2.4 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 36 of file Heading.qml.

Member Enumeration Documentation

◆ Type

This enumeration defines heading types.

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

Definition at line 53 of file Heading.qml.

Property Documentation

◆ level

int org::kde::kirigami::Heading::level

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 47 of file Heading.qml.

◆ type

Heading::Type org::kde::kirigami::Heading::type

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.

Definition at line 71 of file Heading.qml.

The documentation for this class was generated from the following file:
int level
This property holds the level of the heading, which determines its size.
Definition: Heading.qml:47
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Thu Jun 8 2023 03:59:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.