MessageBox

A window showing some text and buttons.

Modulerequire("gui")
TypeClass

Class methods

create()

Create a message box.

Return

MessageBox

Methods

run()

Show the message box and wait for result. Response ID will be returned.

Return

Integer

runForWindow(window)

Show the message box as a child for window and wait for result. Response ID will be returned.

Parameters

Return

Integer

show() Windows Linux

Show the message box. The onResponse event will be emitted when the message box is closed.

showForWindow(window)

Show the message box as a child of window. The onResponse event will be emitted when the message box is closed.

Parameters

close()

Close the message box. The cancel response ID will be used as result.

setType(type)

Set the type of message box, system will show the corresponding icon in the message box.

On macOS there is no visual difference between information and warning types. On Linux this method has no effect if a custom icon has been set.

Parameters

setTitle(title) Windows Linux

Set the message box window's title.

Parameters

addButton(title, response)

Add a button with title. The response ID will be used as result when the button is clicked.

Parameters

setDefaultResponse(response)

Set the default response ID, when user presses the Enter key the button associated with the ID will be clicked.

Parameters

setCancelResponse(response)

Set the cancel response ID that will be used as result when user presses the Esc key or when the window is closed without clicking any button.

The default cancel response ID is -1.

Parameters

setText(text)

Set the message box's message text.

Parameters

setInformativeText(text)

Set informative text that will show bellow the message text.

Parameters

setAccessoryView(view) macOS Linux

Set the accessory view that will be placed between the text and the buttons. The view must be given a size before being used as accessory view.

Parameters

getAccessoryView() macOS Linux

Return the accessory view.

Return

View

setImage(image)

Set the custom icon displayed in the message box.

On macOS the default icon is the app's icon, on Windows and Linux there is no default icon.

Parameters

getImage()

Return the custom icon.

Return

Image

Events

onResponse(self, response)

Emitted when the message box is closed.

Parameters

Preventable

No.