Search for usage in LXR

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


alias actions
alias alignment
int display
bool flat
alias heightMode
list< QtObject > hiddenActions
alias maximumContentWidth
string overflowIconName
int position
alias visibleWidth

Detailed Description

A toolbar built out of a list of actions.

The default representation for visible actions is a QtQuick.Controls.ToolButton, but it can be changed by setting Action::displayComponent to a different component.

The ActionToolBar component will try to display as many action delegates as possible but it will place those that do not fit into an overflow menu.

How actions are displayed can be changed by setting the displayHint in an action. For example, when setting it to DisplayHint.KeepVisible, it will try to keep that action in view as long as possible, using an icon-only button if the full-sized delegate does not fit.

See also
KDE Human Interface Guidelines on Toolbars
org.kde.kirigami 2.5

Definition at line 32 of file ActionToolBar.qml.

Property Documentation

◆ actions

list< Action > org::kde::kirigami::ActionToolBar::actions

This property holds a list of visible actions.

The ActionToolBar will try to display as many actions as possible. Those that do not fit go into a overflow menu.

Definition at line 43 of file ActionToolBar.qml.

◆ alignment

Qt::Alignment org::kde::kirigami::ActionToolBar::alignment

This property holds the alignment of the buttons.

When there is more space available than required by the visible delegates, we need to determine how to place the delegates.

When there is more space available than required by the visible action delegates, we need to determine where to position them.

default: Qt.AlignRight

See also

Definition at line 91 of file ActionToolBar.qml.

◆ display

int org::kde::kirigami::ActionToolBar::display

This property determines how the icon and text are displayed within the button.

The following values are allowed:

  • Button.IconOnly
  • Button.TextOnly
  • Button.TextBesideIcon
  • Button.TextUnderIcon

default: Controls.Button.TextBesideIcon

See also

Definition at line 76 of file ActionToolBar.qml.

◆ flat

bool org::kde::kirigami::ActionToolBar::flat

This property holds whether the buttons will have a flat appearance.

default: true

Definition at line 62 of file ActionToolBar.qml.

◆ heightMode

ToolBarLayout::HeightMode org::kde::kirigami::ActionToolBar::heightMode

This property sets the handling method for items that do not match the toolbar's height.

When toolbar items do not match the height of the toolbar, there are several ways we can deal with this. This property sets the preferred way.

The following values are allowed:

  • HeightMode.AlwaysCenter
  • HeightMode.AlwaysFill
  • HeightMode.ConstrainIfLarger

default: HeightMode::ConstrainIfLarger

See also

Definition at line 147 of file ActionToolBar.qml.

◆ hiddenActions

list< Action > org::kde::kirigami::ActionToolBar::hiddenActions

This property holds a list of hidden actions.

These actions will always be displayed in the overflow menu, even if there is enough space.

Since 2.14, set displayHint to DisplayHint.AlwaysHide in actions instead.
org.kde.kirigami 2.6

Definition at line 53 of file ActionToolBar.qml.

◆ maximumContentWidth

int org::kde::kirigami::ActionToolBar::maximumContentWidth

This property holds the maximum width of the content of this ToolBar.

This property is read-only

If the toolbar's width is larger than this value, empty space will be added on the sides, according to the Alignment property.

The value of this property is derived from the ToolBar's actions and their properties.

Definition at line 115 of file ActionToolBar.qml.

◆ overflowIconName

string org::kde::kirigami::ActionToolBar::overflowIconName

This property holds the Freedesktop standard icon name to use for the overflow menu button.

default: "overflow-menu"

KDE Frameworks 5.65
org.kde.kirigami 2.12

Definition at line 124 of file ActionToolBar.qml.

◆ position

int org::kde::kirigami::ActionToolBar::position

This property holds the position of the toolbar.

If this ActionToolBar is the contentItem of a QQC2 Toolbar, the position is bound to the ToolBar's position

The following values are allowed:

  • Controls.ToolBar.Header: The toolbar is at the top, as a window or page header.
  • Controls.ToolBar.Footer: The toolbar is at the bottom, as a window or page footer.

Definition at line 103 of file ActionToolBar.qml.

◆ visibleWidth

int org::kde::kirigami::ActionToolBar::visibleWidth

This property holds the combined width of all visible delegates.

Definition at line 129 of file ActionToolBar.qml.

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Oct 1 2023 03:58:23 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.