org::kde::plasma::extras::Heading Class Reference

Inheritance diagram for org::kde::plasma::extras::Heading:

Public Types
enum	Type { Normal, Primary, Secondary }

Properties
int	level
int	step
int	type

Public Member Functions
void	__headerPointSize (level)
void	headerPointSize (l)
Public Member Functions inherited from QtQuick.Text
	doLayout ()
	forceLayout ()
	lineLaidOut (line)
	linkActivated (link)
	linkAt (x, real y)
	linkHovered (link)

Detailed Description

A heading label used for subsections of texts.

Since

2.0

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

Example usage:

import org.kde.plasma.extras 2.0 as PlasmaExtras
[...]
Column {
    PlasmaExtras.Heading { text: "Fruit sweetness on the rise"; level: 1 }
    PlasmaExtras.Heading { text: "Apples in the sunlight"; level: 2 }
    PlasmaExtras.Paragraph { text: "Long text about fruit and apples [...]" }
  [...]
}

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

Definition at line 35 of file Heading.qml.

Property Documentation

level

int org::kde::plasma::extras::Heading::level

read

The level determines how big the section header is display, values between 1 (big) and 5 (small) are accepted.

(default: 1)

Definition at line 41 of file Heading.qml.

step

int org::kde::plasma::extras::Heading::step

read

Adjust the point size in between a level and another.

(default: 0)

Deprecated:

Definition at line 46 of file Heading.qml.

type

int org::kde::plasma::extras::Heading::type

read

The type of the heading.

This can be:

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

Since

5.88

Definition at line 63 of file Heading.qml.

---

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

• Heading.qml