[sdl_omap.git] / docs / man3 / SDL_WM_GrabInput.3

.TH "SDL_WM_GrabInput" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_WM_GrabInput \- Grabs mouse and keyboard input\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDL_GrabMode \fBSDL_WM_GrabInput\fP\fR(\fBSDL_GrabMode mode\fR);
.SH "DESCRIPTION"
.PP
Grabbing means that the mouse is confined to the application window, and nearly all keyboard input is passed directly to the application, and not interpreted by a window manager, if any\&.
.PP
When \fBmode\fR is \fBSDL_GRAB_QUERY\fP the grab mode is not changed, but the current grab mode is returned\&.
.PP
.PP
.nf
\f(CWtypedef enum {
  SDL_GRAB_QUERY,
  SDL_GRAB_OFF,
  SDL_GRAB_ON
} SDL_GrabMode;\fR
.fi
.PP
 
.SH "RETURN VALUE"
.PP
The current/new \fBSDL_GrabMode\fR\&.
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01
Commit	Line	Data
e14743d1	1	.TH "SDL_WM_GrabInput" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
	2	.SH "NAME"
	3	SDL_WM_GrabInput \- Grabs mouse and keyboard input\&.
	4	.SH "SYNOPSIS"
	5	.PP
	6	\fB#include "SDL\&.h"
	7	.sp
	8	\fBSDL_GrabMode \fBSDL_WM_GrabInput\fP\fR(\fBSDL_GrabMode mode\fR);
	9	.SH "DESCRIPTION"
	10	.PP
	11	Grabbing means that the mouse is confined to the application window, and nearly all keyboard input is passed directly to the application, and not interpreted by a window manager, if any\&.
	12	.PP
	13	When \fBmode\fR is \fBSDL_GRAB_QUERY\fP the grab mode is not changed, but the current grab mode is returned\&.
	14	.PP
	15	.PP
	16	.nf
	17	\f(CWtypedef enum {
	18	SDL_GRAB_QUERY,
	19	SDL_GRAB_OFF,
	20	SDL_GRAB_ON
	21	} SDL_GrabMode;\fR
	22	.fi
	23	.PP
	24
	25	.SH "RETURN VALUE"
	26	.PP
	27	The current/new \fBSDL_GrabMode\fR\&.
	28	.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01