cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

SDL_messagebox.h (4826B)

      1/*
      2  Simple DirectMedia Layer
      3  Copyright (C) 1997-2020 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
     31extern "C" {
     32#endif
     33
     34/**
     35 * \brief SDL_MessageBox flags. If supported will display warning icon, etc.
     36 */
     37typedef 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_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;
     45
     46/**
     47 * \brief Flags for SDL_MessageBoxButtonData.
     48 */
     49typedef enum
     50{
     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;
     54
     55/**
     56 *  \brief Individual button data.
     57 */
     58typedef struct
     59{
     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;
     64
     65/**
     66 * \brief RGB value used in a message box color scheme
     67 */
     68typedef struct
     69{
     70    Uint8 r, g, b;
     71} SDL_MessageBoxColor;
     72
     73typedef enum
     74{
     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;
     82
     83/**
     84 * \brief A set of colors to use for message box dialogs
     85 */
     86typedef struct
     87{
     88    SDL_MessageBoxColor colors[SDL_MESSAGEBOX_COLOR_MAX];
     89} SDL_MessageBoxColorScheme;
     90
     91/**
     92 *  \brief MessageBox structure containing title, text, window, etc.
     93 */
     94typedef struct
     95{
     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 */
    100
    101    int numbuttons;
    102    const SDL_MessageBoxButtonData *buttons;
    103
    104    const SDL_MessageBoxColorScheme *colorScheme;   /**< ::SDL_MessageBoxColorScheme, can be NULL to use system settings */
    105} SDL_MessageBoxData;
    106
    107/**
    108 *  \brief Create a modal message box.
    109 *
    110 *  \param messageboxdata The SDL_MessageBoxData structure with title, text, etc.
    111 *  \param buttonid The pointer to which user id of hit button should be copied.
    112 *
    113 *  \return -1 on error, otherwise 0 and buttonid contains user id of button
    114 *          hit or -1 if dialog was closed.
    115 *
    116 *  \note This function should be called on the thread that created the parent
    117 *        window, or on the main thread if the messagebox has no parent.  It will
    118 *        block execution of that thread until the user clicks a button or
    119 *        closes the messagebox.
    120 */
    121extern DECLSPEC int SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData *messageboxdata, int *buttonid);
    122
    123/**
    124 *  \brief Create a simple modal message box
    125 *
    126 *  \param flags    ::SDL_MessageBoxFlags
    127 *  \param title    UTF-8 title text
    128 *  \param message  UTF-8 message text
    129 *  \param window   The parent window, or NULL for no parent
    130 *
    131 *  \return 0 on success, -1 on error
    132 *
    133 *  \sa SDL_ShowMessageBox
    134 */
    135extern DECLSPEC int SDLCALL SDL_ShowSimpleMessageBox(Uint32 flags, const char *title, const char *message, SDL_Window *window);
    136
    137
    138/* Ends C function definitions when using C++ */
    139#ifdef __cplusplus
    140}
    141#endif
    142#include "close_code.h"
    143
    144#endif /* SDL_messagebox_h_ */
    145
    146/* vi: set ts=4 sw=4 expandtab: */