org::kde::kirigami::Action

Search for usage in LXR

org::kde::kirigami::Action Class Reference
Inheritance diagram for org::kde::kirigami::Action:

Properties

Controls Action
 
list< QtObject > __children
 
alias children
 
Component displayComponent
 
int displayHint
 
bool expandible
 
alias iconName
 
alias iconSource
 
bool separator
 
string tooltip
 
bool visible
 
var visibleChildren
 

Public Member Functions

void displayHintSet (hint)
 
- Public Member Functions inherited from QtQuick.Controls.Action
void toggle (source)
 
 toggled (checked)
 
 toggled (source)
 
void trigger (source)
 
void trigger (source)
 
 triggered (source)
 
 triggered (source)
 

Detailed Description

An item that represents an abstract Action.

Definition at line 15 of file Action.qml.

Property Documentation

list< Action > org::kde::kirigami::Action::children

A list of children actions.

Remarks
This is the default property

Useful for tree-like menus

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

Definition at line 96 of file Action.qml.

Component org::kde::kirigami::Action::displayComponent

A Component that should be preferred when displaying this Action.

Since
5.65
2.12

Definition at line 93 of file Action.qml.

int org::kde::kirigami::Action::displayHint

A combination of values from the Action.DisplayHint enum.

These are provided to implementations to indicate a preference for certain display styles. The default is DisplayHint.NoPreference.

Note that these are only preferences, implementations may choose to disregard them.

Since
2.12

Definition at line 72 of file Action.qml.

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

When true, actions in globalDrawers and contextDrawers will become titles displaying the child actions as sub items.

Since
2.6

Definition at line 61 of file Action.qml.

string org::kde::kirigami::Action::iconName

Sets the icon name for the action.

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

Definition at line 27 of file Action.qml.

string org::kde::kirigami::Action::iconSource

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 32 of file Action.qml.

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

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

Definition at line 56 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 36 of file Action.qml.

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

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 22 of file Action.qml.

list< Action > org::kde::kirigami::Action::visibleChildren

All child actions that are visible.

Remarks
This property is read-only

Definition at line 104 of file Action.qml.

Member Function Documentation

void org::kde::kirigami::Action::displayHintSet ( hint  )

Helper function to check if a certain display hint has been set.

This function is mostly convenience to enforce the mutual exclusivity of KeepVisible and AlwaysHide.

Parameters
hintThe display hint to check if it is set.
Returns
true if the hint was set for this action, false if not.
Since
2.12
Deprecated:
since 2.14, Use DisplayHint.displayHintSet(action, hint) instead.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Sep 23 2021 22:38:54 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.