Struct gdk4::DeviceTool

#[repr(transparent)]
pub struct DeviceTool { /* private fields */ }

A physical tool associated to a Device.

Properties

axes

The axes of the tool.

Readable | Writeable | Construct Only

hardware-id

The hardware ID of the tool.

Readable | Writeable | Construct Only

serial

The serial number of the tool.

Readable | Writeable | Construct Only

tool-type

The type of the tool.

Readable | Writeable | Construct Only

Implementations

impl DeviceTool

pub fn axes(&self) -> AxisFlags

Gets the axes of the tool.

Returns

the axes of @self

pub fn hardware_id(&self) -> u64

Gets the hardware ID of this tool, or 0 if it’s not known.

When non-zero, the identifier 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 serial()).

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

Returns

The hardware identifier of this tool.

pub fn serial(&self) -> u64

Gets the serial number of this tool.

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

Returns

The serial ID for this tool

pub fn tool_type(&self) -> DeviceToolType

Gets the DeviceToolType of the tool.

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.

Trait Implementations

impl Clone for DeviceTool

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DeviceTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for DeviceTool

type ParamSpec = ParamSpecObject

type SetValue = DeviceTool

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DeviceTool>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DeviceTool

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DeviceTool

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for DeviceTool

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DeviceTool

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DeviceTool

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DeviceTool

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DeviceTool