Home | History | Annotate | Download | only in SDL
      1 /*
      2     SDL - Simple DirectMedia Layer
      3     Copyright (C) 1997-2012 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 (at) libsdl.org
     21 */
     22 
     23 /** @file SDL_quit.h
     24  *  Include file for SDL quit event handling
     25  */
     26 
     27 #ifndef _SDL_quit_h
     28 #define _SDL_quit_h
     29 
     30 #include "SDL_stdinc.h"
     31 #include "SDL_error.h"
     32 
     33 /** @file SDL_quit.h
     34  *  An SDL_QUITEVENT is generated when the user tries to close the application
     35  *  window.  If it is ignored or filtered out, the window will remain open.
     36  *  If it is not ignored or filtered, it is queued normally and the window
     37  *  is allowed to close.  When the window is closed, screen updates will
     38  *  complete, but have no effect.
     39  *
     40  *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
     41  *  and SIGTERM (system termination request), if handlers do not already
     42  *  exist, that generate SDL_QUITEVENT events as well.  There is no way
     43  *  to determine the cause of an SDL_QUITEVENT, but setting a signal
     44  *  handler in your application will override the default generation of
     45  *  quit events for that signal.
     46  */
     47 
     48 /** @file SDL_quit.h
     49  *  There are no functions directly affecting the quit event
     50  */
     51 
     52 #define SDL_QuitRequested() \
     53         (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
     54 
     55 #endif /* _SDL_quit_h */
     56