org::kde::kirigami::templates::OverlaySheet Class Reference

Inherits QtObject.

Properties
Item	background
int	bottomPadding
Item	contentItem
Item	footer
Item	header
int	leftPadding
Item	parent
int	rightPadding
Item	rootItem
bool	sheetOpen
alias	showCloseButton
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. : QtQuick.QtObject

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

Property Documentation

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

background: Item 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 99 of file templates/OverlaySheet.qml.

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

bottomPadding: int default contents padding at bottom

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

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

contentItem: Item This property holds the visual content item.

Note: The content item is automatically resized inside the padding of the control. 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 49 of file templates/OverlaySheet.qml.

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

header: Item an optional item which will be used as the sheet's footer, always kept on screen

Since

5.43

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

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

header: Item an optional item which will be used as the sheet's header, always kept on screen

Since

5.43

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

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

leftPadding: int default contents padding at left

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

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

rightPadding: int default contents padding at right

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

Item org::kde::kirigami::templates::OverlaySheet::rootItem

Remarks

This property is read-only

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

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

sheetOpen: bool If true the sheet is open showing the contents of the OverlaySheet component.

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

alias org::kde::kirigami::templates::OverlaySheet::showCloseButton

showCloseButton: bool whether to show the close button in the top-right corner

Since

5.44

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

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

topPadding: int default contents padding at top

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

---

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

• templates/OverlaySheet.qml