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

Inherits Item, and OverlaySheet.

Properties
Item	background
int	bottomPadding
Item	contentItem
int	leftPadding
bool	opened
int	rightPadding
int	topPadding

Public Member Functions
void	close ()
void	open ()

Detailed Description

An overlay sheet that covers the current Page content.

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.

Definition at line 30 of file OverlaySheet.qml.

Property Documentation

Item org::kde::kirigami::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 78 of file templates/OverlaySheet.qml.

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

bottomPadding: int default contents padding at bottom

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

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

contentItem: Item This property holds the visual content item.

Note: The content item is automatically resized inside the padding of the control.

Remarks

This is the default property

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

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

leftPadding: int default contents padding at left

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

bool org::kde::kirigami::OverlaySheet::opened

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

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

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

rightPadding: int default contents padding at right

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

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

topPadding: int default contents padding at top

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

---

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

• OverlaySheet.qml