gtkmm  3.95.1
Public Member Functions | Protected Member Functions | List of all members
Gdk::DeviceWithPad Class Reference

A Gdk::DeviceWithPad is a Gdk::Device that implements the Gdk::DevicePad interface. More...

#include <gdkmm/devicewithpad.h>

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

Public Member Functions

 DeviceWithPad (DeviceWithPad&& src) noexcept
 
DeviceWithPadoperator= (DeviceWithPad&& src) noexcept
 
 ~DeviceWithPad () noexcept override
 
- Public Member Functions inherited from Gdk::Device
 Device (Device&& src) noexcept
 
Deviceoperator= (Device&& src) noexcept
 
 ~Device () noexcept override
 
GdkDevice* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdkDevice* gobj () const
 Provides access to the underlying C GObject. More...
 
GdkDevice* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Determines the name of the device. More...
 
bool get_has_cursor () const
 Determines whether the pointer follows device motion. More...
 
InputSource get_source () const
 Determines the type of the device. More...
 
InputMode get_mode () const
 Determines the mode of the device. More...
 
bool set_mode (InputMode mode)
 Sets a the mode of an input device. More...
 
int get_n_keys () const
 Returns the number of keys the device currently has. More...
 
bool get_key (guint index_, guint& keyval, ModifierType& modifiers) const
 If index has a valid keyval, this function will return true and fill in keyval and modifiers with the keyval settings. More...
 
void set_key (guint index_, guint keyval, ModifierType modifiers)
 Specifies the X key event to generate when a macro button of a device is pressed. More...
 
AxisUse get_axis_use (guint index_) const
 Returns the axis use for index. More...
 
void set_axis_use (guint index_, AxisUse use)
 Specifies how an axis of a device is used. More...
 
void get_state (const Glib::RefPtr< Surface >& surface, double& axes, ModifierType& mask)
 Gets the current state of a pointer device relative to surface. More...
 
std::vector< TimeCoordget_history (const Glib::RefPtr< Surface >& surface, guint32 start, guint32 stop) const
 Obtains the motion history for a device. More...
 
std::vector< Glib::RefPtr< Gdk::Device > > list_slave_devices ()
 If the device if of type Gdk::Device::Type::MASTER, it will return the list of slave devices attached to it, otherwise it will return nullptr More...
 
int get_n_axes () const
 Returns the number of axes the device currently has. More...
 
std::vector< std::stringlist_axes () const
 Returns the labels for the axes that the device currently has. More...
 
bool get_axis_value (double& axes, GdkAtom axis_label, double& value) const
 Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis label, as returned by list_axes() More...
 
bool get_axis (double& axes, AxisUse use, double& value) const
 Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use. More...
 
Glib::RefPtr< Displayget_display ()
 Returns the Gdk::Display to which device pertains. More...
 
Glib::RefPtr< const Displayget_display () const
 Returns the Gdk::Display to which device pertains. More...
 
Glib::RefPtr< Deviceget_associated_device ()
 Returns the associated device to device, if device is of type Gdk::Device::Type::MASTER, it will return the paired pointer or keyboard. More...
 
Glib::RefPtr< const Deviceget_associated_device () const
 Returns the associated device to device, if device is of type Gdk::Device::Type::MASTER, it will return the paired pointer or keyboard. More...
 
Type get_device_type () const
 Returns the device type for device. More...
 
void get_position (double& x, double& y) const
 Gets the current location of the device in double precision. More...
 
Glib::RefPtr< Surfaceget_surface_at_position (double& win_x, double& win_y)
 Obtains the surface underneath device, returning the location of the device in win_x and win_y in double precision. More...
 
Glib::RefPtr< const Surfaceget_surface_at_position (double& win_x, double& win_y) const
 Obtains the surface underneath device, returning the location of the device in win_x and win_y in double precision. More...
 
Glib::RefPtr< Surfaceget_surface_at_position ()
 Obtains the surface underneath the device. More...
 
Glib::RefPtr< const Surfaceget_surface_at_position () const
 Obtains the surface underneath the device. More...
 
Glib::RefPtr< Surfaceget_last_event_surface ()
 Gets information about which surface the given pointer device is in, based on events that have been received so far from the display server. More...
 
Glib::RefPtr< const Surfaceget_last_event_surface () const
 Gets information about which surface the given pointer device is in, based on events that have been received so far from the display server. More...
 
Glib::ustring get_vendor_id () const
 Returns the vendor ID of this device, or nullptr if this information couldn't be obtained. More...
 
Glib::ustring get_product_id ()
 Returns the product ID of this device, or nullptr if this information couldn't be obtained. More...
 
Glib::RefPtr< Seatget_seat ()
 Returns the Gdk::Seat the device belongs to. More...
 
Glib::RefPtr< const Seatget_seat () const
 Returns the Gdk::Seat the device belongs to. More...
 
AxisFlags get_axes () const
 Returns the axes currently available on the device. More...
 
bool has_device_pad () const
 Checks if this Device instance is a DeviceWithPad. More...
 
Glib::RefPtr< DeviceWithPaddevice_with_pad_cast ()
 Casts this Device instance to a DeviceWithPad, if possible. More...
 
Glib::RefPtr< const DeviceWithPaddevice_with_pad_cast () const
 Casts this Device instance to a DeviceWithPad, if possible. More...
 
Glib::SignalProxy< void()> signal_changed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< DeviceTool >&)> signal_tool_changed ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Display > > property_display () const
 The Gdk::Display the Gdk::Device pertains to. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 The device name. More...
 
Glib::PropertyProxy_ReadOnly< Typeproperty_type () const
 Device role in the device manager. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Device > > property_associated_device () const
 Associated pointer or keyboard with this device, if any. More...
 
Glib::PropertyProxy_ReadOnly< InputSourceproperty_input_source () const
 Source type for the device. More...
 
Glib::PropertyProxy< InputModeproperty_input_mode ()
 Input mode for the device. More...
 
Glib::PropertyProxy_ReadOnly< InputModeproperty_input_mode () const
 Input mode for the device. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_cursor () const
 Whether the device is represented by a cursor on the screen. More...
 
Glib::PropertyProxy_ReadOnly< guint > property_n_axes () const
 Number of axes in the device. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_vendor_id () const
 Vendor ID of this device, see Gdk::Device::get_vendor_id(). More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_product_id () const
 Product ID of this device, see Gdk::Device::get_product_id(). More...
 
Glib::PropertyProxy< Glib::RefPtr< Seat > > property_seat ()
 Gdk::Seat of this device. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Seat > > property_seat () const
 Gdk::Seat of this device. More...
 
Glib::PropertyProxy_ReadOnly< guint > property_num_touches () const
 The maximal number of concurrent touches on a touch device. More...
 
Glib::PropertyProxy_ReadOnly< AxisFlagsproperty_axes () const
 The axes currently available for this device. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< DeviceTool > > property_tool () const
 The tool that is currently used with this device. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 
- Public Member Functions inherited from Gdk::DevicePad
 DevicePad (DevicePad&& src) noexcept
 
DevicePadoperator= (DevicePad&& src) noexcept
 
 ~DevicePad () noexcept override
 
GdkDevicePad* gobj ()
 Provides access to the underlying C GObject. More...
 
const GdkDevicePad* gobj () const
 Provides access to the underlying C GObject. More...
 
int get_n_groups () const
 Returns the number of groups this pad device has. More...
 
int get_group_n_modes (int group_idx) const
 Returns the number of modes that group may have. More...
 
int get_n_features (Feature feature) const
 Returns the number of features a tablet pad has. More...
 
int get_feature_group (Feature feature, int feature_idx) const
 Returns the group the given feature and idx belong to, or -1 if feature/index do not exist in pad. More...
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 

Protected Member Functions

 DeviceWithPad (GdkDevice* castitem)
 
- Protected Member Functions inherited from Gdk::Device
 Device ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 
- Protected Member Functions inherited from Gdk::DevicePad
 DevicePad ()
 You should derive from this class to use it. More...
 

Additional Inherited Members

- Public Types inherited from Gdk::Device
enum  Type {
  Type::MASTER,
  Type::SLAVE,
  Type::FLOATING
}
 Indicates the device type. More...
 
- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from Gdk::DevicePad
enum  Feature {
  Feature::BUTTON,
  Feature::RING,
  Feature::STRIP
}
 A pad feature. More...
 
- Static Public Member Functions inherited from Gdk::Device
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Gdk::DevicePad
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Detailed Description

A Gdk::DeviceWithPad is a Gdk::Device that implements the Gdk::DevicePad interface.

Use Gdk::Device::has_device_pad() to check if a Gdk::Device is in fact a Gdk::DeviceWithPad. Use Gdk::Device::device_with_pad_cast() to get a Glib::RefPtr<Gdk::DeviceWithPad>.

Constructor & Destructor Documentation

Gdk::DeviceWithPad::DeviceWithPad ( GdkDevice *  castitem)
explicitprotected
Gdk::DeviceWithPad::DeviceWithPad ( DeviceWithPad&&  src)
noexcept
Gdk::DeviceWithPad::~DeviceWithPad ( )
overridenoexcept

Member Function Documentation

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