include/SDL_quit.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 10 Feb 2006 06:48:43 +0000
changeset 1358 c71e05b4dc2e
parent 1356 67114343400d
child 1662 782fd950bd46
child 4159 a1b03ba2fcd0
permissions -rw-r--r--
More header massaging... works great on Windows. ;-)
slouken@0
     1
/*
slouken@0
     2
    SDL - Simple DirectMedia Layer
slouken@1312
     3
    Copyright (C) 1997-2006 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@0
    23
/* Include file for SDL quit event handling */
slouken@0
    24
slouken@0
    25
#ifndef _SDL_quit_h
slouken@0
    26
#define _SDL_quit_h
slouken@0
    27
slouken@1356
    28
#include "SDL_stdinc.h"
slouken@1358
    29
#include "SDL_error.h"
slouken@1356
    30
slouken@0
    31
/* 
slouken@0
    32
  An SDL_QUITEVENT is generated when the user tries to close the application
slouken@0
    33
  window.  If it is ignored or filtered out, the window will remain open.
slouken@0
    34
  If it is not ignored or filtered, it is queued normally and the window
slouken@0
    35
  is allowed to close.  When the window is closed, screen updates will 
slouken@0
    36
  complete, but have no effect.
slouken@0
    37
slouken@0
    38
  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
slouken@0
    39
  and SIGTERM (system termination request), if handlers do not already
slouken@0
    40
  exist, that generate SDL_QUITEVENT events as well.  There is no way
slouken@0
    41
  to determine the cause of an SDL_QUITEVENT, but setting a signal
slouken@0
    42
  handler in your application will override the default generation of
slouken@0
    43
  quit events for that signal.
slouken@0
    44
*/
slouken@0
    45
slouken@0
    46
/* There are no functions directly affecting the quit event */
slouken@0
    47
#define SDL_QuitRequested() \
slouken@0
    48
        (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
slouken@0
    49
slouken@0
    50
#endif /* _SDL_quit_h */