Detailed Description#

AMessageBox provides a set of APIs to display native modal message boxes, giving the user some important information or asking questions.

Title is a short sentence describing the situation in 2-4 words, typically rendered as emphasized text or in the titlebar. Message contains more information about the state of things. Optionally, buttons or icon can be specified.

The rest of the application is freezed/blocked until the user dismisses the message box. This means message boxes should be used only in emergency situations, when your application literally can't operate until it recevies a response from the user. Use non-blocking, contextual and structured feedback where possible.

                                     AMessageBox::show(this,
                                                       "Title",
                                                       "Message",
                                                       AMessageBox::Icon::NONE,
                                                       AMessageBox::Button::OK);

Windows-specific: Implemented with MessageBox.

Linux-specific: Implemented with GtkDialog.

macOS-specific: Implemented with NSAlert.

Enumerations#
enum class	Icon { NONE , INFO , WARNING , CRITICAL }
	Specifies icon to be displayed. More...

enum class	Button { OK , OK_CANCEL , YES_NO , YES_NO_CANCEL }
	Specifies button(s) to be displayed. More...

enum class	ResultButton { INVALID , OK , CANCEL , YES , NO }
	Button that the user has clicked. More...

Functions#
API_AUI_VIEWS ResultButton	show (AWindow *parent, const AString &title, const AString &message, Icon icon=Icon::NONE, Button b=Button::OK)
	Displays a message box, blocking the caller thread until the user dismisses the message.

Enumeration Type Documentation#

◆ Button#

enum class AMessageBox::Button

strong

Enumerator
OK	Display OK button only.
OK_CANCEL	Display OK and Cancel buttons.
YES_NO	Display Yes and No buttons.
YES_NO_CANCEL	Display Yes, No and Cancel buttons.

◆ Icon#

enum class AMessageBox::Icon

strong

Enumerator
NONE	No icon is specified. macOS-specific Displays app's bundle icon.
INFO	Information icon.
WARNING	Warning icon.
CRITICAL	Critical icon.

◆ ResultButton#

enum class AMessageBox::ResultButton

strong

Enumerator
INVALID	Indicates an invalid or undefined result.
OK	Indicates the user clicked the OK button.
CANCEL	Indicates the user clicked the Cancel button.
YES	Indicates the user clicked the Yes button.
NO	Indicates the user clicked the No button.

Function Documentation#

◆ show()#

API_AUI_VIEWS ResultButton AMessageBox::show	(	AWindow *	parent,
		const AString &	title,
		const AString &	message,
		Icon	icon = Icon::NONE,
		Button	b = Button::OK )

Parameters

parent	the window the message box relates to. The OS might fade out the parent window and/or place the message box within its geometry. Can be `nullptr`.
title	title of the message box.
message	content of the message box.
icon	icon style for the message box. Defaults to NONE.
b	buttons to be displayed in the message box.

Examples: examples/7guis/flight_booker/src/main.cpp, examples/app/fractal/src/JumpToCoordsWindow.cpp, examples/app/minesweeper/src/MinesweeperWindow.cpp, examples/app/notes/src/main.cpp, examples/ui/contacts/src/main.cpp, and examples/ui/views/src/ExampleWindow.cpp.