org::kde::kirigami::ActionToolBar

Search for usage in LXR

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

Properties

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 the Action.displayComponent for an action. The ActionToolBar component will try to display has many actions as possible but 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.

Since
2.5

Definition at line 28 of file ActionToolBar.qml.

Property Documentation

◆ actions

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

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.

Definition at line 39 of file ActionToolBar.qml.

◆ alignment

int org::kde::kirigami::ActionToolBar::alignment
read

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

Definition at line 88 of file ActionToolBar.qml.

◆ display

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

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

Definition at line 73 of file ActionToolBar.qml.

◆ flat

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

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

default: true

Definition at line 58 of file ActionToolBar.qml.

◆ heightMode

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

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

Definition at line 144 of file ActionToolBar.qml.

◆ hiddenActions

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

This property holds a list of hidden actions.

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

Deprecated:
since 2.14, use the AlwaysHide hint on actions instead.
Since
2.6

Definition at line 49 of file ActionToolBar.qml.

◆ maximumContentWidth

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

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

Remarks
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 112 of file ActionToolBar.qml.

◆ overflowIconName

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

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

default: "overflow-menu"

Since
5.65
2.12

Definition at line 121 of file ActionToolBar.qml.

◆ position

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

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

◆ visibleWidth

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

This property holds the combined width of all visible delegates.

Definition at line 126 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 Tue Feb 7 2023 04:14:24 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.