org::kde::kirigami::templates::InlineMessage

Search for usage in LXR

org::kde::kirigami::templates::InlineMessage Class Reference
Inheritance diagram for org::kde::kirigami::templates::InlineMessage:

Properties

bool _animating
 
list< QtObject > actions
 
bool animating
 
string hoveredLink
 
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:

type: Kirigami.MessageType.Error
text: "My error message"
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
},
Kirigami.Action {
icon.name: "edit"
text: "Action text"
onTriggered: {
// do stuff
}
}
]
}
Since
5.45

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

Property Documentation

◆ actions

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

This property holds 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 111 of file controls/templates/InlineMessage.qml.

◆ animating

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

This property holds whether the current message item is animating.

Remarks
This property is read-only

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

◆ hoveredLink

string org::kde::kirigami::templates::InlineMessage::hoveredLink
read

This property holds the link embedded in the message text that the user is hovering over.

Remarks
This property is read-only

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

◆ icon

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

This grouped property holds the description of 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 95 of file controls/templates/InlineMessage.qml.

◆ showCloseButton

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

This property holds whether the close button is displayed.

The default is false.

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

◆ text

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

This property holds the message text.

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

◆ type

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

This property holds the message type.

One of Information, Positive, Warning or Error.

The default is Kirigami.MessageType.Information.

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

Member Function Documentation

◆ linkActivated

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

This signal is emitted when a link is clicked or tapped in the message text.

Parameters
Theclicked or tapped link.

◆ linkHovered

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

This signal is emitted when a link is hovered in the message text.

Parameters
Thehovered link.

The documentation for this class was generated from the following file:
list< QtObject > actions
This property holds the list of actions to show.
string text
This property holds the message text.
An inline message item with support for informational, positive, warning and error types,...
IconPropertiesGroup icon
This grouped property holds the description of an optional icon.
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:13:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.