Search for usage in LXR

ActionToolBar Class Reference
Inheritance diagram for ActionToolBar:


alias actions
alias alignment
int display
bool flat
alias heightMode
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 the Action.displayComponent for an action. The default behavior of ActionToolBar is to display as many actions as possible, placing those that will not fit into an overflow menu. This can be changed by setting the displayHint property on an Action. For example, when setting the DisplayHint.KeepVisible display hint, ActionToolBar will try to keep that action in view as long as possible, using an icon-only button if a button with text does not fit.


Definition at line 27 of file ActionToolBar.qml.

Property Documentation

◆ actions

list< Action > ActionToolBar::actions

This property holds a list of visible actions.

This property is read-only

The ActionToolBar will try to display as many actions as possible. Those that won't fit will go into an overflow menu.

Definition at line 39 of file ActionToolBar.qml.

◆ alignment

int 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.AlignLeft

See also

Definition at line 75 of file ActionToolBar.qml.

◆ display

int ActionToolBar::display

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

Permitted values are:

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

default: Controls.Button.TextBesideIcon

See also

Definition at line 60 of file ActionToolBar.qml.

◆ flat

bool ActionToolBar::flat

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

default: true

Definition at line 45 of file ActionToolBar.qml.

◆ heightMode

ToolBarLayout::HeightMode 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.

Permitted values are:

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

default: HeightMode::ConstrainIfLarger

See also

Definition at line 132 of file ActionToolBar.qml.

◆ maximumContentWidth

int 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 99 of file ActionToolBar.qml.

◆ overflowIconName

string ActionToolBar::overflowIconName

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

default: "overflow-menu"


Definition at line 108 of file ActionToolBar.qml.

◆ position

int 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

Permitted values are:

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

Definition at line 87 of file ActionToolBar.qml.

◆ visibleWidth

int ActionToolBar::visibleWidth

This property holds the combined width of all visible delegates.

This property is read-only

Definition at line 114 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-2024 The KDE developers.
Generated on Fri May 17 2024 11:49:07 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.