#include "SDL_stdinc.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"

Include dependency graph for SDL_messagebox.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	SDL_MessageBoxButtonData
	Individual button data. More...

struct	SDL_MessageBoxColor
	RGB value used in a message box color scheme. More...

struct	SDL_MessageBoxColorScheme
	A set of colors to use for message box dialogs. More...

struct	SDL_MessageBoxData
	MessageBox structure containing title, text, window, etc. More...

Enumerations
enum	SDL_MessageBoxFlags { SDL_MESSAGEBOX_ERROR = 0x00000010 , SDL_MESSAGEBOX_WARNING = 0x00000020 , SDL_MESSAGEBOX_INFORMATION = 0x00000040 , SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT = 0x00000080 , SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT = 0x00000100 }
	SDL_MessageBox flags. If supported will display warning icon, etc. More...

enum	SDL_MessageBoxButtonFlags { SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001 , SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 }
	Flags for SDL_MessageBoxButtonData. More...

enum	SDL_MessageBoxColorType { SDL_MESSAGEBOX_COLOR_BACKGROUND , SDL_MESSAGEBOX_COLOR_TEXT , SDL_MESSAGEBOX_COLOR_BUTTON_BORDER , SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND , SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED , SDL_MESSAGEBOX_COLOR_MAX }

Functions
int	SDL_ShowMessageBox (const SDL_MessageBoxData messageboxdata, int buttonid)
	Create a modal message box. More...

int	SDL_ShowSimpleMessageBox (Uint32 flags, const char title, const char message, SDL_Window *window)
	Create a simple modal message box. More...

Enumeration Type Documentation

◆ SDL_MessageBoxButtonFlags

enum SDL_MessageBoxButtonFlags

Flags for SDL_MessageBoxButtonData.

Enumerator
SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT	Marks the default button when return is hit
SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT	Marks the default button when escape is hit

Definition at line 49 of file SDL_messagebox.h.

 {
     SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001,  /**< Marks the default button when return is hit */
     SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002   /**< Marks the default button when escape is hit */
 } SDL_MessageBoxButtonFlags;

◆ SDL_MessageBoxColorType

enum SDL_MessageBoxColorType

Enumerator
SDL_MESSAGEBOX_COLOR_BACKGROUND
SDL_MESSAGEBOX_COLOR_TEXT
SDL_MESSAGEBOX_COLOR_BUTTON_BORDER
SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND
SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED
SDL_MESSAGEBOX_COLOR_MAX

Definition at line 73 of file SDL_messagebox.h.

 {
     SDL_MESSAGEBOX_COLOR_BACKGROUND,
     SDL_MESSAGEBOX_COLOR_TEXT,
     SDL_MESSAGEBOX_COLOR_BUTTON_BORDER,
     SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND,
     SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED,
     SDL_MESSAGEBOX_COLOR_MAX
 } SDL_MessageBoxColorType;

◆ SDL_MessageBoxFlags

enum SDL_MessageBoxFlags

SDL_MessageBox flags. If supported will display warning icon, etc.

Enumerator
SDL_MESSAGEBOX_ERROR	error dialog
SDL_MESSAGEBOX_WARNING	warning dialog
SDL_MESSAGEBOX_INFORMATION	informational dialog
SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT	buttons placed left to right
SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT	buttons placed right to left

Definition at line 37 of file SDL_messagebox.h.

 {
     SDL_MESSAGEBOX_ERROR                 = 0x00000010,   /**< error dialog */
     SDL_MESSAGEBOX_WARNING               = 0x00000020,   /**< warning dialog */
     SDL_MESSAGEBOX_INFORMATION           = 0x00000040,   /**< informational dialog */
     SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT = 0x00000080,   /**< buttons placed left to right */
     SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT = 0x00000100    /**< buttons placed right to left */
 } SDL_MessageBoxFlags;

Function Documentation

◆ SDL_ShowMessageBox()

int SDL_ShowMessageBox	(	const SDL_MessageBoxData *	messageboxdata,
		int *	buttonid
	)

Create a modal message box.

Parameters

messageboxdata	The SDL_MessageBoxData structure with title, text, etc.
buttonid	The pointer to which user id of hit button should be copied.

Returns: -1 on error, otherwise 0 and buttonid contains user id of button hit or -1 if dialog was closed.

Note: This function should be called on the thread that created the parent window, or on the main thread if the messagebox has no parent. It will block execution of that thread until the user clicks a button or closes the messagebox.

Definition at line 3993 of file SDL_video.c.

 {
     int dummybutton;
     int retval = -1;
     SDL_bool relative_mode;
     int show_cursor_prev;
     SDL_bool mouse_captured;
     SDL_Window *current_window;
     SDL_MessageBoxData mbdata;
  
     if (!messageboxdata) {
         return SDL_InvalidParamError("messageboxdata");
     } else if (messageboxdata->numbuttons < 0) {
         return SDL_SetError("Invalid number of buttons");
     }
  
     current_window = SDL_GetKeyboardFocus();
     mouse_captured = current_window && ((SDL_GetWindowFlags(current_window) & SDL_WINDOW_MOUSE_CAPTURE) != 0);
     relative_mode = SDL_GetRelativeMouseMode();
     SDL_CaptureMouse(SDL_FALSE);
     SDL_SetRelativeMouseMode(SDL_FALSE);
     show_cursor_prev = SDL_ShowCursor(1);
     SDL_ResetKeyboard();
  
     if (!buttonid) {
         buttonid = &dummybutton;
     }
  
     SDL_memcpy(&mbdata, messageboxdata, sizeof(*messageboxdata));
     if (!mbdata.title) mbdata.title = "";
     if (!mbdata.message) mbdata.message = "";
     messageboxdata = &mbdata;
  
     if (_this && _this->ShowMessageBox) {
         retval = _this->ShowMessageBox(_this, messageboxdata, buttonid);
     }
  
     /* It's completely fine to call this function before video is initialized */
 #if SDL_VIDEO_DRIVER_ANDROID
     if (retval == -1 &&
         Android_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_WINDOWS
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_WINDOWS) &&
         WIN_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_WINRT
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_WINRT) &&
         WINRT_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_COCOA
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_COCOA) &&
         Cocoa_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_UIKIT
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_UIKIT) &&
         UIKit_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_X11
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_X11) &&
         X11_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_HAIKU
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_HAIKU) &&
         HAIKU_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
 #if SDL_VIDEO_DRIVER_OS2
     if (retval == -1 &&
         SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_OS2) &&
         OS2_ShowMessageBox(messageboxdata, buttonid) == 0) {
         retval = 0;
     }
 #endif
     if (retval == -1) {
         SDL_SetError("No message system available");
     }
  
     if (current_window) {
         SDL_RaiseWindow(current_window);
         if (mouse_captured) {
             SDL_CaptureMouse(SDL_TRUE);
         }
     }
  
     SDL_ShowCursor(show_cursor_prev);
     SDL_SetRelativeMouseMode(relative_mode);
  
     return retval;
 }

References _this, SDL_MessageBoxData::message, SDL_MessageBoxData::numbuttons, retval, SDL_CaptureMouse, SDL_FALSE, SDL_GetKeyboardFocus, SDL_GetRelativeMouseMode, SDL_GetWindowFlags(), SDL_InvalidParamError, SDL_memcpy, SDL_MessageboxValidForDriver(), SDL_RaiseWindow(), SDL_ResetKeyboard(), SDL_SetError, SDL_SetRelativeMouseMode, SDL_ShowCursor, SDL_SYSWM_COCOA, SDL_SYSWM_HAIKU, SDL_SYSWM_OS2, SDL_SYSWM_UIKIT, SDL_SYSWM_WINDOWS, SDL_SYSWM_WINRT, SDL_SYSWM_X11, SDL_TRUE, SDL_WINDOW_MOUSE_CAPTURE, SDL_VideoDevice::ShowMessageBox, and SDL_MessageBoxData::title.

Referenced by SDL_ShowSimpleMessageBox().

◆ SDL_ShowSimpleMessageBox()

int SDL_ShowSimpleMessageBox	(	Uint32	flags,
		const char *	title,
		const char *	message,
		SDL_Window *	window
	)

Create a simple modal message box.

Parameters

flags	SDL_MessageBoxFlags
title	UTF-8 title text
message	UTF-8 message text
window	The parent window, or NULL for no parent

Returns: 0 on success, -1 on error

See also: SDL_ShowMessageBox

Definition at line 4104 of file SDL_video.c.

 {
 #ifdef __EMSCRIPTEN__
     /* !!! FIXME: propose a browser API for this, get this #ifdef out of here? */
     /* Web browsers don't (currently) have an API for a custom message box
        that can block, but for the most common case (SDL_ShowSimpleMessageBox),
        we can use the standard Javascript alert() function. */
     if (!title) title = "";
     if (!message) message = "";
     EM_ASM_({
         alert(UTF8ToString($0) + "\n\n" + UTF8ToString($1));
     }, title, message);
     return 0;
 #else
     SDL_MessageBoxData data;
     SDL_MessageBoxButtonData button;
  
     SDL_zero(data);
     data.flags = flags;
     data.title = title;
     data.message = message;
     data.numbuttons = 1;
     data.buttons = &button;
     data.window = window;
  
     SDL_zero(button);
     button.flags |= SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT;
     button.flags |= SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT;
     button.text = "OK";
  
     return SDL_ShowMessageBox(&data, NULL);
 #endif
 }

References button, NULL, SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, SDL_ShowMessageBox(), and SDL_zero.

Data Structures

Enumerations