org::kde::kirigami::templates::InlineMessage Class Reference

Inherits Control.

Properties
bool	_animating
list< QtObject >	actions
bool	animating
IconPropertiesGroup	icon
bool	showCloseButton
string	text
int	type

Signals
void	linkActivated (string link)
void	linkHovered (string link)

Detailed Description

An inline message item with support for informational, positive, warning and error types, and with support for associated actions.

InlineMessage can be used to give information to the user or interact with the user, without requiring the use of a dialog.

The InlineMessage item is hidden by default. It also manages its height (and implicitHeight) during an animated reveal when shown. You should avoid setting height on an InlineMessage unless it is already visible.

Optionally an icon can be set, defaulting to an icon appropriate to the message type otherwise.

Optionally a close button can be shown.

Actions are added from left to right. If more actions are set than can fit, an overflow menu is provided.

Example:

InlineMessage {
    type: Kirigami.MessageType.Error

    text: "My error message"

    actions: [
        Kirigami.Action {
            iconName: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        },
        Kirigami.Action {
            iconName: "edit"
            text: "Action text"
            onTriggered: {
                // do stuff
            }
        }
    ]
}

Since

5.45

Definition at line 73 of file controls/templates/InlineMessage.qml.

Property Documentation

list<QtObject> org::kde::kirigami::templates::InlineMessage::actions

actions: list<Action> The list of actions to show.

Actions are added from left to right. If more actions are set than can fit, an overflow menu is provided.

Definition at line 118 of file controls/templates/InlineMessage.qml.

bool org::kde::kirigami::templates::InlineMessage::animating

animating: bool True while the message item is animating.

Remarks

This property is read-only

Definition at line 124 of file controls/templates/InlineMessage.qml.

IconPropertiesGroup org::kde::kirigami::templates::InlineMessage::icon

A grouped property describing an optional icon.

• source: The source of the icon, a freedesktop-compatible icon name is recommended.
• color: An optional tint color for the icon.

If no custom icon is set, an icon appropriate to the message type is shown.

Definition at line 100 of file controls/templates/InlineMessage.qml.

bool org::kde::kirigami::templates::InlineMessage::showCloseButton

showCloseButton: bool When enabled, a close button is shown.

The default is false.

Definition at line 111 of file controls/templates/InlineMessage.qml.

string org::kde::kirigami::templates::InlineMessage::text

text: string The message text.

Definition at line 105 of file controls/templates/InlineMessage.qml.

int org::kde::kirigami::templates::InlineMessage::type

type: int The message type.

One of Information, Positive, Warning or Error.

The default is Kirigami.MessageType.Information.

Definition at line 91 of file controls/templates/InlineMessage.qml.

Member Function Documentation

void org::kde::kirigami::templates::InlineMessage::linkActivated ( string  link )

signal

Emitted when a link is clicked or tapped in the message text.

Parameters

The	clicked or tapped link.

void org::kde::kirigami::templates::InlineMessage::linkHovered ( string  link )

signal

Emitted when a link is hovered in the message text.

Parameters

The	hovered link.

---

The documentation for this class was generated from the following file:

• controls/templates/InlineMessage.qml