DeviceToolProtocol

public protocol DeviceToolProtocol : ObjectProtocol

The DeviceToolProtocol protocol exposes the methods and properties of an underlying GdkDeviceTool instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see DeviceTool. Alternatively, use DeviceToolRef as a lighweight, unowned reference if you already have an instance you just want to use.

A physical tool associated to a GdkDevice.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkDeviceTool instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • device_tool_ptr Default implementation

    Typed pointer to the underlying GdkDeviceTool instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GdkDeviceTool instance.

    Declaration

    Swift

    var device_tool_ptr: UnsafeMutablePointer<GdkDeviceTool>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to DeviceToolProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

DeviceTool Class

  • Bind a DeviceToolPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: DeviceToolPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a DeviceTool property

    Declaration

    Swift

    @inlinable
func get(property: DeviceToolPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a DeviceTool property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: DeviceToolPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

DeviceTool Class: DeviceToolProtocol extension (methods and fields)

  • getAxes() Extension method

    Gets the axes of the tool.

    Declaration

    Swift

    @inlinable
func getAxes() -> AxisFlags
    Show on GitHub
  • getHardwareId() Extension method

    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 hardware_id, but will have different serial numbers (see [methodGdk.DeviceTool.get_serial]).

    This is a more concrete (and device specific) method to identify a GdkDeviceTool than [methodGdk.DeviceTool.get_tool_type], as a tablet may support multiple devices with the same GdkDeviceToolType, but different hardware identificators.

    Declaration

    Swift

    @inlinable
func getHardwareId() -> guint64
    Show on GitHub
  • getSerial() Extension method

    Gets the serial number of this tool.

    This value can be used to identify a physical tool (eg. a tablet pen) across program executions.

    Declaration

    Swift

    @inlinable
func getSerial() -> guint64
    Show on GitHub
  • getToolType() Extension method

    Gets the GdkDeviceToolType of the tool.

    Declaration

    Swift

    @inlinable
func getToolType() -> GdkDeviceToolType
    Show on GitHub
  • axes Extension method

    The axes of the tool.

    Declaration

    Swift

    @inlinable
var axes: AxisFlags { get }
    Show on GitHub
  • hardwareId Extension method

    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 hardware_id, but will have different serial numbers (see [methodGdk.DeviceTool.get_serial]).

    This is a more concrete (and device specific) method to identify a GdkDeviceTool than [methodGdk.DeviceTool.get_tool_type], as a tablet may support multiple devices with the same GdkDeviceToolType, but different hardware identificators.

    Declaration

    Swift

    @inlinable
var hardwareId: guint64 { get }
    Show on GitHub
  • serial Extension method

    The serial number of the tool.

    Declaration

    Swift

    @inlinable
var serial: guint64 { get }
    Show on GitHub
  • toolType Extension method

    Gets the GdkDeviceToolType of the tool.

    Declaration

    Swift

    @inlinable
var toolType: GdkDeviceToolType { get }
    Show on GitHub