include/SDL_quit.h

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