1 .TH "SDL_ActiveEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 

     2 .SH "NAME"

     3 SDL_ActiveEvent \- Application visibility event structure

     4 .SH "STRUCTURE DEFINITION"

     5 .PP

     6 .nf

     7 \f(CWtypedef struct{

     8   Uint8 type;

     9   Uint8 gain;

    10   Uint8 state;

    11 } SDL_ActiveEvent;\fR

    12 .fi

    13 .PP

    14 .SH "STRUCTURE DATA"

    15 .TP 20

    16 \fBtype\fR

    17 \fBSDL_ACTIVEEVENT\&.\fP

    18 .TP 20

    19 \fBgain\fR

    20 0 if the event is a loss or 1 if it is a gain\&.

    21 .TP 20

    22 \fBstate\fR

    23 \fBSDL_APPMOUSEFOCUS\fP if mouse focus was gained or lost, \fBSDL_APPINPUTFOCUS\fP if input focus was gained or lost, or \fBSDL_APPACTIVE\fP if the application was iconified (\fBgain\fR=0) or restored(\fBgain\fR=1)\&.

    24 .SH "DESCRIPTION"

    25 .PP

    26 \fBSDL_ActiveEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used when an event of type \fBSDL_ACTIVEEVENT\fP is reported\&.

    27 .PP

    28 When the mouse leaves or enters the window area a \fBSDL_APPMOUSEFOCUS\fP type activation event occurs, if the mouse entered the window then \fBgain\fR will be 1, otherwise \fBgain\fR will be 0\&. A \fBSDL_APPINPUTFOCUS\fP type activation event occurs when the application loses or gains keyboard focus\&. This usually occurs when another application is made active\&. Finally, a \fBSDL_APPACTIVE\fP type event occurs when the application is either minimised/iconified (\fBgain\fR=0) or restored\&.

    29 .PP

    30 .RS

    31 \fBNote:  

    32 .PP

    33 This event does not occur when an application window is first created\&.

    34 .RE

    35 .SH "SEE ALSO"

    36 .PP

    37 \fI\fBSDL_Event\fR\fR, \fI\fBSDL_GetAppState\fP\fR

    38 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59