Search for usage in LXR

org::kde::kirigami::templates::ApplicationHeader Class Reference
Inheritance diagram for org::kde::kirigami::templates::ApplicationHeader:


bool backButtonEnabled
int headerStyle
Component pageDelegate
- Properties inherited from org::kde::kirigami::templates::AbstractApplicationHeader
QtObject __appWindow
Item background
int bottomPadding
alias contentItem
bool hideWhenTouchScrolling
int leftPadding
int maximumHeight
int minimumHeight
Kirigami Page
Kirigami PageRow
int paintedHeight
int position
int preferredHeight
int rightPadding
bool separatorVisible
int topPadding

Additional Inherited Members

- Public Member Functions inherited from QtQuick.Item
 childAt (x, real y)
bool contains (point)
 forceActiveFocus ()
 forceActiveFocus (reason)
bool grabToImage (callback, targetSize)
object mapFromGlobal (x, real y)
object mapFromItem (item, point p)
object mapFromItem (item, real x, real y)
object mapFromItem (item, real x, real y, real width, real height)
object mapFromItem (item, rect r)
object mapToGlobal (x, real y)
object mapToItem (item, point p)
object mapToItem (item, real x, real y)
object mapToItem (item, real x, real y, real width, real height)
object mapToItem (item, rect r)
 nextItemInFocusChain (forward)

Detailed Description

An item that can be used as a title for the application.


Scrolling the main page will make it taller or shorter (through the point of going away) It's a behavior similar to the typical mobile web browser addressbar the minimum, preferred and maximum heights of the item can be controlled with

To achieve a titlebar that stays completely fixed just set the 3 sizes to the same value.

This will be removed in KF6.

Definition at line 26 of file templates/ApplicationHeader.qml.

Property Documentation

◆ backButtonEnabled

bool org::kde::kirigami::templates::ApplicationHeader::backButtonEnabled

This property sets whether the back button is enabled.

default: when true, there will be a back button present that will make the pagerow scroll back when clicked

Definition at line 47 of file templates/ApplicationHeader.qml.

◆ headerStyle

int org::kde::kirigami::templates::ApplicationHeader::headerStyle

This property sets the way the separator between pages should be drawn in the header.

The following values are allowed:

  • Kirigami.ApplicationHeaderStyle.Breadcrumb: The pages are hierarchical, separated by an arrow.
  • Kirigami.ApplicationHeaderStyle.TabBar: The pages are intended to behave like pages of a tabbed view. and the separator will look limke a dot.

When the header is in wide screen mode, no separator will be drawn.

default: ApplicationHeaderStyle.Auto

Definition at line 41 of file templates/ApplicationHeader.qml.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Dec 4 2023 04:01:43 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.