org::kde::kirigami::PromptDialog Class Reference

Inheritance diagram for org::kde::kirigami::PromptDialog:

Properties
real	contentBottomPadding
real	contentLeftPadding
real	contentPadding
real	contentRightPadding
real	contentTopPadding
alias	mainItem
string	subtitle
Properties inherited from org::kde::kirigami::Dialog
real	absoluteMaximumHeight
real	absoluteMaximumWidth
alias	dialogChildren
alias	dialogData
bool	flatFooterButtons
Component	footerLeadingComponent
Component	footerTrailingComponent
list	Kirigami
Item	mainItem
real	maximumHeight
real	maximumWidth
real	preferredHeight
real	preferredWidth
bool	showCloseButton

Additional Inherited Members
Public Member Functions inherited from org::kde::kirigami::Dialog
void	standardButton (button)

Detailed Description

A simple dialog to quickly prompt a user with information, and possibly perform an action.

Provides content padding (instead of padding outside of the scroll area). Also has a default preferredWidth, as well as the subtitle property.

Note: If a mainItem is specified, it will replace the subtitle label, and so the respective property will have no effect.

See also

Dialog

MenuDialog

Example usage:

Kirigami.PromptDialog {
    title: "Reset settings?"
    subtitle: "The stored settings for the application will be deleted, with the defaults restored."
    standardButtons: Kirigami.Dialog.Ok | Kirigami.Dialog.Cancel
 
    onAccepted: console.log("Accepted")
    onRejected: console.log("Rejected")
}

Text field prompt dialog:

Kirigami.PromptDialog {
    id: textPromptDialog
    title: "New Folder"
 
    standardButtons: Kirigami.Dialog.None
    customFooterActions: [
        Kirigami.Action {
            text: qsTr("Create Folder")
            iconName: "dialog-ok"
            onTriggered: {
                showPassiveNotification("Created");
                textPromptDialog.close();
            }
        },
        Kirigami.Action {
            text: qsTr("Cancel")
            iconName: "dialog-cancel"
            onTriggered: {
                textPromptDialog.close();
            }
        }
    ]
 
    Controls.TextField {
        placeholderText: qsTr("Folder name...")
    }
}

Definition at line 70 of file PromptDialog.qml.

Property Documentation

contentBottomPadding

real org::kde::kirigami::PromptDialog::contentBottomPadding

read

The bottom padding of the content, within the scroll area.

Definition at line 92 of file PromptDialog.qml.

contentLeftPadding

real org::kde::kirigami::PromptDialog::contentLeftPadding

read

The left padding of the content, within the scroll area.

Definition at line 96 of file PromptDialog.qml.

contentPadding

real org::kde::kirigami::PromptDialog::contentPadding

read

The padding around the content, within the scroll area.

Default is Kirigami.Units.largeSpacing.

Definition at line 84 of file PromptDialog.qml.

contentRightPadding

real org::kde::kirigami::PromptDialog::contentRightPadding

read

The right padding of the content, within the scroll area.

Definition at line 100 of file PromptDialog.qml.

contentTopPadding

real org::kde::kirigami::PromptDialog::contentTopPadding

read

The top padding of the content, within the scroll area.

Definition at line 88 of file PromptDialog.qml.

mainItem

alias org::kde::kirigami::PromptDialog::mainItem

read

Remarks

This is the default property

Definition at line 74 of file PromptDialog.qml.

subtitle

string org::kde::kirigami::PromptDialog::subtitle

read

The text to use in the dialog's contents.

Definition at line 78 of file PromptDialog.qml.

---

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

• PromptDialog.qml