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