Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Gdk.Objects.DeviceTool

Contents

Exported types
Methods
Properties

Description

No description available in the introspection data.

Synopsis

newtype DeviceTool = DeviceTool (ManagedPtr DeviceTool)
class (GObject o, IsDescendantOf DeviceTool o) => IsDeviceTool o
toDeviceTool :: (MonadIO m, IsDeviceTool o) => o -> m DeviceTool
noDeviceTool :: Maybe DeviceTool
deviceToolGetHardwareId :: (HasCallStack, MonadIO m, IsDeviceTool a) => a -> m Word64
deviceToolGetSerial :: (HasCallStack, MonadIO m, IsDeviceTool a) => a -> m Word64
deviceToolGetToolType :: (HasCallStack, MonadIO m, IsDeviceTool a) => a -> m DeviceToolType
constructDeviceToolAxes :: IsDeviceTool o => [AxisFlags] -> IO (GValueConstruct o)
getDeviceToolAxes :: (MonadIO m, IsDeviceTool o) => o -> m [AxisFlags]
constructDeviceToolHardwareId :: IsDeviceTool o => Word64 -> IO (GValueConstruct o)
getDeviceToolHardwareId :: (MonadIO m, IsDeviceTool o) => o -> m Word64
constructDeviceToolSerial :: IsDeviceTool o => Word64 -> IO (GValueConstruct o)
getDeviceToolSerial :: (MonadIO m, IsDeviceTool o) => o -> m Word64
constructDeviceToolToolType :: IsDeviceTool o => DeviceToolType -> IO (GValueConstruct o)
getDeviceToolToolType :: (MonadIO m, IsDeviceTool o) => o -> m DeviceToolType

Exported types

newtype DeviceTool Source #

Memory-managed wrapper type.

Constructors

DeviceTool (ManagedPtr DeviceTool)

Instances

GObject DeviceTool Source #
Instance details Defined in GI.Gdk.Objects.DeviceTool Methods gobjectType :: IO GType #
HasParentTypes DeviceTool Source #
Instance details Defined in GI.Gdk.Objects.DeviceTool
type ParentTypes DeviceTool Source #
Instance details Defined in GI.Gdk.Objects.DeviceTool type ParentTypes DeviceTool = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf DeviceTool o) => IsDeviceTool o Source #

Type class for types which can be safely cast to DeviceTool, for instance with toDeviceTool.

Instances

(GObject o, IsDescendantOf DeviceTool o) => IsDeviceTool o Source #
Instance details Defined in GI.Gdk.Objects.DeviceTool

toDeviceTool :: (MonadIO m, IsDeviceTool o) => o -> m DeviceTool Source #

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

noDeviceTool :: Maybe DeviceTool Source #

A convenience alias for Nothing :: Maybe DeviceTool.

Methods

getHardwareId

deviceToolGetHardwareId Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTool a)
=> a	`tool`: a `DeviceTool`
-> m Word64	Returns: The hardware identificator of this tool.

Gets the hardware ID of this tool, or 0 if it's not known. When non-zero, the identificator is unique for the given tool model, meaning that two identical tools will share the same hardwareId, but will have different serial numbers (see deviceToolGetSerial).

This is a more concrete (and device specific) method to identify a DeviceTool than deviceToolGetToolType, as a tablet may support multiple devices with the same DeviceToolType, but having different hardware identificators.

Since: 3.22

getSerial

deviceToolGetSerial Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTool a)
=> a	`tool`: a `DeviceTool`
-> m Word64	Returns: The serial ID for this tool

Gets the serial of this tool, this value can be used to identify a physical tool (eg. a tablet pen) across program executions.

Since: 3.22

getToolType

deviceToolGetToolType Source #

Arguments

:: (HasCallStack, MonadIO m, IsDeviceTool a)
=> a	`tool`: a `DeviceTool`
-> m DeviceToolType	Returns: The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil.

Gets the DeviceToolType of the tool.

Since: 3.22

Properties

axes

No description available in the introspection data.

constructDeviceToolAxes :: IsDeviceTool o => [AxisFlags] -> IO (GValueConstruct o) Source #

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

getDeviceToolAxes :: (MonadIO m, IsDeviceTool o) => o -> m [AxisFlags] Source #

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

get deviceTool #axes

hardwareId

No description available in the introspection data.

constructDeviceToolHardwareId :: IsDeviceTool o => Word64 -> IO (GValueConstruct o) Source #

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

getDeviceToolHardwareId :: (MonadIO m, IsDeviceTool o) => o -> m Word64 Source #

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

get deviceTool #hardwareId

serial

No description available in the introspection data.

constructDeviceToolSerial :: IsDeviceTool o => Word64 -> IO (GValueConstruct o) Source #

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

getDeviceToolSerial :: (MonadIO m, IsDeviceTool o) => o -> m Word64 Source #

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

get deviceTool #serial

toolType

No description available in the introspection data.

constructDeviceToolToolType :: IsDeviceTool o => DeviceToolType -> IO (GValueConstruct o) Source #

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

getDeviceToolToolType :: (MonadIO m, IsDeviceTool o) => o -> m DeviceToolType Source #

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

get deviceTool #toolType