org::kde::kirigami::templates::OverlaySheet

Search for usage in LXR

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

Properties

Item background
 
real bottomInset
 
int bottomPadding
 
Item contentItem
 
Item footer
 
Item header
 
real leftInset
 
int leftPadding
 
Item parent
 
real rightInset
 
int rightPadding
 
Item rootItem
 
bool sheetOpen
 
bool showCloseButton
 
string title
 
real topInset
 
int topPadding
 

Public Member Functions

void close ()
 
void open ()
 

Detailed Description

An overlay sheet that covers the current Page content.

Since
2.2

Its contents can be scrolled up or down, scrolling all the way up or all the way down, dismisses it. Use this for big, modal dialogs or information display, that can't be logically done as a new separate Page, even if potentially are taller than the screen space.

Since
2.0

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

Property Documentation

◆ background

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

This property holds the background item.

Note
If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.

Definition at line 128 of file templates/OverlaySheet.qml.

◆ bottomInset

real org::kde::kirigami::templates::OverlaySheet::bottomInset
read

This property holds the bottom inset for the background.

The inset gets applied to both the content and the background.

default: 0

Since
2.12

Definition at line 108 of file templates/OverlaySheet.qml.

◆ bottomPadding

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

This property holds the bottom padding.

default: Kirigami.Units.largeSpacing

Definition at line 68 of file templates/OverlaySheet.qml.

◆ contentItem

Item org::kde::kirigami::templates::OverlaySheet::contentItem
read

This property holds the visual content item.

Note
The content item is automatically resized to fill the sheet's view area.

Conversely, the Sheet will be sized based on the size hints of the contentItem, so if you need a custom size sheet, redefine contentWidth and contentHeight of your contentItem

Remarks
This is the default property

Definition at line 40 of file templates/OverlaySheet.qml.

◆ footer

Item org::kde::kirigami::templates::OverlaySheet::footer
read

An optional item which will be used as the sheet's footer, always kept on screen.

Since
5.43

Definition at line 120 of file templates/OverlaySheet.qml.

◆ header

Item org::kde::kirigami::templates::OverlaySheet::header
read

This property holds an optional item which will be used as the sheet's header, and will always be displayed.

Since
5.43

Definition at line 114 of file templates/OverlaySheet.qml.

◆ leftInset

real org::kde::kirigami::templates::OverlaySheet::leftInset
read

This property holds the left inset for the background.

The inset gets applied to both the content and the background.

default: 0

Since
2.12

Definition at line 78 of file templates/OverlaySheet.qml.

◆ leftPadding

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

This property holds the left padding.

default: Kirigami.Units.largeSpacing

Definition at line 50 of file templates/OverlaySheet.qml.

◆ rightInset

real org::kde::kirigami::templates::OverlaySheet::rightInset
read

This property holds the right inset for the background.

The inset gets applied to both the content and the background.

default: 0

Since
2.12

Definition at line 98 of file templates/OverlaySheet.qml.

◆ rightPadding

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

This property holds the right padding.

default: Kirigami.Units.largeSpacing

Definition at line 62 of file templates/OverlaySheet.qml.

◆ rootItem

Item org::kde::kirigami::templates::OverlaySheet::rootItem
read
Remarks
This property is read-only

Definition at line 163 of file templates/OverlaySheet.qml.

◆ sheetOpen

bool org::kde::kirigami::templates::OverlaySheet::sheetOpen
read

This property tells whether the sheet is open and displaying its contents.

Definition at line 44 of file templates/OverlaySheet.qml.

◆ showCloseButton

bool org::kde::kirigami::templates::OverlaySheet::showCloseButton
read

This property sets the visibility of the close button in the top-right corner.

default: Only shown in desktop mode

Since
5.44

Definition at line 136 of file templates/OverlaySheet.qml.

◆ title

string org::kde::kirigami::templates::OverlaySheet::title
read

This property holds the sheet's title.

Note
If the header property is set, this will have no effect as the heading will be replaced by the header.
Since
5.84

Definition at line 142 of file templates/OverlaySheet.qml.

◆ topInset

real org::kde::kirigami::templates::OverlaySheet::topInset
read

This property holds the top inset for the background.

The inset gets applied to both the content and the background.

default: 0

Since
2.12

Definition at line 88 of file templates/OverlaySheet.qml.

◆ topPadding

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

This property holds the top padding.

default: Kirigami.Units.largeSpacing

Definition at line 56 of file templates/OverlaySheet.qml.

Member Function Documentation

◆ close()

void org::kde::kirigami::templates::OverlaySheet::close ( )

This function closes the overlay sheet.

◆ open()

void org::kde::kirigami::templates::OverlaySheet::open ( )

This function opens the overlay sheet.


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 Fri Jan 27 2023 07:55:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.