symbian-qemu-0.9.1-12/libsdl-trunk/docs/man3/SDL_QuitEvent.3
changeset 1 2fb8b9db1c86
equal deleted inserted replaced
0:ffa851df0825 1:2fb8b9db1c86
       
     1 .TH "SDL_QuitEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
       
     2 .SH "NAME"
       
     3 SDL_QuitEvent \- Quit requested event
       
     4 .SH "STRUCTURE DEFINITION"
       
     5 .PP
       
     6 .nf
       
     7 \f(CWtypedef struct{
       
     8   Uint8 type
       
     9 } SDL_QuitEvent;\fR
       
    10 .fi
       
    11 .PP
       
    12 .SH "STRUCTURE DATA"
       
    13 .TP 20
       
    14 \fBtype\fR
       
    15 \fBSDL_QUIT\fP
       
    16 .SH "DESCRIPTION"
       
    17 .PP
       
    18 \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\&.
       
    19 .PP
       
    20 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\&.
       
    21 .PP
       
    22 .RS
       
    23 \fBNote:  
       
    24 .PP
       
    25 The macro \fBSDL_QuitRequested\fP will return non-zero if a quit event is pending
       
    26 .RE
       
    27 .SH "SEE ALSO"
       
    28 .PP
       
    29 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR
       
    30 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59