include/SDL_quit.h
author Sam Lantinga <slouken@libsdl.org>
Sun, 28 May 2006 13:04:16 +0000
branchSDL-1.3
changeset 1662 782fd950bd46
parent 1358 c71e05b4dc2e
child 2859 99210400e8b9
permissions -rw-r--r--
Revamp of the video system in progress - adding support for multiple displays, multiple windows, and a full video mode selection API.

WARNING: None of the video drivers have been updated for the new API yet! The API is still under design and very fluid.

The code is now run through a consistent indent format:
indent -i4 -nut -nsc -br -ce

The headers are being converted to automatically generate doxygen documentation.
     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 /**
    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   An SDL_QUITEVENT is generated when the user tries to close the application
    37   window.  If it is ignored or filtered out, the window will remain open.
    38   If it is not ignored or filtered, it is queued normally and the window
    39   is allowed to close.  When the window is closed, screen updates will 
    40   complete, but have no effect.
    41 
    42   SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    43   and SIGTERM (system termination request), if handlers do not already
    44   exist, that generate SDL_QUITEVENT events as well.  There is no way
    45   to determine the cause of an SDL_QUITEVENT, but setting a signal
    46   handler in your application will override the default generation of
    47   quit events for that signal.
    48 */
    49 
    50 /* There are no functions directly affecting the quit event */
    51 #define SDL_QuitRequested() \
    52         (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    53 
    54 #endif /* _SDL_quit_h */