Тип QML MessageDialog

Компонент диалога для отображения всплывающих сообщений. Подробнее...

• Список всех членов, включая унаследованные

Свойства

• clickedButton : StandardButton
• detailedText : строка
• icon : QQuickStandardIcon::Icon
• informativeText : строка
• modality : Qt::WindowModality
• standardButtons : StandardButtons
• text : строка
• title : строка
• visible : bool

Сигналы

• accepted()
• apply()
• discard()
• help()
• no()
• rejected()
• reset()
• yes()

Методы

• void close()
• void open()

Подробное описание

Наиболее простое использование MessageDialog — это всплывающее уведомление. Оно также позволяет пользователю реагировать различными способами в зависимости от включенных кнопок. Диалог изначально невидим. Сначала необходимо установить нужные свойства, а затем установить visible в true или вызвать open().

Вот минимальный пример, демонстрирующий уведомление и завершение после ответа пользователя:

import QtQuick 2.2
import QtQuick.Dialogs 1.1

MessageDialog {
    id: messageDialog
    title: "May I have your attention please"
    text: "It's so cool that you are using Qt Quick."
    onAccepted: {
        console.log("And of course you could only agree.")
        Qt.quit()
    }
    Component.onCompleted: visible = true
}

Существует несколько возможных обработчиков в зависимости от стандартных кнопок диалога и ButtonRole каждой. Например, обработчик onRejected будет вызван, если пользователь нажмет кнопку Отмена, Закрыть или Прервать.

Окно MessageDialog автоматически является временным для родительского окна. Таким образом, независимо от того, объявляете ли вы диалог внутри Item или внутри Window, диалог будет отображаться по центру над окном, содержащим элемент, или над окном, которое вы объявили.

Реализация MessageDialog будет платформенным диалогом сообщения, если это возможно. Если это невозможно, то она попытается создать QMessageBox. Если и это невозможно, то она вернется к реализации QML, DefaultMessageDialog.qml. В этом случае вы можете настроить внешний вид, отредактировав этот файл. DefaultMessageDialog.qml содержит Rectangle для размещения содержимого диалога, поскольку некоторые встроенные системы не поддерживают несколько окон верхнего уровня. Когда диалог становится видимым, он автоматически будет обернут в Window, если это возможно, или просто будет переродительским над основным окном, если может быть только одно окно.

Документация по свойствам

clickedButton : StandardButton

Это свойство содержит нажатую пользователем кнопку. Его значение является одним из флагов, установленных для свойства standardButtons.

detailedText : строка

Текст, который будет отображаться в области подробностей, которая по умолчанию скрыта. Пользователь сможет нажать кнопку Показать подробности..., чтобы сделать ее видимой.

См. также text.

icon : QQuickStandardIcon::Icon

Иконка диалогового окна сообщения может быть указана одним из этих значений:

без иконки	StandardIcon.NoIcon	Для простого текстового уведомления.
	StandardIcon.Question	Для вопроса во время обычной работы.
	StandardIcon.Information	Для сообщений об информации об обычной работе.
	StandardIcon.Warning	Для сообщений о некритических ошибках.
	StandardIcon.Critical	Для сообщений о критических ошибках.

По умолчанию StandardIcon.NoIcon.

Значения перечисления такие же, как в QMessageBox::Icon.

informativeText : строка

Информативный текст, предоставляющий более подробное описание сообщения.

Информативный текст может использоваться для дополнения text, чтобы предоставить пользователю больше информации. В зависимости от платформы он может отображаться мелким шрифтом ниже текста или просто приписываться к тексту.

См. также text.

modality : Qt::WindowModality

Определяет, должен ли диалог отображаться в модальном режиме относительно окна, содержащего родительский элемент диалога, в модальном режиме относительно всего приложения или в немодальном режиме.

По умолчанию это Qt.WindowModal.

Модальность не означает наличие каких-либо блокирующих вызовов для ожидания подтверждения или отклонения диалога; она лишь предотвращает взаимодействие пользователя с родительским окном и/или окнами приложения до закрытия диалога.

standardButtons : StandardButtons

У MessageDialog есть строка кнопок внизу, каждая из которых имеет ButtonRole, определяющий, какой сигнал будет отправлен при нажатии на кнопку. Вы также можете узнать, какая именно кнопка была нажата после этого, через свойство clickedButton. Вы можете контролировать доступные кнопки, установив standardButtons в комбинацию флагов с помощью побитового ИЛИ:

Например, следующий диалог задаст вопрос с 5 возможными ответами:

import QtQuick 2.2
import QtQuick.Dialogs 1.1

MessageDialog {
    title: "Overwrite?"
    icon: StandardIcon.Question
    text: "file.txt already exists.  Replace?"
    detailedText: "To replace a file means that its existing contents will be lost. " +
        "The file that you are copying now will be copied over it instead."
    standardButtons: StandardButton.Yes | StandardButton.YesToAll |
        StandardButton.No | StandardButton.NoToAll | StandardButton.Abort
    Component.onCompleted: visible = true
    onYes: console.log("copied")
    onNo: console.log("didn't copy")
    onRejected: console.log("aborted")
}

По умолчанию StandardButton.Ok.

Значения перечисления такие же, как в QMessageBox::StandardButtons.

text : string

Основной текст для отображения.

title : string

Заголовок окна диалога.

visible : bool

Это свойство определяет, видимый ли диалог. По умолчанию это false.

См. также modality.

Документация по сигналам

accepted()

Этот сигнал испускается, когда пользователь нажал любую кнопку с AcceptRole: ОК, Открыть, Сохранить, Сохранить всё, Повторить или Пропустить.

Соответствующий обработчик onAccepted.

apply()

Этот сигнал испускается, когда пользователь нажал кнопку Применить.

Соответствующий обработчик onApply.

discard()

Этот сигнал испускается, когда пользователь нажал кнопку Отменить.

Соответствующий обработчик onDiscard.

help()

Этот сигнал испускается, когда пользователь нажал кнопку Справка. В зависимости от платформы, диалог может не закрываться автоматически, потому что справка вашего приложения должна быть актуальной для текста, показанного в этом диалоге, чтобы помочь пользователю принять решение. Однако на других платформах нельзя отобразить диалог и окно справки одновременно. Если вы хотите убедиться, что диалог закроется, вы можете установить visible на false в своём обработчике.

Соответствующий обработчик onHelp.

no()

Этот сигнал испускается, когда пользователь нажал любую кнопку с NoRole: Нет или Нет для всех.

Соответствующий обработчик onNo.

rejected()

Этот сигнал испускается, когда пользователь закрыл диалог, закрыв окно диалога, нажав на кнопку Отмена, Закрыть или Прервать в диалоге, или нажав кнопку возврата или клавишу Escape.

Соответствующий обработчик onRejected.

reset()

Этот сигнал испускается, когда пользователь нажал любую кнопку с ResetRole: Сбросить или Восстановить значения по умолчанию.

Соответствующий обработчик onReset.

yes()

Этот сигнал испускается, когда пользователь нажал любую кнопку с YesRole: Да или Да для всех.

Соответствующий обработчик onYes.

Документация по методам

void close()

Закрывает диалог.

void open()

Отображает диалог пользователю. Эквивалентно установке visible на true.