🛠️🐜 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.

144 lines
4.5 KiB

  1. /*
  2. Simple DirectMedia Layer
  3. Copyright (C) 1997-2019 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. * \brief 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_MessageBoxFlags;
  36. /**
  37. * \brief Flags for SDL_MessageBoxButtonData.
  38. */
  39. typedef enum
  40. {
  41. SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT = 0x00000001, /**< Marks the default button when return is hit */
  42. SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT = 0x00000002 /**< Marks the default button when escape is hit */
  43. } SDL_MessageBoxButtonFlags;
  44. /**
  45. * \brief Individual button data.
  46. */
  47. typedef struct
  48. {
  49. Uint32 flags; /**< ::SDL_MessageBoxButtonFlags */
  50. int buttonid; /**< User defined button id (value returned via SDL_ShowMessageBox) */
  51. const char * text; /**< The UTF-8 button text */
  52. } SDL_MessageBoxButtonData;
  53. /**
  54. * \brief RGB value used in a message box color scheme
  55. */
  56. typedef struct
  57. {
  58. Uint8 r, g, b;
  59. } SDL_MessageBoxColor;
  60. typedef enum
  61. {
  62. SDL_MESSAGEBOX_COLOR_BACKGROUND,
  63. SDL_MESSAGEBOX_COLOR_TEXT,
  64. SDL_MESSAGEBOX_COLOR_BUTTON_BORDER,
  65. SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND,
  66. SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED,
  67. SDL_MESSAGEBOX_COLOR_MAX
  68. } SDL_MessageBoxColorType;
  69. /**
  70. * \brief A set of colors to use for message box dialogs
  71. */
  72. typedef struct
  73. {
  74. SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
  75. } SDL_MessageBoxColorScheme;
  76. /**
  77. * \brief MessageBox structure containing title, text, window, etc.
  78. */
  79. typedef struct
  80. {
  81. Uint32 flags; /**< ::SDL_MessageBoxFlags */
  82. SDL_Window *window; /**< Parent window, can be NULL */
  83. const char *title; /**< UTF-8 title */
  84. const char *message; /**< UTF-8 message text */
  85. int numbuttons;
  86. const SDL_MessageBoxButtonData *buttons;
  87. const SDL_MessageBoxColorScheme *colorScheme; /**< ::SDL_MessageBoxColorScheme, can be NULL to use system settings */
  88. } SDL_MessageBoxData;
  89. /**
  90. * \brief Create a modal message box.
  91. *
  92. * \param messageboxdata The SDL_MessageBoxData structure with title, text, etc.
  93. * \param buttonid The pointer to which user id of hit button should be copied.
  94. *
  95. * \return -1 on error, otherwise 0 and buttonid contains user id of button
  96. * hit or -1 if dialog was closed.
  97. *
  98. * \note This function should be called on the thread that created the parent
  99. * window, or on the main thread if the messagebox has no parent. It will
  100. * block execution of that thread until the user clicks a button or
  101. * closes the messagebox.
  102. */
  103. extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid);
  104. /**
  105. * \brief Create a simple modal message box
  106. *
  107. * \param flags ::SDL_MessageBoxFlags
  108. * \param title UTF-8 title text
  109. * \param message UTF-8 message text
  110. * \param window The parent window, or NULL for no parent
  111. *
  112. * \return 0 on success, -1 on error
  113. *
  114. * \sa SDL_ShowMessageBox
  115. */
  116. extern DECLSPEC int SDLCALL SDL_ShowSimpleMessageBox(Uint32 flags, const char *title, const char *message, SDL_Window *window);
  117. /* Ends C function definitions when using C++ */
  118. #ifdef __cplusplus
  119. }
  120. #endif
  121. #include "close_code.h"
  122. #endif /* SDL_messagebox_h_ */
  123. /* vi: set ts=4 sw=4 expandtab: */