org::kde::kirigami::templates::AbstractApplicationHeader

Search for usage in LXR

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

Properties

Item background
 
int bottomPadding
 
alias contentItem
 
bool hideWhenTouchScrolling
 
int leftPadding
 
int maximumHeight
 
int minimumHeight
 
KirigamiPage page
 
KirigamiPageRow pageRow
 
int paintedHeight
 
int position
 
int preferredHeight
 
int rightPadding
 
bool separatorVisible
 
int topPadding
 

Additional Inherited Members

- Public Member Functions inherited from QtQuick.Item
 childAt (real x, real y)
 
bool contains (point point)
 
 dumpItemTree ()
 
 forceActiveFocus ()
 
 forceActiveFocus (Qt::FocusReason reason)
 
bool grabToImage (callback, targetSize)
 
point mapFromGlobal (real x, real y)
 
point mapFromItem (Item item, point p)
 
point mapFromItem (Item item, real x, real y)
 
rect mapFromItem (Item item, real x, real y, real width, real height)
 
rect mapFromItem (Item item, rect r)
 
point mapToGlobal (real x, real y)
 
point mapToItem (Item item, point p)
 
point mapToItem (Item item, real x, real y)
 
rect mapToItem (Item item, real x, real y, real width, real height)
 
rect mapToItem (Item item, rect r)
 
 nextItemInFocusChain (bool 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

  • minimumHeight: default is 0, i.e. hidden
  • preferredHeight: default is Units.gridUnit * 1.6
  • maximumHeight: default is Units.gridUnit * 3

To achieve a titlebar that stays completely fixed just set the 3 sizes as the same

Import Statement

import org.kde.kirigami.templates
Version
2.2

Definition at line 27 of file controls/templates/AbstractApplicationHeader.qml.

Property Documentation

◆ background

Item org::kde::kirigami::templates::AbstractApplicationHeader::background
read

This property holds the background item.

Note
the background will be automatically sized to fill the whole control

Definition at line 74 of file controls/templates/AbstractApplicationHeader.qml.

◆ bottomPadding

int org::kde::kirigami::templates::AbstractApplicationHeader::bottomPadding
read

◆ contentItem

alias org::kde::kirigami::templates::AbstractApplicationHeader::contentItem
read
Remarks
This is the default property

Definition at line 44 of file controls/templates/AbstractApplicationHeader.qml.

◆ hideWhenTouchScrolling

bool org::kde::kirigami::templates::AbstractApplicationHeader::hideWhenTouchScrolling
read

This property specifies whether the header should be pushed back when scrolling using the touch screen.

Definition at line 62 of file controls/templates/AbstractApplicationHeader.qml.

◆ leftPadding

int org::kde::kirigami::templates::AbstractApplicationHeader::leftPadding
read

◆ maximumHeight

int org::kde::kirigami::templates::AbstractApplicationHeader::maximumHeight
read

◆ minimumHeight

int org::kde::kirigami::templates::AbstractApplicationHeader::minimumHeight
read

◆ page

KirigamiPage org::kde::kirigami::templates::AbstractApplicationHeader::page
read

◆ pageRow

KirigamiPageRow org::kde::kirigami::templates::AbstractApplicationHeader::pageRow
read

◆ paintedHeight

int org::kde::kirigami::templates::AbstractApplicationHeader::paintedHeight
read
Remarks
This property is read-only

Definition at line 47 of file controls/templates/AbstractApplicationHeader.qml.

◆ position

int org::kde::kirigami::templates::AbstractApplicationHeader::position
read

◆ preferredHeight

int org::kde::kirigami::templates::AbstractApplicationHeader::preferredHeight
read

◆ rightPadding

int org::kde::kirigami::templates::AbstractApplicationHeader::rightPadding
read

◆ separatorVisible

bool org::kde::kirigami::templates::AbstractApplicationHeader::separatorVisible
read

◆ topPadding

int org::kde::kirigami::templates::AbstractApplicationHeader::topPadding
read

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:52:23 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.