org::kde::kirigami::Action Class Reference

Inherits QtObject, and QtObject.

Properties
list< QtObject >	__children
Shortcut	__shortcut
bool	checkable
bool	checked
alias	children
bool	enabled
bool	expandible
ActionIconGroup	icon
alias	iconName
alias	iconSource
QtObject	parent
bool	separator
alias	shortcut
string	text
string	tooltip
bool	visible
var	visibleChildren

Signals
void	toggled (bool checked)
void	triggered (QtObject source)

Public Member Functions
void	trigger (source)

Detailed Description

An item that represents an abstract Action.

Definition at line 26 of file Action.qml.

Property Documentation

bool org::kde::kirigami::Action::checkable

checkable: bool Whether action can be checked, or toggled.

Defaults to false.

Definition at line 51 of file Action.qml.

bool org::kde::kirigami::Action::checked

checked: bool Whether the action is checked.

Defaults to false.

Definition at line 56 of file Action.qml.

alias org::kde::kirigami::Action::children

Remarks

This is the default property

Definition at line 141 of file Action.qml.

bool org::kde::kirigami::Action::enabled

enabled: bool Whether the action is enabled, and can be triggered.

Defaults to true.

Definition at line 61 of file Action.qml.

bool org::kde::kirigami::Action::expandible

expandible: bool When true, actions in globalDrawers and contextDrawers will become titles displaying te child actions as sub items

Since

2.6

Definition at line 136 of file Action.qml.

ActionIconGroup org::kde::kirigami::Action::icon

metadata for the icon, such as width/height.name and source

• name This property holds the name of the icon to use. The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead. For more information on theme icons, see QIcon::fromTheme().
• source This property holds the name of the icon to use. The icon will be loaded as a regular image. If icon.name is set and refers to a valid theme icon, it will always be used instead of this property.
• width This property holds the width of the icon. The icon's width will never exceed this value, though it will shrink when necessary. height This property holds the height of the icon. The icon's height will never exceed this value, though it will shrink when necessary.

*color This property holds the color of the icon. The icon is tinted with the specified color, unless the color is set to "transparent".

Definition at line 96 of file Action.qml.

alias org::kde::kirigami::Action::iconName

iconName: string Sets the icon name for the action.

This will pick the icon with the given name from the current theme.

Definition at line 66 of file Action.qml.

alias org::kde::kirigami::Action::iconSource

iconSource: string Sets the icon file or resource url for the action.

Defaults to the empty URL. Use this if you want a specific file rather than an icon from the theme

Definition at line 71 of file Action.qml.

bool org::kde::kirigami::Action::separator

children: list<Action> A list of children actions.

Useful for tree-like menus

Action {
   text: "Tools"
   Action {
       text: "Action1"
   }
   Action {
       text: "Action2"
   }
}

separator: bool Whether the action is is a separator action; defaults to false.

Definition at line 130 of file Action.qml.

alias org::kde::kirigami::Action::shortcut

shortcut : keysequence Shortcut bound to the action.

The keysequence can be a string or a Qt standard key.

Definition at line 101 of file Action.qml.

string org::kde::kirigami::Action::text

Text for the action.

This text will show as the button text, or as title in a menu item, depending from the way the developer will choose to represent it

Definition at line 105 of file Action.qml.

string org::kde::kirigami::Action::tooltip

A tooltip text to be shown when hovering the control bound to this action.

Not all controls support tooltips on all platforms

Definition at line 109 of file Action.qml.

bool org::kde::kirigami::Action::visible

visible: bool True (default) when the graphic representation of the action is supposed to be visible.

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

Definition at line 46 of file Action.qml.

var org::kde::kirigami::Action::visibleChildren

visibleChildren: list<Action> All child actions that are visible

Remarks

This property is read-only

Definition at line 149 of file Action.qml.

Member Function Documentation

void org::kde::kirigami::Action::toggled ( bool  checked )

signal

Emitted whenever a action's checked property changes.

This usually happens at the same time as triggered.

Parameters

checked

void org::kde::kirigami::Action::triggered ( QtObject  source )

signal

Emitted when either the menu item or its bound action have been activated.

Includes the object that triggered the event if relevant (e.g. a Button). You shouldn't need to emit this signal, use trigger() instead.

Parameters

source

Object that triggered the event if relevant, often null

---

The documentation for this class was generated from the following file:

• Action.qml