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 27 of file templates/OverlaySheet.qml.

Property Documentation

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

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 108 of file templates/OverlaySheet.qml.

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

This property holds the bottom inset for the background.

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

Since

2.12

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

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

This property holds the bottom padding.

Unless explicitly set, the value is equal to Units::largeSpacing

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

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

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 39 of file templates/OverlaySheet.qml.

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

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

Since

5.43

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

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

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

Since

5.43

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

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

This property holds the left inset for the background.

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

Since

2.12

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

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

This property holds the left padding.

Unless explicitly set, the value is equal to Units::largeSpacing

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

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

This property holds the right inset for the background.

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

Since

2.12

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

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

This property holds the right padding.

Unless explicitly set, the value is equal to Units::largeSpacing

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

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

Remarks

This property is read-only

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

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

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

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

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

Whether to show the close button in the top-right corner.

By default only show on desktop.

Since

5.44

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

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

title: string This property holds the sheet 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 122 of file templates/OverlaySheet.qml.

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

This property holds the top inset for the background.

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

Since

2.12

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

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

This property holds the top padding.

Unless explicitly set, the value is equal to Units::largeSpacing

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

Member Function Documentation

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

(

)

Close the overlay sheet.

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

(

)

Open the overlay sheet.

---

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

• templates/OverlaySheet.qml