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) |
![]() | |
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
◆ Action
|
read |
This property holds the parent action of this action.
Definition at line 66 of file Action.qml.
◆ __children
|
read |
Definition at line 123 of file Action.qml.
◆ children
|
read |
This property holds a list of child actions.
- Remarks
- This is the default property
This is useful for tree-like menus, such as the GlobalDrawer.
Definition at line 121 of file Action.qml.
◆ displayComponent
|
read |
This property holds the component that should be preferred for displaying this Action.
This can be used to display custom components in the toolbar.
- Since
- 5.65
- 2.12
Definition at line 101 of file Action.qml.
◆ displayHint
|
read |
This property holds a combination of values from the Action.DisplayHint enum.
These are provided to implementations to indicate a preference for certain display styles.
By default there is no display hint (DisplayHint.NoPreference
).
- Note
- This property contains only preferences, implementations may choose to disregard them.
- Since
- 2.12
Definition at line 78 of file Action.qml.
◆ expandible
|
read |
This property holds whether the actions in globalDrawers and contextDrawers will become titles displaying the child actions as sub items.
The default value is false
.
- Since
- 2.6
Definition at line 62 of file Action.qml.
◆ iconName
|
read |
This property holds the icon name for the action.
This will pick the icon with the given name from the current theme.
- Deprecated:
- Use icon.name instead.
Definition at line 32 of file Action.qml.
◆ iconSource
|
read |
This property holds an url to an icon file or resource url for the action.
By default this is an empty URL. Use this if you want a specific file rather than an icon from the theme
- Deprecated:
- Use icon.name instead.
Definition at line 41 of file Action.qml.
◆ separator
|
read |
This property holds whether the action is a separator action.
The default value is false
.
Definition at line 54 of file Action.qml.
◆ tooltip
|
read |
This property holds the tooltip text to be shown when hovering the control bound to this action.
- Warning
- Not all controls support tooltips on all platforms.
Definition at line 48 of file Action.qml.
◆ visible
|
read |
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.
The default value is true
.
Definition at line 25 of file Action.qml.
◆ visibleChildren
|
read |
This property holds the child actions that are visible.
- Remarks
- This property is read-only
Definition at line 130 of file Action.qml.
Member Function Documentation
◆ displayHintSet()
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
-
hint The 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:
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.