KDE API Reference

Contents

Action QML Type

An item that represents an abstract Action. More...

Import Statement: import org.kde.kirigami
Inherits:

Action

Inherited By:

PagePoolAction

Properties

Detailed Description

Property Documentation

autoExclusive : bool

*

This property holds whether auto-exclusivity is enabled. * * If auto-exclusivity is enabled, checkable actions that belong to the * same parent item behave as if they were part of the same ButtonGroup. * Only one action can be checked at any time; checking another action * automatically unchecks the previously checked one. * * default: false


children : T.Action [default]

This property holds a list of child actions.

This is useful for tree-like menus, such as the GlobalDrawer.

Example usage:

import QtQuick.Controls as QQC2
import org.kde.kirigami as Kirigami

Kirigami.Action {
   text: "Tools"

   QQC2.Action {
       text: "Action1"
   }
   Kirigami.Action {
       text: "Action2"
   }
}

displayComponent : Component [since 5.65]

This property holds the component that should be used for displaying this action.

Note: This can be used to display custom components in the toolbar.

This property was introduced in 5.65.


displayHint : int [since 2.12]

This property sets this action's display type.

These are provided to implementations to indicate a preference for certain display styles.

default: Kirigami.DisplayHint.NoPreference

Note: This property contains only preferences, implementations may choose to disregard them.

This property was introduced in 2.12.

See also DisplayHint.


expandible : bool [since 2.6]

This property sets whether this action becomes a title displaying its child actions as sub-items in GlobalDrawers and ContextDrawers.

default: false

This property was introduced in 2.6.


fromQAction : QtObject [since Kirigami 6.4]

This property holds a QAction

When provided Kirigami.Action will be initialized from the given QAction.

This property was introduced in Kirigami 6.4.


parent : T.Action

This property holds the parent action.


separator : bool

This property sets whether this action is a separator action.

default: false


tooltip : string

This property holds the tooltip text that is shown when the cursor is hovering over the control.

Leaving this undefined or setting it to an empty string means that no tooltip will be shown when the cursor is hovering over the control that triggers the tooltip.

Warning: Tooltips may not be supported on all platforms.


visible : bool

This property holds whether the graphic representation of the action is supposed to be visible.

It's up to the action representation to honor this property.

default: true


visibleChildren : T.Action [read-only]

This property holds the action's visible child actions.