ContextDrawer

Search for usage in LXR

ContextDrawer Class Reference
Inheritance diagram for ContextDrawer:

Properties

listTAction actions
 
alias footer
 
bool handleVisible
 
alias header
 
string title
 
- Properties inherited from org::kde::kirigami::templates::OverlayDrawer
bool animating
 
bool collapsed
 
int collapsedSize
 
bool collapsible
 
bool drawerOpen
 
Item handle
 
KTPIconPropertiesGroup handleClosedIcon
 
string handleClosedToolTip
 
KTPIconPropertiesGroup handleOpenIcon
 
string handleOpenToolTip
 
bool handleVisible
 
bool peeking
 

Public Member Functions

void visibleActions ()
 

Detailed Description

A specialized type of drawer that will show a list of actions relevant to the application's current page.

Example usage:

import org.kde.kirigami as Kirigami
Kirigami.ApplicationWindow {
contextDrawer: Kirigami.ContextDrawer {
enabled: true
actions: [
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 45 of file ContextDrawer.qml.

Property Documentation

◆ actions

list< T.Action > ContextDrawer::actions
read

List of contextual actions to be displayed in a ListView.

See also
QtQuick.Action
org::kde::kirigami::Action

Definition at line 62 of file ContextDrawer.qml.

◆ footer

Component ContextDrawer::footer
read

Arbitrary content to show below the list view.

Since
2.7

Definition at line 78 of file ContextDrawer.qml.

◆ handleVisible

bool ContextDrawer::handleVisible
read

Definition at line 93 of file ContextDrawer.qml.

◆ header

Component ContextDrawer::header
read

Arbitrary content to show above the list view.

default: an Item containing a Kirigami.Heading that displays a title whose text is controlled by the title property.

Since
2.7

Definition at line 72 of file ContextDrawer.qml.

◆ title

string ContextDrawer::title
read

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

default: qsTr("Actions")

Definition at line 54 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-2024 The KDE developers.
Generated on Fri May 17 2024 11:49:07 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.