2 Simple DirectMedia Layer
3 Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
22 #ifndef SDL_messagebox_h_
23 #define SDL_messagebox_h_
25 #include "SDL_stdinc.h"
26 #include "SDL_video.h" /* For SDL_Window */
28 #include "begin_code.h"
29 /* Set up for C function definitions, even when using C++ */
35 * SDL_MessageBox flags. If supported will display warning icon, etc.
39 SDL_MESSAGEBOX_ERROR = 0x00000010, /**< error dialog */
40 SDL_MESSAGEBOX_WARNING = 0x00000020, /**< warning dialog */
41 SDL_MESSAGEBOX_INFORMATION = 0x00000040, /**< informational dialog */
42 SDL_MESSAGEBOX_BUTTONS_LEFT_TO_RIGHT = 0x00000080, /**< buttons placed left to right */
43 SDL_MESSAGEBOX_BUTTONS_RIGHT_TO_LEFT = 0x00000100 /**< buttons placed right to left */
44 } SDL_MessageBoxFlags;
47 * Flags for SDL_MessageBoxButtonData.
51 SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001, /**< Marks the default button when return is hit */
52 SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 /**< Marks the default button when escape is hit */
53 } SDL_MessageBoxButtonFlags;
56 * Individual button data.
60 Uint32 flags; /**< ::SDL_MessageBoxButtonFlags */
61 int buttonid; /**< User defined button id (value returned via SDL_ShowMessageBox) */
62 const char * text; /**< The UTF-8 button text */
63 } SDL_MessageBoxButtonData;
66 * RGB value used in a message box color scheme
71 } SDL_MessageBoxColor;
75 SDL_MESSAGEBOX_COLOR_BACKGROUND,
76 SDL_MESSAGEBOX_COLOR_TEXT,
77 SDL_MESSAGEBOX_COLOR_BUTTON_BORDER,
78 SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND,
79 SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED,
80 SDL_MESSAGEBOX_COLOR_MAX
81 } SDL_MessageBoxColorType;
84 * A set of colors to use for message box dialogs
88 SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
89 } SDL_MessageBoxColorScheme;
92 * MessageBox structure containing title, text, window, etc.
96 Uint32 flags; /**< ::SDL_MessageBoxFlags */
97 SDL_Window *window; /**< Parent window, can be NULL */
98 const char *title; /**< UTF-8 title */
99 const char *message; /**< UTF-8 message text */
102 const SDL_MessageBoxButtonData *buttons;
104 const SDL_MessageBoxColorScheme *colorScheme; /**< ::SDL_MessageBoxColorScheme, can be NULL to use system settings */
105 } SDL_MessageBoxData;
108 * Create a modal message box.
110 * If your needs aren't complex, it might be easier to use
111 * SDL_ShowSimpleMessageBox.
113 * This function should be called on the thread that created the parent
114 * window, or on the main thread if the messagebox has no parent. It will
115 * block execution of that thread until the user clicks a button or closes the
118 * This function may be called at any time, even before SDL_Init(). This makes
119 * it useful for reporting errors like a failure to create a renderer or
122 * On X11, SDL rolls its own dialog box with X11 primitives instead of a
123 * formal toolkit like GTK+ or Qt.
125 * Note that if SDL_Init() would fail because there isn't any available video
126 * target, this function is likely to fail for the same reasons. If this is a
127 * concern, check the return value from this function and fall back to writing
128 * to stderr if you can.
130 * \param messageboxdata the SDL_MessageBoxData structure with title, text and
132 * \param buttonid the pointer to which user id of hit button should be copied
133 * \returns 0 on success or a negative error code on failure; call
134 * SDL_GetError() for more information.
136 * \since This function is available since SDL 2.0.0.
138 * \sa SDL_ShowSimpleMessageBox
140 extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid);
143 * Display a simple modal message box.
145 * If your needs aren't complex, this function is preferred over
146 * SDL_ShowMessageBox.
148 * `flags` may be any of the following:
150 * - `SDL_MESSAGEBOX_ERROR`: error dialog
151 * - `SDL_MESSAGEBOX_WARNING`: warning dialog
152 * - `SDL_MESSAGEBOX_INFORMATION`: informational dialog
154 * This function should be called on the thread that created the parent
155 * window, or on the main thread if the messagebox has no parent. It will
156 * block execution of that thread until the user clicks a button or closes the
159 * This function may be called at any time, even before SDL_Init(). This makes
160 * it useful for reporting errors like a failure to create a renderer or
163 * On X11, SDL rolls its own dialog box with X11 primitives instead of a
164 * formal toolkit like GTK+ or Qt.
166 * Note that if SDL_Init() would fail because there isn't any available video
167 * target, this function is likely to fail for the same reasons. If this is a
168 * concern, check the return value from this function and fall back to writing
169 * to stderr if you can.
171 * \param flags an SDL_MessageBoxFlags value
172 * \param title UTF-8 title text
173 * \param message UTF-8 message text
174 * \param window the parent window, or NULL for no parent
175 * \returns 0 on success or a negative error code on failure; call
176 * SDL_GetError() for more information.
178 * \since This function is available since SDL 2.0.0.
180 * \sa SDL_ShowMessageBox
182 extern DECLSPEC int SDLCALL SDL_ShowSimpleMessageBox(Uint32 flags, const char *title, const char *message, SDL_Window *window);
185 /* Ends C function definitions when using C++ */
189 #include "close_code.h"
191 #endif /* SDL_messagebox_h_ */
193 /* vi: set ts=4 sw=4 expandtab: */