wMessageDialog

A dialog that shows a single or multi-line message, with a choice of OK, Yes, No and Cancel buttons. Only modal dialog is supported.

Superclass:wDialog
Styles:
StylesDescription
wOkThe message box contains one push button: OK. This is the default.
wYesNoThe message box contains two push buttons: Yes and No.
wOkCancelThe message box contains two push buttons: OK and Cancel.
wYesNoCancelThe message box contains three push buttons: Yes, No, and Cancel.
wRetryCancelThe message box contains two push buttons: Retry and Cancel.
wAbortRetryIgnoreThe message box contains three push buttons: Abort, Retry, and Ignore.
wCancelTryContinueThe message box contains three push buttons: Cancel, Try Again, Continue.
wIconHandA stop-sign icon appears in the message box.
wIconErrA stop-sign icon appears in the message box.
wIconStopA stop-sign icon appears in the message box.
wIconQuestionA question-mark icon appears in the message box.
wIconExclamationAn exclamation-point icon appears in the message box.
wIconWarningAn exclamation-point icon appears in the message box.
wIconInformationAn icon consisting of a lowercase letter i in a circle appears in the message box.
wIconAsteriskAn icon consisting of a lowercase letter i in a circle appears in the message box.
wButton1_DefaultThe first button is the default button. This is the default.
wButton2_DefaultThe second button is the default button.
wButton3_DefaultThe third button is the default button.
wButton4_DefaultThe fourth button is the default button.
wStayOnTopThe message box will stay on top of all other windows.

Consts

wOk = 0x00000000
wYesNo = 0x00000004
wOkCancel = 0x00000001
wYesNoCancel = 0x00000003
wRetryCancel = 0x00000005
wAbortRetryIgnore = 0x00000002
wCancelTryContinue = 0x00000006
wIconHand = 0x00000010
wIconErr = 0x00000010
wIconStop = 0x00000010
wIconQuestion = 0x00000020
wIconExclamation = 0x00000030
wIconWarning = 0x00000030
wIconInformation = 0x00000040
wIconAsterisk = 0x00000040
wButton1_Default = 0x00000000
wButton2_Default = 0x00000100
wButton3_Default = 0x00000200
wButton4_Default = 0x00000300

Procs

proc final(self: wMessageDialog) {...}{.raises: [], tags: [].}
Default finalizer for wMessageDialog.
proc init(self: wMessageDialog; owner: wWindow = nil; message: string = "";
         caption: string = ""; style: wStyle = wOK) {...}{.
    raises: [Exception, wCursorError, IndexError, wFontError], tags: [RootEffect].}
Initializer.
proc MessageDialog(owner: wWindow = nil; message: string = ""; caption: string = "";
                  style: wStyle = wOK): wMessageDialog {...}{.inline, discardable,
    raises: [Exception, wCursorError, IndexError, wFontError], tags: [RootEffect].}
Constructor.
proc getMessage(self: wMessageDialog): string {...}{.inline, raises: [], tags: [].}
Returns the message that will be displayed on the dialog.
proc getCaption(self: wMessageDialog): string {...}{.inline, raises: [], tags: [].}
Gets the caption that will be displayed on the dialog.
proc getStyle(self: wMessageDialog): wStyle {...}{.inline, raises: [], tags: [].}
Gets the style.
proc setMessage(self: var wMessageDialog; message: string) {...}{.inline, raises: [], tags: [].}
Sets the message that will be displayed on the dialog.
proc setCaption(self: var wMessageDialog; caption: string) {...}{.inline, raises: [], tags: [].}
Sets the caption that will be displayed on the dialog.
proc setStyle(self: var wMessageDialog; style: wStyle) {...}{.inline, raises: [], tags: [].}
Sets the style of the dialog.
proc setOKLabel(self: wMessageDialog; ok: string) {...}{.inline, raises: [], tags: [].}
Overrides the default labels of the OK button.
proc setOKCancelLabels(self: wMessageDialog; ok: string; cancel: string) {...}{.inline,
    raises: [], tags: [].}
Overrides the default labels of the OK and Cancel buttons.
proc setYesNoCancelLabels(self: wMessageDialog; yes: string; no: string; cancel: string) {...}{.
    inline, raises: [], tags: [].}
Overrides the default labels of the Yes, No and Cancel buttons.
proc setYesNoLabels(self: wMessageDialog; yes: string; no: string) {...}{.inline, raises: [],
    tags: [].}
Overrides the default labels of the Yes and No buttons.
proc setRetryCancelLabels(self: wMessageDialog; retry: string; cancel: string) {...}{.
    inline, raises: [], tags: [].}
Overrides the default labels of the Retry and Cancel buttons.
proc setAbortRetryIgnoreLabels(self: wMessageDialog; abort: string; retry: string;
                              ignore: string) {...}{.inline, raises: [], tags: [].}
Overrides the default labels of the Abort, Retry and Ignore buttons.
proc setCancelTryContinueLabels(self: wMessageDialog; cancel: string;
                               tryagain: string; cont: string) {...}{.inline, raises: [],
    tags: [].}
Overrides the default labels of the Cancel, Try Again and Continue buttons.
proc showModal(self: wMessageDialog): wId {...}{.discardable, raises: [], tags: [].}
Shows the dialog, returning one of wIdOk, wIdYes, wIdNo, wIdCancel, wIdTryAgain, wIdContinue, wIdAbort, wIdRetry or wIdIgnore.
proc display(self: wMessageDialog): wId {...}{.inline, discardable, raises: [], tags: [].}
Shows the dialog in modal mode, returning the selected button id. For wMessageDialog class, this function is the same as showModal().