GI.Gdk.Objects.Seat

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

Exported types

newtype Seat

Memory-managed wrapper type.

Constructors

Seat (ManagedPtr Seat)

Instances

GObject Seat

Defined in GI.Gdk.Objects.Seat

Methods

gobjectType :: Seat -> IO GType

IsObject Seat

Defined in GI.Gdk.Objects.Seat

IsSeat Seat

Defined in GI.Gdk.Objects.Seat

class GObject o => IsSeat o

Type class for types which can be safely cast to Seat, for instance with toSeat.

Instances

(GObject a, (UnknownAncestorError Seat a :: Constraint)) => IsSeat a

Defined in GI.Gdk.Objects.Seat

IsSeat Seat

Defined in GI.Gdk.Objects.Seat

toSeat :: (MonadIO m, IsSeat o) => o -> m Seat

Cast to Seat, for types for which this is known to be safe. For general casts, use castTo.

noSeat :: Maybe Seat

A convenience alias for Nothing :: Maybe Seat.

Methods

getCapabilities

seatGetCapabilities

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> m [SeatCapabilities]

Returns: the seat capabilities

Returns the capabilities this Seat currently has.

Since: 3.20

getDisplay

seatGetDisplay

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> m Display

Returns: a Display. This object is owned by GTK+ and must not be freed.

Returns the Display this seat belongs to.

getKeyboard

seatGetKeyboard

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> m (Maybe Device)

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

Returns the master device that routes keyboard events.

Since: 3.20

getPointer

seatGetPointer

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> m (Maybe Device)

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

Returns the master device that routes pointer events.

Since: 3.20

getSlaves

seatGetSlaves

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> [SeatCapabilities]

capabilities: capabilities to get devices for

-> m [Device]

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

Returns the slave devices that match the given capabilities.

Since: 3.20

grab

seatGrab

Arguments

:: (HasCallStack, MonadIO m, IsSeat a, IsWindow b, IsCursor c)

=> a

seat: a Seat

-> b

window: the Window which will own the grab

-> [SeatCapabilities]

capabilities: capabilities that will be grabbed

-> Bool

ownerEvents: if False then all device events are reported with respect to window and are only reported if selected by eventMask. 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 eventMask. In either mode, unreported events are discarded.

-> Maybe c

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

-> Maybe Event

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

-> Maybe SeatGrabPrepareFunc

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

-> m GrabStatus

Returns: GrabStatusSuccess if the grab was successful.

Grabs the seat so that all events corresponding to the given capabilities are passed to this application until the seat is ungrabbed with seatUngrab, 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 SeatCapabilitiesPointer, all other "pointing" capabilities (eg. SeatCapabilitiesTouch) should be grabbed too, so the user is able to interact with all of those while the grab holds, you should thus use SeatCapabilitiesAllPointing 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 ownerEvents 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.

Since: 3.20

ungrab

seatUngrab

Arguments

:: (HasCallStack, MonadIO m, IsSeat a)

=> a

seat: a Seat

-> m ()

Releases a grab added through seatGrab.

Since: 3.20

Properties

display

Display of this seat.

Since: 3.20

constructSeatDisplay :: (IsSeat o, IsDisplay a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “display” property. This is rarely needed directly, but it is used by new.

getSeatDisplay :: (MonadIO m, IsSeat o) => o -> m Display

Get the value of the “display” property. When overloading is enabled, this is equivalent to

get seat #display

Signals

deviceAdded

type C_SeatDeviceAddedCallback = Ptr () -> Ptr Device -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SeatDeviceAddedCallback

Arguments

 = Device

device: the newly added Device.

-> IO ()

The ::device-added signal is emitted when a new input device is related to this seat.

Since: 3.20

afterSeatDeviceAdded :: (IsSeat a, MonadIO m) => a -> SeatDeviceAddedCallback -> m SignalHandlerId

Connect a signal handler for the “device-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after seat #deviceAdded callback

genClosure_SeatDeviceAdded :: SeatDeviceAddedCallback -> IO Closure

Wrap the callback into a Closure.

mk_SeatDeviceAddedCallback :: C_SeatDeviceAddedCallback -> IO (FunPtr C_SeatDeviceAddedCallback)

Generate a function pointer callable from C code, from a C_SeatDeviceAddedCallback.

noSeatDeviceAddedCallback :: Maybe SeatDeviceAddedCallback

A convenience synonym for Nothing :: Maybe SeatDeviceAddedCallback.

onSeatDeviceAdded :: (IsSeat a, MonadIO m) => a -> SeatDeviceAddedCallback -> m SignalHandlerId

Connect a signal handler for the “device-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on seat #deviceAdded callback

wrap_SeatDeviceAddedCallback :: SeatDeviceAddedCallback -> C_SeatDeviceAddedCallback

Wrap a SeatDeviceAddedCallback into a C_SeatDeviceAddedCallback.

deviceRemoved

type C_SeatDeviceRemovedCallback = Ptr () -> Ptr Device -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SeatDeviceRemovedCallback

Arguments

 = Device

device: the just removed Device.

-> IO ()

The ::device-removed signal is emitted when an input device is removed (e.g. unplugged).

Since: 3.20

afterSeatDeviceRemoved :: (IsSeat a, MonadIO m) => a -> SeatDeviceRemovedCallback -> m SignalHandlerId

Connect a signal handler for the “device-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after seat #deviceRemoved callback

genClosure_SeatDeviceRemoved :: SeatDeviceRemovedCallback -> IO Closure

Wrap the callback into a Closure.

mk_SeatDeviceRemovedCallback :: C_SeatDeviceRemovedCallback -> IO (FunPtr C_SeatDeviceRemovedCallback)

Generate a function pointer callable from C code, from a C_SeatDeviceRemovedCallback.

noSeatDeviceRemovedCallback :: Maybe SeatDeviceRemovedCallback

A convenience synonym for Nothing :: Maybe SeatDeviceRemovedCallback.

onSeatDeviceRemoved :: (IsSeat a, MonadIO m) => a -> SeatDeviceRemovedCallback -> m SignalHandlerId

Connect a signal handler for the “device-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on seat #deviceRemoved callback

wrap_SeatDeviceRemovedCallback :: SeatDeviceRemovedCallback -> C_SeatDeviceRemovedCallback

Wrap a SeatDeviceRemovedCallback into a C_SeatDeviceRemovedCallback.

toolAdded

type C_SeatToolAddedCallback = Ptr () -> Ptr DeviceTool -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SeatToolAddedCallback

Arguments

 = DeviceTool

tool: the new DeviceTool known to the seat

-> IO ()

The ::tool-added signal is emitted whenever a new tool is made known to the seat. The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the Device::tool-changed signal accordingly.

A same tool may be used by several devices.

Since: 3.22

afterSeatToolAdded :: (IsSeat a, MonadIO m) => a -> SeatToolAddedCallback -> m SignalHandlerId

Connect a signal handler for the “tool-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after seat #toolAdded callback

genClosure_SeatToolAdded :: SeatToolAddedCallback -> IO Closure

Wrap the callback into a Closure.

mk_SeatToolAddedCallback :: C_SeatToolAddedCallback -> IO (FunPtr C_SeatToolAddedCallback)

Generate a function pointer callable from C code, from a C_SeatToolAddedCallback.

noSeatToolAddedCallback :: Maybe SeatToolAddedCallback

A convenience synonym for Nothing :: Maybe SeatToolAddedCallback.

onSeatToolAdded :: (IsSeat a, MonadIO m) => a -> SeatToolAddedCallback -> m SignalHandlerId

Connect a signal handler for the “tool-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on seat #toolAdded callback

wrap_SeatToolAddedCallback :: SeatToolAddedCallback -> C_SeatToolAddedCallback

Wrap a SeatToolAddedCallback into a C_SeatToolAddedCallback.

toolRemoved

type C_SeatToolRemovedCallback = Ptr () -> Ptr DeviceTool -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SeatToolRemovedCallback

Arguments

 = DeviceTool

tool: the just removed DeviceTool

-> IO ()

This signal is emitted whenever a tool is no longer known to this seat.

Since: 3.22

afterSeatToolRemoved :: (IsSeat a, MonadIO m) => a -> SeatToolRemovedCallback -> m SignalHandlerId

Connect a signal handler for the “tool-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after seat #toolRemoved callback

genClosure_SeatToolRemoved :: SeatToolRemovedCallback -> IO Closure

Wrap the callback into a Closure.

mk_SeatToolRemovedCallback :: C_SeatToolRemovedCallback -> IO (FunPtr C_SeatToolRemovedCallback)

Generate a function pointer callable from C code, from a C_SeatToolRemovedCallback.

noSeatToolRemovedCallback :: Maybe SeatToolRemovedCallback

A convenience synonym for Nothing :: Maybe SeatToolRemovedCallback.

onSeatToolRemoved :: (IsSeat a, MonadIO m) => a -> SeatToolRemovedCallback -> m SignalHandlerId

Connect a signal handler for the “tool-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on seat #toolRemoved callback

wrap_SeatToolRemovedCallback :: SeatToolRemovedCallback -> C_SeatToolRemovedCallback

Wrap a SeatToolRemovedCallback into a C_SeatToolRemovedCallback.