org::kde::kirigami::GlobalDrawer

Properties | |
list< QtObject > | actions |
alias | bannerImageSource |
bool | bannerVisible |
bool | collapseButtonVisible |
alias | content |
Action | currentSubMenu |
Item | header |
bool | isMenu |
bool | resetMenuOnTriggered |
bool | showContentWhenCollapsed |
bool | showHeaderWhenCollapsed |
bool | showTopContentWhenCollapsed |
alias | title |
alias | titleIcon |
alias | topContent |
![]() | |
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 |
Signals | |
void | bannerClicked () |
Public Member Functions | |
void | resetMenu () |
Detailed Description
A drawer specialization intended for the global actions of the application valid regardless of the application state (think about the menubar of a desktop application).
Example usage:
Definition at line 49 of file GlobalDrawer.qml.
Property Documentation
◆ actions
|
read |
The list of actions can be nested having a tree structure. A tree depth bigger than 2 is discouraged.
Example usage:
Definition at line 105 of file GlobalDrawer.qml.
◆ bannerImageSource
|
read |
An image to be used as background for the title and icon for a decorative purpose. It accepts any url format supported by Image
Definition at line 68 of file GlobalDrawer.qml.
◆ bannerVisible
|
read |
if true the banner area, which can contain an image, an icon and a title will be visible.
By default the banner will be visible only on mobile platforms
- Since
- 2.12
Definition at line 120 of file GlobalDrawer.qml.
◆ collapseButtonVisible
|
read |
When the sidebar is collapsible, this controls the visibility of the collapse button.
- Since
- 2.12
Definition at line 214 of file GlobalDrawer.qml.
◆ content
|
read |
- Remarks
- This is the default property
Any random Item can be instantiated inside the drawer and will be displayed underneath the actions list.
This is the default property.
Example usage:
Definition at line 146 of file GlobalDrawer.qml.
◆ currentSubMenu
|
read |
Points to the action acting as a submenu.
- Remarks
- This property is read-only
Definition at line 199 of file GlobalDrawer.qml.
◆ header
|
read |
an item that will stay on top of the drawer, and if the drawer contents can be scrolled, this item will stay still and won't scroll.
Intended mainly for toolbars
- Since
- 2.12
Definition at line 113 of file GlobalDrawer.qml.
◆ isMenu
|
read |
When true the global drawer becomes a menu on the desktop.
Defauls to false.
- Since
- 2.11
Definition at line 204 of file GlobalDrawer.qml.
◆ resetMenuOnTriggered
|
read |
On the actions menu, whenever a leaf action is triggered, the menu will reset to its parent.
Definition at line 194 of file GlobalDrawer.qml.
◆ showContentWhenCollapsed
|
read |
If true, when the drawer is collapsed as a sidebar, the content items at the bottom will be hidden (default false).
If you want to keep some items visible and some invisible, set this to false and control the visibility/opacity of individual items, binded to the collapsed property
- Since
- 2.5
Definition at line 178 of file GlobalDrawer.qml.
◆ showTopContentWhenCollapsed
|
read |
If true, when the drawer is collapsed as a sidebar, the top content items at the top will be hidden (default false).
If you want to keep some items visible and some invisible, set this to false and control the visibility/opacity of individual items, binded to the collapsed property
- Since
- 2.5
Definition at line 187 of file GlobalDrawer.qml.
◆ title
|
read |
A title to be displayed on top of the drawer
Definition at line 55 of file GlobalDrawer.qml.
◆ topContent
|
read |
Items that will be instantiated inside the drawer and will be displayed on top of the actions list.
Example usage:
Definition at line 169 of file GlobalDrawer.qml.
Member Function Documentation
◆ bannerClicked
|
signal |
Notifies that the banner has been clicked.
◆ resetMenu()
void org::kde::kirigami::GlobalDrawer::resetMenu | ( | ) |
Reverts the menu back to its initial state.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Jul 4 2022 04:09:39 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.