org::kde::kirigami::InlineMessage

Search for usage in LXR

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

Additional Inherited Members

- Properties inherited from org::kde::kirigami::templates::InlineMessage
bool _animating
 
list< QtObject > actions
 
bool animating
 
string hoveredLink
 
IconPropertiesGroup icon
 
bool showCloseButton
 
string text
 
int type
 
- Signals inherited from org::kde::kirigami::templates::InlineMessage
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 usage:

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 59 of file controls/InlineMessage.qml.


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.