Class: Gdk::Seat

  • Object
show all
Defined in:


The Gdk::Seat object represents a collection of input devices that belong to a user.

Instance Method Summary collapse

Instance Method Details


Returns the capabilities this Gdk::Seat currently has.



Gdk::Display of this seat.


#display=(display) ⇒ Gdk::Display

Gdk::Display of this seat.



#get_slaves(capabilities) ⇒ GLib::List

Returns the slave devices that match the given capabilities.



  • (GLib::List)

    A list of Gdk::Devices. The list must be freed with g_list_free(), the elements are owned by GDK and must not be freed.

#grab(window, capabilities, owner_events, cursor, event, prepare_func, prepare_func_data) ⇒ Gdk::GrabStatus

Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with gdk_seat_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 Gdk::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 Gdk::EventGrabBroken events that are emitted when the grab ends unvoluntarily.


  • window (Gdk::Window)

    the Gdk::Window which will own the grab

  • capabilities (Gdk::SeatCapabilities)

    capabilities that will be grabbed

  • owner_events (TrueClass)

    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 (Gdk::Cursor)

    the cursor to display while the grab is active. If this is nil then the normal cursors are used for window and its descendants, and the cursor for window is used elsewhere.

  • event (Gdk::Event)

    the event that is triggering the grab, or nil if none is available.

  • prepare_func (Gdk::SeatGrabPrepareFunc)

    function to prepare the window to be grabbed, it can be nil if window is visible before this call.

  • prepare_func_data (GObject)

    user data to pass to prepare_func



Returns the master device that routes keyboard events.


  • (Gdk::Device)

    a master Gdk::Device with keyboard capabilities. This object is owned by GTK+ and must not be freed.


Returns the master device that routes pointer events.


  • (Gdk::Device)

    a master Gdk::Device with pointer capabilities. This object is owned by GTK+ and must not be freed.


Releases a grab added through gdk_seat_grab().


  • (nil)