GI.Gdk.Objects.Seat

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

Exported types

newtype Seat

Constructors

Seat (ManagedPtr Seat)

Instances

GObject Seat

Methods

gobjectType :: Seat -> IO GType

IsObject Seat

IsSeat Seat

class GObject o => IsSeat o

Instances

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

IsSeat Seat

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

noSeat :: 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

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

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

Signals

deviceAdded

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

type SeatDeviceAddedCallback = Device -> IO ()

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

genClosure_SeatDeviceAdded :: SeatDeviceAddedCallback -> IO Closure

mk_SeatDeviceAddedCallback :: C_SeatDeviceAddedCallback -> IO (FunPtr C_SeatDeviceAddedCallback)

noSeatDeviceAddedCallback :: Maybe SeatDeviceAddedCallback

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

wrap_SeatDeviceAddedCallback :: SeatDeviceAddedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO ()

deviceRemoved

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

type SeatDeviceRemovedCallback = Device -> IO ()

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

genClosure_SeatDeviceRemoved :: SeatDeviceRemovedCallback -> IO Closure

mk_SeatDeviceRemovedCallback :: C_SeatDeviceRemovedCallback -> IO (FunPtr C_SeatDeviceRemovedCallback)

noSeatDeviceRemovedCallback :: Maybe SeatDeviceRemovedCallback

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

wrap_SeatDeviceRemovedCallback :: SeatDeviceRemovedCallback -> Ptr () -> Ptr Device -> Ptr () -> IO ()

toolAdded

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

type SeatToolAddedCallback = DeviceTool -> IO ()

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

genClosure_SeatToolAdded :: SeatToolAddedCallback -> IO Closure

mk_SeatToolAddedCallback :: C_SeatToolAddedCallback -> IO (FunPtr C_SeatToolAddedCallback)

noSeatToolAddedCallback :: Maybe SeatToolAddedCallback

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

wrap_SeatToolAddedCallback :: SeatToolAddedCallback -> Ptr () -> Ptr DeviceTool -> Ptr () -> IO ()

toolRemoved

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

type SeatToolRemovedCallback = DeviceTool -> IO ()

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

genClosure_SeatToolRemoved :: SeatToolRemovedCallback -> IO Closure

mk_SeatToolRemovedCallback :: C_SeatToolRemovedCallback -> IO (FunPtr C_SeatToolRemovedCallback)

noSeatToolRemovedCallback :: Maybe SeatToolRemovedCallback

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

wrap_SeatToolRemovedCallback :: SeatToolRemovedCallback -> Ptr () -> Ptr DeviceTool -> Ptr () -> IO ()