org::kde::kirigami::GlobalDrawer Class Reference

Inheritance diagram for org::kde::kirigami::GlobalDrawer:

Properties
list< QtObject >	actions
alias	bannerImageSource
alias	content
Action	currentSubMenu
bool	resetMenuOnTriggered
alias	title
alias	titleIcon
alias	topContent
Properties inherited from org::kde::kirigami::OverlayDrawer
Item	background
int	bottomPadding
Item	contentItem
int	edge
bool	handleVisible
int	leftPadding
alias	opened
alias	page
real	position
int	rightPadding
int	topPadding

Signals
void	bannerClicked ()

Public Member Functions
void	resetMenu ()
Public Member Functions inherited from org::kde::kirigami::OverlayDrawer
void	close ()
void	open ()

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:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    globalDrawer: Kirigami.GlobalDrawer {
        actions: [
           Kirigami.Action {
               text: "View"
               iconName: "view-list-icons"
               Kirigami.Action {
                       text: "action 1"
               }
               Kirigami.Action {
                       text: "action 2"
               }
               Kirigami.Action {
                       text: "action 3"
               }
           },
           Kirigami.Action {
               text: "Sync"
               iconName: "folder-sync"
           }
        ]
    }
 [...]
}

Definition at line 63 of file GlobalDrawer.qml.

Property Documentation

list<QtObject> org::kde::kirigami::GlobalDrawer::actions

actions: list<Action> The list of actions can be nested having a tree structure.

A tree depth bigger than 2 is discouraged.

Example usage:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    globalDrawer: Kirigami.GlobalDrawer {
        actions: [
           Kirigami.Action {
               text: "View"
               iconName: "view-list-icons"
               Kirigami.Action {
                       text: "action 1"
               }
               Kirigami.Action {
                       text: "action 2"
               }
               Kirigami.Action {
                       text: "action 3"
               }
           },
           Kirigami.Action {
               text: "Sync"
               iconName: "folder-sync"
           }
        ]
    }
 [...]
}

Definition at line 119 of file GlobalDrawer.qml.

alias org::kde::kirigami::GlobalDrawer::bannerImageSource

bannerImageSource: string 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 82 of file GlobalDrawer.qml.

alias org::kde::kirigami::GlobalDrawer::content

content: list<Item> default property Any random Item can be instantiated inside the drawer and will be displayed underneath the actions list.

Example usage:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    globalDrawer: Kirigami.GlobalDrawer {
        actions: [...]
        Button {
            text: "Button"
            onClicked: //do stuff
        }
    }
 [...]
}

Remarks

This is the default property

Definition at line 143 of file GlobalDrawer.qml.

Action org::kde::kirigami::GlobalDrawer::currentSubMenu

currentSubMenu: Action

Points to the action acting as a submenu

Remarks

This property is read-only

Definition at line 180 of file GlobalDrawer.qml.

bool org::kde::kirigami::GlobalDrawer::resetMenuOnTriggered

resetMenuOnTriggered: bool

On the actions menu, whenever a leaf action is triggered, the menu will reset to its parent.

Definition at line 173 of file GlobalDrawer.qml.

alias org::kde::kirigami::GlobalDrawer::title

title: string A title to be displayed on top of the drawer

Definition at line 69 of file GlobalDrawer.qml.

alias org::kde::kirigami::GlobalDrawer::titleIcon

icon: var An icon to be displayed alongside the title.

It can be a QIcon, a fdo-compatible icon name, or any url understood by Image

Definition at line 75 of file GlobalDrawer.qml.

alias org::kde::kirigami::GlobalDrawer::topContent

topContent: list<Item> default property Items that will be instantiated inside the drawer and will be displayed on top of the actions list.

Example usage:

import org.kde.kirigami 1.0 as Kirigami

Kirigami.ApplicationWindow {
 [...]
    globalDrawer: Kirigami.GlobalDrawer {
        actions: [...]
        topContent: [Button {
            text: "Button"
            onClicked: //do stuff
        }]
    }
 [...]
}

Definition at line 166 of file GlobalDrawer.qml.

Member Function Documentation

void org::kde::kirigami::GlobalDrawer::bannerClicked ( )

signal

Notifies that the banner has been clicked.

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:

• GlobalDrawer.qml