include/SDL_quit.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 21 Apr 2011 09:50:29 -0700
changeset 5545 978cc06ed5ad
parent 5535 96594ac5fd1a
child 5553 418675ebba17
permissions -rw-r--r--
Fixed so SDL_quit.h doesn't require SDL_compat.h
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2011 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 /**
    23  *  \file SDL_quit.h
    24  *  
    25  *  Include file for SDL quit event handling.
    26  */
    27 
    28 #ifndef _SDL_quit_h
    29 #define _SDL_quit_h
    30 
    31 #include "SDL_stdinc.h"
    32 #include "SDL_error.h"
    33 
    34 /**
    35  *  \file SDL_quit.h
    36  *  
    37  *  An ::SDL_QUIT event is generated when the user tries to close the application
    38  *  window.  If it is ignored or filtered out, the window will remain open.
    39  *  If it is not ignored or filtered, it is queued normally and the window
    40  *  is allowed to close.  When the window is closed, screen updates will 
    41  *  complete, but have no effect.
    42  *
    43  *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    44  *  and SIGTERM (system termination request), if handlers do not already
    45  *  exist, that generate ::SDL_QUIT events as well.  There is no way
    46  *  to determine the cause of an ::SDL_QUIT event, but setting a signal
    47  *  handler in your application will override the default generation of
    48  *  quit events for that signal.
    49  *  
    50  *  \sa SDL_Quit()
    51  */
    52 
    53 /* There are no functions directly affecting the quit event */
    54 
    55 #define SDL_QuitRequested() \
    56         (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUIT,SDL_QUIT))
    57 
    58 #endif /* _SDL_quit_h */