misc/winutils/include/SDL_quit.h
author Mitchell Kember <mk12360@gmail.com>
Tue, 04 Dec 2012 16:53:47 -0500
changeset 8229 251f38da9935
parent 7809 7d4fb2f35f4f
child 10017 de822cd3df3a
permissions -rw-r--r--
Cleaned up frontend options a bit and added a couple WhatsThis messages.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6560
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     1
/*
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     2
    SDL - Simple DirectMedia Layer
7809
7d4fb2f35f4f update SDL headers for winutils
koda
parents: 6560
diff changeset
     3
    Copyright (C) 1997-2012 Sam Lantinga
6560
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     4
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     5
    This library is free software; you can redistribute it and/or
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     6
    modify it under the terms of the GNU Lesser General Public
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     7
    License as published by the Free Software Foundation; either
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     8
    version 2.1 of the License, or (at your option) any later version.
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
     9
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    10
    This library is distributed in the hope that it will be useful,
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    13
    Lesser General Public License for more details.
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    14
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    15
    You should have received a copy of the GNU Lesser General Public
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    16
    License along with this library; if not, write to the Free Software
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    18
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    19
    Sam Lantinga
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    20
    slouken@libsdl.org
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    21
*/
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    22
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    23
/** @file SDL_quit.h
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    24
 *  Include file for SDL quit event handling
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    25
 */
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    26
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    27
#ifndef _SDL_quit_h
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    28
#define _SDL_quit_h
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    29
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    30
#include "SDL_stdinc.h"
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    31
#include "SDL_error.h"
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    32
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    33
/** @file SDL_quit.h
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    34
 *  An SDL_QUITEVENT is generated when the user tries to close the application
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    35
 *  window.  If it is ignored or filtered out, the window will remain open.
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    36
 *  If it is not ignored or filtered, it is queued normally and the window
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    37
 *  is allowed to close.  When the window is closed, screen updates will 
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    38
 *  complete, but have no effect.
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    39
 *
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    40
 *  SDL_Init() installs signal handlers for SIGINT (keyboard interrupt)
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    41
 *  and SIGTERM (system termination request), if handlers do not already
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    42
 *  exist, that generate SDL_QUITEVENT events as well.  There is no way
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    43
 *  to determine the cause of an SDL_QUITEVENT, but setting a signal
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    44
 *  handler in your application will override the default generation of
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    45
 *  quit events for that signal.
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    46
 */
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    47
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    48
/** @file SDL_quit.h
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    49
 *  There are no functions directly affecting the quit event 
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    50
 */
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    51
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    52
#define SDL_QuitRequested() \
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    53
        (SDL_PumpEvents(), SDL_PeepEvents(NULL,0,SDL_PEEKEVENT,SDL_QUITMASK))
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    54
ca07e6be08d0 GCI task: cmd.exe
bovi
parents:
diff changeset
    55
#endif /* _SDL_quit_h */