KDE API Reference

Contents

ActionToolBar QML Type

A toolbar built out of a list of actions. More...

Import Statement: import org.kde.kirigami
Since: 2.5
Inherits:

Control

Properties

Detailed Description

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.

Property Documentation

actions : list<Action> [read-only]

This property holds a list of visible actions.

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


alignment : Qt::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 Qt::AlignmentFlag.


display : int

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 QtQuick.Controls.AbstractButton.


flat : bool

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

default: true


heightMode : enumeration

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
  • HeightMode.ConstrainIfLarger

default: HeightMode::ConstrainIfLarger


maximumContentWidth : int [read-only]

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

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.


overflowIconName : string [since 5.65]

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

default: "overflow-menu"

This property was introduced in 5.65.


position : int

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.

visibleWidth : int [read-only]

This property holds the combined width of all visible delegates.