grab

Description:

[ Version ( since = "3.20" ) ]
public GrabStatus grab (Window window, SeatCapabilities capabilities, bool owner_events, Cursor? cursor, Event? event, SeatGrabPrepareFunc? prepare_func)

Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with ungrab, or the window becomes hidden.

This overrides any previous grab on the seat by this client.

As a rule of thumb, if a grab is desired over gdk_seat_capability_pointer, all other "pointing" capabilities (eg. gdk_seat_capability_touch) should be grabbed too, so the user is able to interact with all of those while the grab holds, you should thus use gdk_seat_capability_all_pointing most commonly.

Grabs are used for operations which need complete control over the events corresponding to the given capabilities. For example in GTK+ this is used for Drag and Drop operations, popup menus and such.

Note that if the event mask of a Window has selected both button press and button release events, or touch begin and touch end, then a press event will cause an automatic grab until the button is released, equivalent to a grab on the window with owner_events set to true. This is done because most applications expect to receive paired press and release events.

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 EventGrabBroken events that are emitted when the grab ends unvoluntarily.

Parameters:

this	a Seat
window	the Window which will own the grab
capabilities	capabilities that will be grabbed
owner_events	if false then all device events are reported with respect to `window` and are only reported if selected by `event_mask`. If true then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to `window` and only if selected by `event_mask`. In either mode, unreported events are discarded.
cursor	the cursor to display while the grab is active. If this is null then the normal cursors are used for `window` and its descendants, and the cursor for `window` is used elsewhere.
event	the event that is triggering the grab, or null if none is available.
prepare_func	function to prepare the window to be grabbed, it can be null if `window` is visible before this call.
prepare_func_data	user data to pass to `prepare_func`

Returns:

gdk_grab_success if the grab was successful.