Mercurial > sdl-ios-xcode

comparison include/SDL_quit.h @ 3407:d3baf5ac4e37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents 99210400e8b9
children f7b03b6838cb
comparison
equal deleted inserted replaced
3406:8ae607392409 3407:d3baf5ac4e37
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22 22
23 /** 23 /**
24 * \file SDL_quit.h 24 * \file SDL_quit.h
25 * 25 *
26 * Include file for SDL quit event handling 26 * Include file for SDL quit event handling.
27 */ 27 */
28 28
29 #ifndef _SDL_quit_h 29 #ifndef _SDL_quit_h
30 #define _SDL_quit_h 30 #define _SDL_quit_h
31 31
32 #include "SDL_stdinc.h" 32 #include "SDL_stdinc.h"
33 #include "SDL_error.h" 33 #include "SDL_error.h"
34 34
35 /* 35 /**
36 An SDL_QUITEVENT is generated when the user tries to close the application 36 * \file SDL_quit.h
37 window. If it is ignored or filtered out, the window will remain open. 37 *
38 If it is not ignored or filtered, it is queued normally and the window 38 * An ::SDL_QUIT event is generated when the user tries to close the application
39 is allowed to close. When the window is closed, screen updates will 39 * window. If it is ignored or filtered out, the window will remain open.
40 complete, but have no effect. 40 * If it is not ignored or filtered, it is queued normally and the window
41 41 * is allowed to close. When the window is closed, screen updates will
42 SDL_Init() installs signal handlers for SIGINT (keyboard interrupt) 42 * complete, but have no effect.
43 and SIGTERM (system termination request), if handlers do not already 43 *
44 exist, that generate SDL_QUITEVENT events as well. There is no way 44 * SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
45 to determine the cause of an SDL_QUITEVENT, but setting a signal 45 * and SIGTERM (system termination request), if handlers do not already
46 handler in your application will override the default generation of 46 * exist, that generate ::SDL_QUIT events as well. There is no way
47 quit events for that signal. 47 * to determine the cause of an ::SDL_QUIT event, but setting a signal
48 */ 48 * handler in your application will override the default generation of
49 * quit events for that signal.
50 *
51 * \sa SDL_Quit()
52 */
49 53
50 /* There are no functions directly affecting the quit event */ 54 /* There are no functions directly affecting the quit event */
55
51 #define SDL_QuitRequested() \ 56 #define SDL_QuitRequested() \
52 (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK)) 57 (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
53 58
54 #endif /* _SDL_quit_h */ 59 #endif /* _SDL_quit_h */