Function

Gdkkeyboard_grab

Declaration [src]

GdkGrabStatus
gdk_keyboard_grab (
  GdkWindow* window,
  gboolean owner_events,
  guint32 time_
)

Description [src]

Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with gdk_keyboard_ungrab(). This overrides any previous keyboard grab by this client.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

Deprecated since:	3.0
Use `gdk_device_grab()` instead.

Parameters

`window`	`GdkWindow`
	The `GdkWindow` which will own the grab (the grab window).
	The data is owned by the caller of the function.
`owner_events`	`gboolean`
	If `FALSE` then all keyboard events are reported with respect to `window`. If `TRUE` then keyboard events for this application are reported as normal, but keyboard events outside this application are reported with respect to `window`. Both key press and key release events are always reported, independant of the event mask set by the application.
`time_`	`guint32`
	A timestamp from a `GdkEvent`, or `GDK_CURRENT_TIME` if no timestamp is available.

Return value

Returns:	`GdkGrabStatus`
	`GDK_GRAB_SUCCESS` if the grab was successful.