SDL  2.0
SDL_messagebox.h File Reference
#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:

Go to the source code of 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 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

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 47 of file SDL_messagebox.h.

48 {
49  SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001, /**< Marks the default button when return is hit */
50  SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 /**< Marks the default button when escape is hit */

◆ 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 71 of file SDL_messagebox.h.

◆ 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

Definition at line 37 of file SDL_messagebox.h.

38 {
39  SDL_MESSAGEBOX_ERROR = 0x00000010, /**< error dialog */
40  SDL_MESSAGEBOX_WARNING = 0x00000020, /**< warning dialog */
41  SDL_MESSAGEBOX_INFORMATION = 0x00000040 /**< informational dialog */

Function Documentation

◆ SDL_ShowMessageBox()

int SDL_ShowMessageBox ( const SDL_MessageBoxData messageboxdata,
int *  buttonid 
)

Create a modal message box.

Parameters
messageboxdataThe SDL_MessageBoxData structure with title, text, etc.
buttonidThe 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 3843 of file SDL_video.c.

3844 {
3845  int dummybutton;
3846  int retval = -1;
3847  SDL_bool relative_mode;
3848  int show_cursor_prev;
3849  SDL_bool mouse_captured;
3850  SDL_Window *current_window;
3851 
3852  if (!messageboxdata) {
3853  return SDL_InvalidParamError("messageboxdata");
3854  } else if (messageboxdata->numbuttons < 0) {
3855  return SDL_SetError("Invalid number of buttons");
3856  }
3857 
3858  current_window = SDL_GetKeyboardFocus();
3859  mouse_captured = current_window && ((SDL_GetWindowFlags(current_window) & SDL_WINDOW_MOUSE_CAPTURE) != 0);
3860  relative_mode = SDL_GetRelativeMouseMode();
3863  show_cursor_prev = SDL_ShowCursor(1);
3865 
3866  if (!buttonid) {
3867  buttonid = &dummybutton;
3868  }
3869 
3870  if (_this && _this->ShowMessageBox) {
3871  retval = _this->ShowMessageBox(_this, messageboxdata, buttonid);
3872  }
3873 
3874  /* It's completely fine to call this function before video is initialized */
3875 #if SDL_VIDEO_DRIVER_ANDROID
3876  if (retval == -1 &&
3877  Android_ShowMessageBox(messageboxdata, buttonid) == 0) {
3878  retval = 0;
3879  }
3880 #endif
3881 #if SDL_VIDEO_DRIVER_WINDOWS
3882  if (retval == -1 &&
3884  WIN_ShowMessageBox(messageboxdata, buttonid) == 0) {
3885  retval = 0;
3886  }
3887 #endif
3888 #if SDL_VIDEO_DRIVER_WINRT
3889  if (retval == -1 &&
3890  SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_WINRT) &&
3891  WINRT_ShowMessageBox(messageboxdata, buttonid) == 0) {
3892  retval = 0;
3893  }
3894 #endif
3895 #if SDL_VIDEO_DRIVER_COCOA
3896  if (retval == -1 &&
3897  SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_COCOA) &&
3898  Cocoa_ShowMessageBox(messageboxdata, buttonid) == 0) {
3899  retval = 0;
3900  }
3901 #endif
3902 #if SDL_VIDEO_DRIVER_UIKIT
3903  if (retval == -1 &&
3904  SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_UIKIT) &&
3905  UIKit_ShowMessageBox(messageboxdata, buttonid) == 0) {
3906  retval = 0;
3907  }
3908 #endif
3909 #if SDL_VIDEO_DRIVER_X11
3910  if (retval == -1 &&
3911  SDL_MessageboxValidForDriver(messageboxdata, SDL_SYSWM_X11) &&
3912  X11_ShowMessageBox(messageboxdata, buttonid) == 0) {
3913  retval = 0;
3914  }
3915 #endif
3916  if (retval == -1) {
3917  SDL_SetError("No message system available");
3918  }
3919 
3920  if (current_window) {
3921  SDL_RaiseWindow(current_window);
3922  if (mouse_captured) {
3924  }
3925  }
3926 
3927  SDL_ShowCursor(show_cursor_prev);
3928  SDL_SetRelativeMouseMode(relative_mode);
3929 
3930  return retval;
3931 }

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

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
flagsSDL_MessageBoxFlags
titleUTF-8 title text
messageUTF-8 message text
windowThe parent window, or NULL for no parent
Returns
0 on success, -1 on error
See also
SDL_ShowMessageBox

Definition at line 3934 of file SDL_video.c.

3935 {
3936 #ifdef __EMSCRIPTEN__
3937  /* !!! FIXME: propose a browser API for this, get this #ifdef out of here? */
3938  /* Web browsers don't (currently) have an API for a custom message box
3939  that can block, but for the most common case (SDL_ShowSimpleMessageBox),
3940  we can use the standard Javascript alert() function. */
3941  EM_ASM_({
3942  alert(UTF8ToString($0) + "\n\n" + UTF8ToString($1));
3943  }, title, message);
3944  return 0;
3945 #else
3948 
3949  SDL_zero(data);
3950  data.flags = flags;
3951  data.title = title;
3952  data.message = message;
3953  data.numbuttons = 1;
3954  data.buttons = &button;
3955  data.window = window;
3956 
3957  SDL_zero(button);
3960  button.text = "OK";
3961 
3962  return SDL_ShowMessageBox(&data, NULL);
3963 #endif
3964 }

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

SDL_MESSAGEBOX_COLOR_BUTTON_BORDER
@ SDL_MESSAGEBOX_COLOR_BUTTON_BORDER
Definition: SDL_messagebox.h:75
SDL_zero
#define SDL_zero(x)
Definition: SDL_stdinc.h:416
SDL_WINDOW_MOUSE_CAPTURE
@ SDL_WINDOW_MOUSE_CAPTURE
Definition: SDL_video.h:116
SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT
@ SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT
Definition: SDL_messagebox.h:50
SDL_SYSWM_WINRT
@ SDL_SYSWM_WINRT
Definition: SDL_syswm.h:126
SDL_MessageBoxButtonFlags
SDL_MessageBoxButtonFlags
Flags for SDL_MessageBoxButtonData.
Definition: SDL_messagebox.h:48
NULL
#define NULL
Definition: begin_code.h:164
message
GLuint GLsizei const GLchar * message
Definition: SDL_opengl_glext.h:2483
SDL_MESSAGEBOX_COLOR_TEXT
@ SDL_MESSAGEBOX_COLOR_TEXT
Definition: SDL_messagebox.h:74
SDL_MESSAGEBOX_COLOR_BACKGROUND
@ SDL_MESSAGEBOX_COLOR_BACKGROUND
Definition: SDL_messagebox.h:73
SDL_InvalidParamError
#define SDL_InvalidParamError(param)
Definition: SDL_error.h:54
SDL_MESSAGEBOX_WARNING
@ SDL_MESSAGEBOX_WARNING
Definition: SDL_messagebox.h:40
SDL_RaiseWindow
void SDL_RaiseWindow(SDL_Window *window)
Raise a window above other windows and set the input focus.
Definition: SDL_video.c:2184
SDL_MessageBoxFlags
SDL_MessageBoxFlags
SDL_MessageBox flags. If supported will display warning icon, etc.
Definition: SDL_messagebox.h:38
data
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: SDL_opengl.h:1974
SDL_SetRelativeMouseMode
#define SDL_SetRelativeMouseMode
Definition: SDL_dynapi_overrides.h:249
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:74
SDL_GetKeyboardFocus
#define SDL_GetKeyboardFocus
Definition: SDL_dynapi_overrides.h:216
SDL_ResetKeyboard
void SDL_ResetKeyboard(void)
Definition: SDL_keyboard.c:572
SDL_GetWindowFlags
Uint32 SDL_GetWindowFlags(SDL_Window *window)
Get the window flags.
Definition: SDL_video.c:1737
_this
static SDL_VideoDevice * _this
Definition: SDL_video.c:121
SDL_SYSWM_COCOA
@ SDL_SYSWM_COCOA
Definition: SDL_syswm.h:122
SDL_MessageBoxColorType
SDL_MessageBoxColorType
Definition: SDL_messagebox.h:72
SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND
@ SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND
Definition: SDL_messagebox.h:76
retval
SDL_bool retval
Definition: testgamecontroller.c:65
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_GetRelativeMouseMode
#define SDL_GetRelativeMouseMode
Definition: SDL_dynapi_overrides.h:250
SDL_VideoDevice::ShowMessageBox
int(* ShowMessageBox)(_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid)
Definition: SDL_sysvideo.h:303
SDL_SYSWM_X11
@ SDL_SYSWM_X11
Definition: SDL_syswm.h:120
SDL_MessageBoxData
MessageBox structure containing title, text, window, etc.
Definition: SDL_messagebox.h:93
SDL_MESSAGEBOX_ERROR
@ SDL_MESSAGEBOX_ERROR
Definition: SDL_messagebox.h:39
SDL_MessageBoxButtonData
Individual button data.
Definition: SDL_messagebox.h:57
SDL_SYSWM_UIKIT
@ SDL_SYSWM_UIKIT
Definition: SDL_syswm.h:123
SDL_TRUE
@ SDL_TRUE
Definition: SDL_stdinc.h:164
SDL_MESSAGEBOX_INFORMATION
@ SDL_MESSAGEBOX_INFORMATION
Definition: SDL_messagebox.h:41
SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED
@ SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED
Definition: SDL_messagebox.h:77
SDL_MessageboxValidForDriver
static SDL_bool SDL_MessageboxValidForDriver(const SDL_MessageBoxData *messageboxdata, SDL_SYSWM_TYPE drivertype)
Definition: SDL_video.c:3824
SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT
@ SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT
Definition: SDL_messagebox.h:49
SDL_SetError
#define SDL_SetError
Definition: SDL_dynapi_overrides.h:30
SDL_CaptureMouse
#define SDL_CaptureMouse
Definition: SDL_dynapi_overrides.h:584
SDL_ShowMessageBox
int SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid)
Create a modal message box.
Definition: SDL_video.c:3843
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_ShowCursor
#define SDL_ShowCursor
Definition: SDL_dynapi_overrides.h:258
SDL_MESSAGEBOX_COLOR_MAX
@ SDL_MESSAGEBOX_COLOR_MAX
Definition: SDL_messagebox.h:78
SDL_FALSE
@ SDL_FALSE
Definition: SDL_stdinc.h:163
flags
GLbitfield flags
Definition: SDL_opengl_glext.h:1480
button
SDL_Texture * button
Definition: testgamecontroller.c:67
SDL_MessageBoxData::numbuttons
int numbuttons
Definition: SDL_messagebox.h:99
SDL_SYSWM_WINDOWS
@ SDL_SYSWM_WINDOWS
Definition: SDL_syswm.h:119