include/SDL_quit.h
author Sam Lantinga <slouken@libsdl.org>
Mon, 19 Oct 2009 13:31:58 +0000
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
permissions -rw-r--r--
Partial fix for bug #859

Header file update from Ken for improved doxygen output
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2009 Sam Lantinga
     4 
     5     This library is free software; you can redistribute it and/or
     6     modify it under the terms of the GNU Lesser General Public
     7     License as published by the Free Software Foundation; either
     8     version 2.1 of the License, or (at your option) any later version.
     9 
    10     This library is distributed in the hope that it will be useful,
    11     but WITHOUT ANY WARRANTY; without even the implied warranty of
    12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    13     Lesser General Public License for more details.
    14 
    15     You should have received a copy of the GNU Lesser General Public
    16     License along with this library; if not, write to the Free Software
    17     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    18 
    19     Sam Lantinga
    20     slouken@libsdl.org
    21 */
    22 
    23 /**
    24  *  \file SDL_quit.h
    25  *  
    26  *  Include file for SDL quit event handling.
    27  */
    28 
    29 #ifndef _SDL_quit_h
    30 #define _SDL_quit_h
    31 
    32 #include "SDL_stdinc.h"
    33 #include "SDL_error.h"
    34 
    35 /**
    36  *  \file SDL_quit.h
    37  *  
    38  *  An ::SDL_QUIT event is generated when the user tries to close the application
    39  *  window.  If it is ignored or filtered out, the window will remain open.
    40  *  If it is not ignored or filtered, it is queued normally and the window
    41  *  is allowed to close.  When the window is closed, screen updates will 
    42  *  complete, but have no effect.
    43  *
    44  *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    45  *  and SIGTERM (system termination request), if handlers do not already
    46  *  exist, that generate ::SDL_QUIT events as well.  There is no way
    47  *  to determine the cause of an ::SDL_QUIT event, but setting a signal
    48  *  handler in your application will override the default generation of
    49  *  quit events for that signal.
    50  *  
    51  *  \sa SDL_Quit()
    52  */
    53 
    54 /* There are no functions directly affecting the quit event */
    55 
    56 #define SDL_QuitRequested() \
    57         (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    58 
    59 #endif /* _SDL_quit_h */