• Skip to content
  • Skip to link menu
Brand

API Documentation

  1. KDE API Reference
  2. Kirigami
  • KDE Home
  • Contact Us

Quick Links

Skip menu "Kirigami"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • File List
  • Related Pages

Class Picker

About

QtQuick plugins to build user interfaces based on the KDE UX guidelines

Maintainer
Marco Martin
Supported platforms
Android, Linux
Community
IRC: #plasma on Freenode
Mailing list: plasma-devel
Use with CMake
find_package(KF5Kirigami)
target_link_libraries(yourapp KF5::Kirigami)
Clone
git clone git://anongit.kde.org/kirigami1.git
Browse source
Kirigami on cgit.kde.org

Kirigami

  • View on LXR
  • org
  • kde
  • kirigami
  • SplitDrawer
Properties | List of all members
org::kde::kirigami::SplitDrawer Class Reference

Inherits org::kde::kirigami::AbstractDrawer, and SplitDrawer.

Properties

Item background
 
Item contentItem
 
alias opened
 
alias page
 
real position
 

Detailed Description

Split Drawers are used to expose additional UI elements which are optional and can be used in conjunction with the main UI elements.

For example the Resource Browser uses a Split Drawer to select different kinds of filters for the main view.

Definition at line 27 of file SplitDrawer.qml.

Property Documentation

Item org::kde::kirigami::SplitDrawer::background

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 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 75 of file templates/SplitDrawer.qml.

Item org::kde::kirigami::SplitDrawer::contentItem

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

Definition at line 41 of file templates/SplitDrawer.qml.

alias org::kde::kirigami::SplitDrawer::opened

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

Definition at line 47 of file templates/SplitDrawer.qml.

alias org::kde::kirigami::SplitDrawer::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 36 of file templates/SplitDrawer.qml.

real org::kde::kirigami::SplitDrawer::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 54 of file templates/SplitDrawer.qml.


The documentation for this class was generated from the following file:
  • SplitDrawer.qml
This file is part of the KDE documentation.
Documentation copyright © 1996-2017 The KDE developers.
Generated on Fri Feb 17 2017 11:09:23 by doxygen 1.8.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal