MessageDialog Class Reference

Public Types
enum class	DialogType { Success , Warning , Error , Information }

Properties
int	dialogType
string	dontShowAgainName
string	iconName
alias	mainContent

Public Member Functions
void	openDialog ()

Detailed Description

A dialog to show a message.

This dialog exists has 4 modes: success, warning, error, information.

Definition at line 17 of file MessageDialog.qml.

Member Enumeration Documentation

DialogType

enum class MessageDialog::DialogType

strong

Definition at line 19 of file MessageDialog.qml.

Property Documentation

dialogType

int MessageDialog::dialogType

read

This property holds the dialogType.

It can be either:

• MessageDialog.Success: For a sucess message
• MessageDialog.Warning: For a warning message
• MessageDialog.Error: For an actual error
• MessageDialog.Information: For an informational message

By default, the dialogType is MessageDialog.Success

Definition at line 35 of file MessageDialog.qml.

dontShowAgainName

string MessageDialog::dontShowAgainName

read

This property holds the name of setting to store the "dont's show again" preference.

If provided, a checkbox is added with which further notifications can be turned off. The string is used to lookup and store the setting in the applications config file. The setting is stored in the "Notification Messages" group.

When set use, openDialog() instead of open() to open this dialog.

Warning

Overwriting the dialog's footer will disable this feature.

Definition at line 47 of file MessageDialog.qml.

iconName

string MessageDialog::iconName

read

Definition at line 52 of file MessageDialog.qml.

mainContent

alias MessageDialog::mainContent

read

Remarks

This is the default property

Definition at line 50 of file MessageDialog.qml.

Member Function Documentation

openDialog()

void MessageDialog::openDialog

(

)

Open the dialog only if the user didn't check the "do not remind me" checkbox previously.

---

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

• MessageDialog.qml