view docs/man3/SDL_QuitEvent.3 @ 419:3d8ad40ef561

Allow building from another top level directory
author Sam Lantinga <slouken@libsdl.org>
date Thu, 20 Jun 2002 17:47:18 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.TH "SDL_QuitEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_QuitEvent\- Quit requested event
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  Uint8 type
} SDL_QuitEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_QUIT\fP
.SH "DESCRIPTION"
.PP
\fBSDL_QuitEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used whan an event of type \fBSDL_QUIT\fP is reported\&.
.PP
As can be seen, the SDL_QuitEvent structure serves no useful purpose\&. The event itself, on the other hand, is very important\&. If you filter out or ignore a quit event then it is impossible for the user to close the window\&. On the other hand, if you do accept a quit event then the application window will be closed, and screen updates will still report success event though the application will no longer be visible\&.
.PP
.RS
\fBNote:  
.PP
The macro \fBSDL_QuitRequested\fP will return non-zero if a quit event is pending
.RE
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59