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

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

#include <gdkmm/devicetool.h>

Inherits Object.

Public Types

enum  Type {
  Type::UNKNOWN,
  Type::PEN,
  Type::ERASER,
  Type::BRUSH,
  Type::PENCIL,
  Type::AIRBRUSH,
  Type::MOUSE,
  Type::LENS
}
 Indicates the specific type of tool being used being a tablet. More...
 

Public Member Functions

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

Static Public Member Functions

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

Related Functions

(Note that these are not member functions.)

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

Detailed Description

A physical tool associated to a Gdk::Device.

Since gtkmm 3.94:

Constructor & Destructor Documentation

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

Member Function Documentation

AxisFlags Gdk::DeviceTool::get_axes ( ) const

Gets the axes of the tool.

Returns
The axes of tool.
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 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 [method Gdk.DeviceTool.get_serial]).

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

Returns
The hardware identificator of this tool.
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.
Type Gdk::DeviceTool::get_tool_type ( ) const

Gets the GdkDeviceToolType 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.
static GType Gdk::DeviceTool::get_type ( )
static

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

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

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.

DeviceTool& Gdk::DeviceTool::operator= ( DeviceTool&&  src)
noexcept
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.
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.
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.
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 Function Documentation

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.