include/SDL_quit.h
changeset 0 74212992fb08
child 251 b8688cfdc232
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/include/SDL_quit.h	Thu Apr 26 16:45:43 2001 +0000
     1.3 @@ -0,0 +1,52 @@
     1.4 +/*
     1.5 +    SDL - Simple DirectMedia Layer
     1.6 +    Copyright (C) 1997, 1998, 1999, 2000, 2001  Sam Lantinga
     1.7 +
     1.8 +    This library is free software; you can redistribute it and/or
     1.9 +    modify it under the terms of the GNU Library General Public
    1.10 +    License as published by the Free Software Foundation; either
    1.11 +    version 2 of the License, or (at your option) any later version.
    1.12 +
    1.13 +    This library is distributed in the hope that it will be useful,
    1.14 +    but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 +    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    1.16 +    Library General Public License for more details.
    1.17 +
    1.18 +    You should have received a copy of the GNU Library General Public
    1.19 +    License along with this library; if not, write to the Free
    1.20 +    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    1.21 +
    1.22 +    Sam Lantinga
    1.23 +    slouken@devolution.com
    1.24 +*/
    1.25 +
    1.26 +#ifdef SAVE_RCSID
    1.27 +static char rcsid =
    1.28 + "@(#) $Id$";
    1.29 +#endif
    1.30 +
    1.31 +/* Include file for SDL quit event handling */
    1.32 +
    1.33 +#ifndef _SDL_quit_h
    1.34 +#define _SDL_quit_h
    1.35 +
    1.36 +/* 
    1.37 +  An SDL_QUITEVENT is generated when the user tries to close the application
    1.38 +  window.  If it is ignored or filtered out, the window will remain open.
    1.39 +  If it is not ignored or filtered, it is queued normally and the window
    1.40 +  is allowed to close.  When the window is closed, screen updates will 
    1.41 +  complete, but have no effect.
    1.42 +
    1.43 +  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
    1.44 +  and SIGTERM (system termination request), if handlers do not already
    1.45 +  exist, that generate SDL_QUITEVENT events as well.  There is no way
    1.46 +  to determine the cause of an SDL_QUITEVENT, but setting a signal
    1.47 +  handler in your application will override the default generation of
    1.48 +  quit events for that signal.
    1.49 +*/
    1.50 +
    1.51 +/* There are no functions directly affecting the quit event */
    1.52 +#define SDL_QuitRequested() \
    1.53 +        (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
    1.54 +
    1.55 +#endif /* _SDL_quit_h */