Mercurial > sdl-ios-xcode

comparison include/SDL_quit.h @ 4217:4c4113c2162c SDL-1.2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed bug #706 Ken Bull 2009-02-25 13:22:02 PST Adds Doxygen support for all headers (except config and boilerplate headers) in the include folder for SDL-1.2 revision 4446. While in general SDL is quite thoroughly commented, none of these comments are correctly formatted for Doxygen and are generally inconsistent in their formatting.
author Sam Lantinga <slouken@libsdl.org>
date Mon, 21 Sep 2009 09:38:10 +0000
parents a1b03ba2fcd0
children
comparison
equal deleted inserted replaced
4216:5b99971a27b4 4217:4c4113c2162c
18 18
19 Sam Lantinga 19 Sam Lantinga
20 slouken@libsdl.org 20 slouken@libsdl.org
21 */ 21 */
22 22
23 /* Include file for SDL quit event handling */ 23 /** @file SDL_quit.h
24 * Include file for SDL quit event handling
25 */
24 26
25 #ifndef _SDL_quit_h 27 #ifndef _SDL_quit_h
26 #define _SDL_quit_h 28 #define _SDL_quit_h
27 29
28 #include "SDL_stdinc.h" 30 #include "SDL_stdinc.h"
29 #include "SDL_error.h" 31 #include "SDL_error.h"
30 32
31 /* 33 /** @file SDL_quit.h
32 An SDL_QUITEVENT is generated when the user tries to close the application 34 * 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. 35 * 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 36 * 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 37 * is allowed to close. When the window is closed, screen updates will
36 complete, but have no effect. 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 */
37 47
38 SDL_Init() installs signal handlers for SIGINT (keyboard interrupt) 48 /** @file SDL_quit.h
39 and SIGTERM (system termination request), if handlers do not already 49 * There are no functions directly affecting the quit event
40 exist, that generate SDL_QUITEVENT events as well. There is no way 50 */
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 51
46 /* There are no functions directly affecting the quit event */
47 #define SDL_QuitRequested() \ 52 #define SDL_QuitRequested() \
48 (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK)) 53 (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
49 54
50 #endif /* _SDL_quit_h */ 55 #endif /* _SDL_quit_h */