org::kde::kirigami::ContextDrawer Class Reference

Inheritance diagram for org::kde::kirigami::ContextDrawer:

Properties
var	actions
alias	footer
alias	header
Page	page
string	title
Properties inherited from org::kde::kirigami::templates::OverlayDrawer
QtObject	__internal
bool	animating
bool	collapsed
int	collapsedSize
bool	collapsible
bool	drawerOpen
bool	enabled
Item	handle
IconPropertiesGroup	handleClosedIcon
string	handleClosedToolTip
IconPropertiesGroup	handleOpenIcon
string	handleOpenToolTip
bool	handleVisible
bool	peeking

Detailed Description

A drawer specialization that will show a list of actions that are specific of the current page shown by the application.

Example usage:

import org.kde.kirigami 2.4 as Kirigami
 
Kirigami.ApplicationWindow {
 [...]
    contextDrawer: Kirigami.ContextDrawer {
        id: contextDrawer
    }
 [...]
}

import org.kde.kirigami 2.4 as Kirigami
 
Kirigami.Page {
  [...]
    contextualActions: [
        Kirigami.Action {
            icon.name: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        },
        Kirigami.Action {
            icon.name: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        }
    ]
  [...]
}

Definition at line 54 of file ContextDrawer.qml.

Property Documentation

actions

var org::kde::kirigami::ContextDrawer::actions

read

actions: list<Action> This can be any type of object that a ListView can accept as model.

It expects items compatible with either QAction or Kirigami Action

Definition at line 66 of file ContextDrawer.qml.

footer

alias org::kde::kirigami::ContextDrawer::footer

read

footer: Component Arbitrary content that will go to the bottom of the list (by default is empty)

Since

2.7

Definition at line 80 of file ContextDrawer.qml.

header

alias org::kde::kirigami::ContextDrawer::header

read

header: Component Arbitrary content that will go on top of the list (by default is the title)

Since

2.7

Definition at line 74 of file ContextDrawer.qml.

title

string org::kde::kirigami::ContextDrawer::title

read

title: string A title for the action list that will be shown to the user when opens the drawer

Definition at line 60 of file ContextDrawer.qml.

---

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

• ContextDrawer.qml