org::kde::kirigami::ContextDrawer

Search for usage in LXR

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

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

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.

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

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

Since
2.7

Definition at line 80 of file ContextDrawer.qml.

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

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.

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

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat May 15 2021 22:38:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.