git.r.bdr.sh - rbdr/super-polarity/blob - vendor/frameworks/SDL2.framework/Versions/A/Headers/SDL_messagebox.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
   4
   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.
   8
   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:
  12
  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.
  20 */
  21
  22 #ifndef _SDL_messagebox_h
  23 #define _SDL_messagebox_h
  24
  25 #include "SDL_stdinc.h"
  26 #include "SDL_video.h"      /* For SDL_Window */
  27
  28 #include "begin_code.h"
  29 /* Set up for C function definitions, even when using C++ */
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35  * \brief SDL_MessageBox flags. If supported will display warning icon, etc.
  36  */
  37 typedef enum
  38 {
  39     SDL_MESSAGEBOX_ERROR        = 0x00000010,   /**< error dialog */
  40     SDL_MESSAGEBOX_WARNING      = 0x00000020,   /**< warning dialog */
  41     SDL_MESSAGEBOX_INFORMATION  = 0x00000040    /**< informational dialog */
  42 } SDL_MessageBoxFlags;
  43
  44 /**
  45  * \brief Flags for SDL_MessageBoxButtonData.
  46  */
  47 typedef enum
  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 */
  51 } SDL_MessageBoxButtonFlags;
  52
  53 /**
  54  *  \brief Individual button data.
  55  */
  56 typedef struct
  57 {
  58     Uint32 flags;       /**< ::SDL_MessageBoxButtonFlags */
  59     int buttonid;       /**< User defined button id (value returned via SDL_ShowMessageBox) */
  60     const char * text;  /**< The UTF-8 button text */
  61 } SDL_MessageBoxButtonData;
  62
  63 /**
  64  * \brief RGB value used in a message box color scheme
  65  */
  66 typedef struct
  67 {
  68     Uint8 r, g, b;
  69 } SDL_MessageBoxColor;
  70
  71 typedef enum
  72 {
  73     SDL_MESSAGEBOX_COLOR_BACKGROUND,
  74     SDL_MESSAGEBOX_COLOR_TEXT,
  75     SDL_MESSAGEBOX_COLOR_BUTTON_BORDER,
  76     SDL_MESSAGEBOX_COLOR_BUTTON_BACKGROUND,
  77     SDL_MESSAGEBOX_COLOR_BUTTON_SELECTED,
  78     SDL_MESSAGEBOX_COLOR_MAX
  79 } SDL_MessageBoxColorType;
  80
  81 /**
  82  * \brief A set of colors to use for message box dialogs
  83  */
  84 typedef struct
  85 {
  86     SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
  87 } SDL_MessageBoxColorScheme;
  88
  89 /**
  90  *  \brief MessageBox structure containing title, text, window, etc.
  91  */
  92 typedef struct
  93 {
  94     Uint32 flags;                       /**< ::SDL_MessageBoxFlags */
  95     SDL_Window *window;                 /**< Parent window, can be NULL */
  96     const char *title;                  /**< UTF-8 title */
  97     const char *message;                /**< UTF-8 message text */
  98
  99     int numbuttons;
 100     const SDL_MessageBoxButtonData *buttons;
 101
 102     const SDL_MessageBoxColorScheme *colorScheme;   /**< ::SDL_MessageBoxColorScheme, can be NULL to use system settings */
 103 } SDL_MessageBoxData;
 104
 105 /**
 106  *  \brief Create a modal message box.
 107  *
 108  *  \param messageboxdata The SDL_MessageBoxData structure with title, text, etc.
 109  *  \param buttonid The pointer to which user id of hit button should be copied.
 110  *
 111  *  \return -1 on error, otherwise 0 and buttonid contains user id of button
 112  *          hit or -1 if dialog was closed.
 113  *
 114  *  \note This function should be called on the thread that created the parent
 115  *        window, or on the main thread if the messagebox has no parent.  It will
 116  *        block execution of that thread until the user clicks a button or
 117  *        closes the messagebox.
 118  */
 119 extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid);
 120
 121 /**
 122  *  \brief Create a simple modal message box
 123  *
 124  *  \param flags    ::SDL_MessageBoxFlags
 125  *  \param title    UTF-8 title text
 126  *  \param message  UTF-8 message text
 127  *  \param window   The parent window, or NULL for no parent
 128  *
 129  *  \return 0 on success, -1 on error
 130  *
 131  *  \sa SDL_ShowMessageBox
 132  */
 133 extern DECLSPEC int SDLCALL SDL_ShowSimpleMessageBox(Uint32 flags, const char *title, const char *message, SDL_Window *window);
 134
 135
 136 /* Ends C function definitions when using C++ */
 137 #ifdef __cplusplus
 138 }
 139 #endif
 140 #include "close_code.h"
 141
 142 #endif /* _SDL_messagebox_h */
 143
 144 /* vi: set ts=4 sw=4 expandtab: */