gtkmm 4.14.0
Public Types | Public Member Functions | Static Public Member Functions | Related Symbols | List of all members
Gdk::DeviceTool Class Reference

A physical tool associated to a Gdk::Device. More...

#include <gdkmm/devicetool.h>

Inheritance diagram for Gdk::DeviceTool:
Inheritance graph
[legend]

Public Types

enum class  Type {
  UNKNOWN ,
  PEN ,
  ERASER ,
  BRUSH ,
  PENCIL ,
  AIRBRUSH ,
  MOUSE ,
  LENS
}
 

Public Member Functions

 DeviceTool (DeviceTool && src) noexcept
 
DeviceTooloperator= (DeviceTool && src) noexcept
 
 ~DeviceTool () noexcept override
 
GdkDeviceTool * gobj ()
 Provides access to the underlying C GObject.
 
const GdkDeviceTool * gobj () const
 Provides access to the underlying C GObject.
 
GdkDeviceTool * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 
guint64 get_serial () const
 Gets the serial number of this tool.
 
guint64 get_hardware_id () const
 Gets the hardware ID of this tool, or 0 if it's not known.
 
Type get_tool_type () const
 Gets the Gdk::DeviceTool::Type of the tool.
 
AxisFlags get_axes () const
 Gets the axes of the tool.
 
Glib::PropertyProxy_ReadOnly< guint64 > property_serial () const
 The serial number of the tool.
 
Glib::PropertyProxy_ReadOnly< Typeproperty_tool_type () const
 The type of the tool.
 
Glib::PropertyProxy_ReadOnly< AxisFlagsproperty_axes () const
 The axes of the tool.
 
Glib::PropertyProxy_ReadOnly< guint64 > property_hardware_id () const
 The hardware ID of the tool.
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 

Related Symbols

(Note that these are not member symbols.)

Glib::RefPtr< Gdk::DeviceToolwrap (GdkDeviceTool * object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

A physical tool associated to a Gdk::Device.

Since gtkmm 3.94:

Member Enumeration Documentation

◆ Type

enum class Gdk::DeviceTool::Type
strong
Enumerator
UNKNOWN 

Tool is of an unknown type.

PEN 

Tool is a standard tablet stylus.

ERASER 

Tool is standard tablet eraser.

BRUSH 

Tool is a brush stylus.

PENCIL 

Tool is a pencil stylus.

AIRBRUSH 

Tool is an airbrush stylus.

MOUSE 

Tool is a mouse.

LENS 

Tool is a lens cursor.

Constructor & Destructor Documentation

◆ DeviceTool()

Gdk::DeviceTool::DeviceTool ( DeviceTool &&  src)
noexcept

◆ ~DeviceTool()

Gdk::DeviceTool::~DeviceTool ( )
overridenoexcept

Member Function Documentation

◆ get_axes()

AxisFlags Gdk::DeviceTool::get_axes ( ) const

Gets the axes of the tool.

Returns
The axes of tool.

◆ get_hardware_id()

guint64 Gdk::DeviceTool::get_hardware_id ( ) const

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 get_serial()).

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

Returns
The hardware identifier of this tool.

◆ get_serial()

guint64 Gdk::DeviceTool::get_serial ( ) const

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.

◆ get_tool_type()

Type Gdk::DeviceTool::get_tool_type ( ) const

Gets the Gdk::DeviceTool::Type 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.

◆ get_type()

static GType Gdk::DeviceTool::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GdkDeviceTool * Gdk::DeviceTool::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GdkDeviceTool * Gdk::DeviceTool::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GdkDeviceTool * Gdk::DeviceTool::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

DeviceTool & Gdk::DeviceTool::operator= ( DeviceTool &&  src)
noexcept

◆ property_axes()

Glib::PropertyProxy_ReadOnly< AxisFlags > Gdk::DeviceTool::property_axes ( ) const

The axes of the tool.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_hardware_id()

Glib::PropertyProxy_ReadOnly< guint64 > Gdk::DeviceTool::property_hardware_id ( ) const

The hardware ID of the tool.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_serial()

Glib::PropertyProxy_ReadOnly< guint64 > Gdk::DeviceTool::property_serial ( ) const

The serial number of the tool.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_tool_type()

Glib::PropertyProxy_ReadOnly< Type > Gdk::DeviceTool::property_tool_type ( ) const

The type of the tool.

Default value: Gdk::DeviceTool::Type::UNKNOWN

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gdk::DeviceTool > wrap ( GdkDeviceTool *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.