🛠️🐜 Antkeeper superbuild with dependencies included https://antkeeper.com
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

193 lines
6.5 KiB

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