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
|
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 107 of file templates/OverlaySheet.qml.
◆ bottomInset
|
read |
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 87 of file templates/OverlaySheet.qml.
◆ bottomPadding
|
read |
This property holds the bottom padding.
Unless explicitly set, the value is equal to Units::largeSpacing
Definition at line 63 of file templates/OverlaySheet.qml.
◆ contentItem
|
read |
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 38 of file templates/OverlaySheet.qml.
◆ footer
|
read |
An optional item which will be used as the sheet's footer, always kept on screen.
- Since
- 5.43
Definition at line 99 of file templates/OverlaySheet.qml.
◆ header
|
read |
An optional item which will be used as the sheet's header, always kept on screen.
- Since
- 5.43
Definition at line 93 of file templates/OverlaySheet.qml.
◆ leftInset
|
read |
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 69 of file templates/OverlaySheet.qml.
◆ leftPadding
|
read |
This property holds the left padding.
Unless explicitly set, the value is equal to Units::largeSpacing
Definition at line 48 of file templates/OverlaySheet.qml.
◆ rightInset
|
read |
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 81 of file templates/OverlaySheet.qml.
◆ rightPadding
|
read |
This property holds the right padding.
Unless explicitly set, the value is equal to Units::largeSpacing
Definition at line 58 of file templates/OverlaySheet.qml.
◆ rootItem
|
read |
- Remarks
- This property is read-only
Definition at line 134 of file templates/OverlaySheet.qml.
◆ sheetOpen
|
read |
If true the sheet is open showing the contents of the OverlaySheet component.
Definition at line 43 of file templates/OverlaySheet.qml.
◆ showCloseButton
|
read |
Whether to show the close button in the top-right corner.
By default only show on desktop.
- Since
- 5.44
Definition at line 113 of file templates/OverlaySheet.qml.
◆ title
|
read |
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 121 of file templates/OverlaySheet.qml.
◆ topInset
|
read |
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 75 of file templates/OverlaySheet.qml.
◆ topPadding
|
read |
This property holds the top padding.
Unless explicitly set, the value is equal to Units::largeSpacing
Definition at line 53 of file templates/OverlaySheet.qml.
Member Function Documentation
◆ close()
void org::kde::kirigami::templates::OverlaySheet::close | ( | ) |
Close the overlay sheet.
◆ open()
void org::kde::kirigami::templates::OverlaySheet::open | ( | ) |
Open the overlay sheet.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Wed Jun 29 2022 04:03:00 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.