include/SDL_quit.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 01 Feb 2006 06:32:25 +0000
changeset 1312 c9b51268668f
parent 769 b8d311d90021
child 1356 67114343400d
permissions -rw-r--r--
Updated copyright information and removed rcs id lines (problematic in branch merges)
I batch edited these files, so please let me know if I've accidentally removed anybody's
credit here.
     1 /*
     2     SDL - Simple DirectMedia Layer
     3     Copyright (C) 1997-2006 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 /* Include file for SDL quit event handling */
    24 
    25 #ifndef _SDL_quit_h
    26 #define _SDL_quit_h
    27 
    28 /* 
    29   An SDL_QUITEVENT is generated when the user tries to close the application
    30   window.  If it is ignored or filtered out, the window will remain open.
    31   If it is not ignored or filtered, it is queued normally and the window
    32   is allowed to close.  When the window is closed, screen updates will 
    33   complete, but have no effect.
    34 
    35   SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    36   and SIGTERM (system termination request), if handlers do not already
    37   exist, that generate SDL_QUITEVENT events as well.  There is no way
    38   to determine the cause of an SDL_QUITEVENT, but setting a signal
    39   handler in your application will override the default generation of
    40   quit events for that signal.
    41 */
    42 
    43 /* There are no functions directly affecting the quit event */
    44 #define SDL_QuitRequested() \
    45         (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    46 
    47 #endif /* _SDL_quit_h */