gtkmm  3.91.0
Public Member Functions | Related Functions | List of all members
Gdk::EventPadAxis Class Reference

Generated during Gdk::InputSource::TABLET_PAD interaction with tactile sensors. More...

#include <gdkmm/event.h>

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

Public Member Functions

 EventPadAxis ()
 Creates an invalid event object. More...
 
 EventPadAxis (GdkEventPadAxis* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
void swap (EventPadAxis& other) noexcept
 
GdkEventPadAxis* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEventPadAxis* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEventPadAxis* gobj_copy () const
 Provides access to the underlying C instance. More...
 
guint32 get_time () const
 Returns the timestamp of the event in milliseconds. More...
 
guint get_group () const
 Returns the pad group the ring/strip belongs to. More...
 
guint get_index () const
 Returns the number of strip/ring that was interacted. More...
 
guint get_mode () const
 Returns the current mode of group. More...
 
double get_value () const
 Returns the current value for the given axis. More...
 
- Public Member Functions inherited from Gdk::Event
 Event ()
 Creates an invalid event object. More...
 
 Event (GdkEvent* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
 Event (const Event& other)
 
Eventoperator= (const Event& other)
 
 Event (Event&& other) noexcept
 
Eventoperator= (Event&& other) noexcept
 
 ~Event () noexcept
 
void swap (Event& other) noexcept
 
GdkEvent* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEvent* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEvent* gobj_copy () const
 Provides access to the underlying C instance. More...
 
Event::Type get_event_type () const
 Retrieves the type of the event. More...
 
Glib::RefPtr< Gdk::Windowget_window ()
 Returns the window which received the event. More...
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
bool is_send_event () const
 Returns true if the event was sent explicitly (e.g. More...
 
Glib::RefPtr< Screenget_screen ()
 Returns the screen for the event. More...
 
Glib::RefPtr< const Screenget_screen () const
 Returns the screen for the event. More...
 
Glib::RefPtr< Seatget_seat ()
 Returns the Gdk::Seat this event was generated for. More...
 
Glib::RefPtr< const Seatget_seat () const
 Returns the Gdk::Seat this event was generated for. More...
 
void put ()
 Appends a copy of the given event onto the front of the event queue for event->any.window’s display, or the default event queue if event->any.window is nullptr. More...
 

Related Functions

(Note that these are not member functions.)

void swap (EventPadAxis& lhs, EventPadAxis& rhs) noexcept
 
const EventPadAxiswrap_event (const GdkEventPadAxis*& event)
 Wraps a C event instance without making unnecessary copy when the ownership can not be acquired. More...
 
EventPadAxiswrap_event (GdkEventPadAxis*& event)
 See wrap_event(const GdkEventPadAxis*& event). More...
 
Gdk::EventPadAxis wrap (GdkEventPadAxis* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gdk::Event
enum  Type {
  Type::NOTHING = -1,
  Type::DELETE = 0,
  Type::DESTROY = 1,
  Type::EXPOSE = 2,
  Type::MOTION_NOTIFY = 3,
  Type::BUTTON_PRESS = 4,
  Type::DOUBLE_BUTTON_PRESS = 5,
  Type::TRIPLE_BUTTON_PRESS = 6,
  Type::BUTTON_RELEASE = 7,
  Type::KEY_PRESS = 8,
  Type::KEY_RELEASE = 9,
  Type::ENTER_NOTIFY = 10,
  Type::LEAVE_NOTIFY = 11,
  Type::FOCUS_CHANGE = 12,
  Type::CONFIGURE = 13,
  Type::MAP = 14,
  Type::UNMAP = 15,
  Type::PROPERTY_NOTIFY = 16,
  Type::SELECTION_CLEAR = 17,
  Type::SELECTION_REQUEST = 18,
  Type::SELECTION_NOTIFY = 19,
  Type::PROXIMITY_IN = 20,
  Type::PROXIMITY_OUT = 21,
  Type::DRAG_ENTER = 22,
  Type::DRAG_LEAVE = 23,
  Type::DRAG_MOTION = 24,
  Type::DRAG_STATUS = 25,
  Type::DROP_START = 26,
  Type::DROP_FINISHED = 27,
  Type::CLIENT_EVENT = 28,
  Type::VISIBILITY_NOTIFY = 29,
  Type::SCROLL = 31,
  Type::WINDOW_STATE = 32,
  Type::SETTING = 33,
  Type::OWNER_CHANGE = 34,
  Type::GRAB_BROKEN = 35,
  Type::DAMAGE = 36,
  Type::TOUCH_BEGIN = 37,
  Type::TOUCH_UPDATE = 38,
  Type::TOUCH_END = 39,
  Type::TOUCH_CANCEL = 40,
  Type::TOUCHPAD_SWIPE = 41,
  Type::TOUCHPAD_PINCH = 42,
  Type::PAD_BUTTON_PRESS = 43,
  Type::PAD_BUTTON_RELEASE = 44,
  Type::PAD_RING = 45,
  Type::PAD_STRIP = 46,
  Type::PAD_GROUP_MODE = 47,
  Type::EVENT_LAST = 48
}
 Specifies the type of the event. More...
 
- Static Public Member Functions inherited from Gdk::Event
static void set_show_events (bool show_events)
 Sets whether a trace of received events is output. More...
 
static bool get_show_events ()
 Gets whether event debugging output is enabled. More...
 
static Event get ()
 Checks all open displays for a Gdk::Event to process,to be processed on, fetching events from the windowing system if necessary. More...
 
static Event peek ()
 If there is an event waiting in the event queue of some open display, returns a copy of it. More...
 
static bool events_pending ()
 Checks if any events are ready to be processed for any display. More...
 

Detailed Description

Generated during Gdk::InputSource::TABLET_PAD interaction with tactile sensors.

get_event_type() will return Gdk::Event::Type::PAD_RING or Gdk::Event::Type::PAD_STRIP.

Since gtkmm 3.90:

Constructor & Destructor Documentation

Gdk::EventPadAxis::EventPadAxis ( )

Creates an invalid event object.

Calling any member functions is undefined behavior.

Gdk::EventPadAxis::EventPadAxis ( GdkEventPadAxis *  gobject,
bool  make_a_copy = false 
)
explicit

Wraps a C event instance.

This constructor either acquires ownership of gobject, or copies it.

Parameters
gobjectEvent to wrap.
make_a_copyIf false, the ownership of gobject is acquired, otherwise, a copy is made.

Member Function Documentation

guint Gdk::EventPadAxis::get_group ( ) const

Returns the pad group the ring/strip belongs to.

A Gdk::InputSource::TABLET_PAD device may have one or more groups containing a set of buttons/rings/strips each.

guint Gdk::EventPadAxis::get_index ( ) const

Returns the number of strip/ring that was interacted.

This number is 0-indexed.

guint Gdk::EventPadAxis::get_mode ( ) const

Returns the current mode of group.

Different groups in a Gdk::InputSource::TABLET_PAD device may have different current modes.

guint32 Gdk::EventPadAxis::get_time ( ) const

Returns the timestamp of the event in milliseconds.

double Gdk::EventPadAxis::get_value ( ) const

Returns the current value for the given axis.

GdkEventPadAxis* Gdk::EventPadAxis::gobj ( )
inline

Provides access to the underlying C instance.

const GdkEventPadAxis* Gdk::EventPadAxis::gobj ( ) const
inline

Provides access to the underlying C instance.

GdkEventPadAxis* Gdk::EventPadAxis::gobj_copy ( ) const

Provides access to the underlying C instance.

The caller is responsible for freeing it with gdk_event_free(). Use when directly setting fields in structs.

void Gdk::EventPadAxis::swap ( EventPadAxis other)
noexcept

Friends And Related Function Documentation

void swap ( EventPadAxis lhs,
EventPadAxis rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side
Gdk::EventPadAxis wrap ( GdkEventPadAxis *  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.
Returns
A C++ instance that wraps this C instance.
const EventPadAxis& wrap_event ( const GdkEventPadAxis *&  event)
related

Wraps a C event instance without making unnecessary copy when the ownership can not be acquired.

The event pointer must not be deleted until last usage of the returned instance. Note, that this requirement applies to the pointer itself, in addition to the object it is pointing to.

EventPadAxis& wrap_event ( GdkEventPadAxis *&  event)
related