org::kde::kirigami::OverlayDrawer Class Reference

Inheritance diagram for org::kde::kirigami::OverlayDrawer:

Properties
Item	background
int	bottomPadding
Item	contentItem
int	edge
bool	handleVisible
int	leftPadding
alias	opened
alias	page
real	position
int	rightPadding
int	topPadding

Public Member Functions
void	close ()
void	open ()

Detailed Description

Overlay Drawers are used to expose additional UI elements needed for small secondary tasks for which the main UI elements are not needed.

For example in Okular Active, an Overlay Drawer is used to display thumbnails of all pages within a document along with a search field. This is used for the distinct task of navigating to another page.

Definition at line 31 of file controls/OverlayDrawer.qml.

Property Documentation

Item org::kde::kirigami::OverlayDrawer::background

background: Item This property holds the background item.

Note: the background will be automatically sized as the whole control

Definition at line 50 of file controls/templates/OverlayDrawer.qml.

int org::kde::kirigami::OverlayDrawer::bottomPadding

bottomPadding: int default contents padding at bottom

Definition at line 100 of file controls/templates/OverlayDrawer.qml.

Item org::kde::kirigami::OverlayDrawer::contentItem

contentItem: Item It's the part that can be pulled in and out, will act as a sidebar.

Definition at line 44 of file controls/templates/OverlayDrawer.qml.

int org::kde::kirigami::OverlayDrawer::edge

edge: enumeration This property holds the edge of the content item at which the drawer will open from.

The acceptable values are: Qt.TopEdge: The top edge of the content item. Qt.LeftEdge: The left edge of the content item (default). Qt.RightEdge: The right edge of the content item. Qt.BottomEdge: The bottom edge of the content item.

Definition at line 67 of file controls/templates/OverlayDrawer.qml.

bool org::kde::kirigami::OverlayDrawer::handleVisible

handleVisible: bool If true, a little handle will be visible to make opening the drawer easier Currently supported only on left and right drawers

Definition at line 80 of file controls/templates/OverlayDrawer.qml.

int org::kde::kirigami::OverlayDrawer::leftPadding

leftPadding: int default contents padding at left

Definition at line 85 of file controls/templates/OverlayDrawer.qml.

alias org::kde::kirigami::OverlayDrawer::opened

opened: bool If true the drawer is open showing the contents of the "drawer" component.

Definition at line 56 of file controls/templates/OverlayDrawer.qml.

alias org::kde::kirigami::OverlayDrawer::page

page: Item It's the default property.

it's the main content of the drawer page, the part that is always shown

Remarks

This is the default property

Definition at line 39 of file controls/templates/OverlayDrawer.qml.

real org::kde::kirigami::OverlayDrawer::position

position: real This property holds the position of the drawer relative to its final destination.

That is, the position will be 0 when the drawer is fully closed, and 1 when fully open.

Definition at line 74 of file controls/templates/OverlayDrawer.qml.

int org::kde::kirigami::OverlayDrawer::rightPadding

rightPadding: int default contents padding at right

Definition at line 95 of file controls/templates/OverlayDrawer.qml.

int org::kde::kirigami::OverlayDrawer::topPadding

topPadding: int default contents padding at top

Definition at line 90 of file controls/templates/OverlayDrawer.qml.

Member Function Documentation

void org::kde::kirigami::OverlayDrawer::close

(

)

close: function This method closes the drawer, animating the movement if a valid animation has been set.

void org::kde::kirigami::OverlayDrawer::open

(

)

modal: bool If true the drawer will be an overlay of the main content, obscuring it and blocking input.

If false, the drawer will look like a sidebar, with the main content application still usable. It is recomended to use modal on mobile devices and not modal on desktop devices. Default is true open: function This method opens the drawer, animating the movement if a valid animation has been set.

---

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

• controls/OverlayDrawer.qml