donut::events::MessageBox Class Reference

Utility class for simple message boxes to be delivered to the user through the host environment. More...

#include <donut/events/MessageBox.hpp>

Public Types
enum class	Type { ERROR_MESSAGE , WARNING_MESSAGE , INFO_MESSAGE }
	Type of message contained in a message box. More...

Public Member Functions
	MessageBox ()=delete
	Message box objects are not intended to be constructed directly. More...

Static Public Member Functions
static void	show (Type type, const char *title, const char *message)
	Display a simple message box that blocks execution on the current thread until the user presses OK. More...

Detailed Description

Utility class for simple message boxes to be delivered to the user through the host environment.

Member Enumeration Documentation

Type

enum donut::events::MessageBox::Type

strong

Type of message contained in a message box.

Enumerator
ERROR_MESSAGE	Indicates that an error occured.
WARNING_MESSAGE	Warns the user about a potential error.
INFO_MESSAGE	Provides general information.

Constructor & Destructor Documentation

MessageBox()

donut::events::MessageBox::MessageBox ( )

delete

Message box objects are not intended to be constructed directly.

Member Function Documentation

show()

static void donut::events::MessageBox::show ( Type  type, const char *  title, const char *  message  )

static

Display a simple message box that blocks execution on the current thread until the user presses OK.

Parameters

type	type of message shown in the box. This may be reflected in the styling of the box.
title	non-owning read-only pointer to a UTF-8 string containing the window title of the message box. Must not be nullptr.
message	non-owning read-only pointer to a UTF-8 string containing the main message to show in the box. Must not be nullptr.

Exceptions

events::Error	on failure to show the message box.
std::bad_alloc	on allocation failure.

Examples

example_game.cpp.

---

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

• include/donut/events/MessageBox.hpp