gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::GestureSingle Class Reference

Abstract base class for mouse/single-touch gestures. More...

#include <gtkmm/gesturesingle.h>

Inheritance diagram for Gtk::GestureSingle:
Inheritance graph
[legend]

Public Member Functions

 GestureSingle (GestureSingle && src) noexcept
 
GestureSingleoperator= (GestureSingle && src) noexcept
 
 ~GestureSingle () noexcept override
 
GtkGestureSingle * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGestureSingle * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkGestureSingle * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
bool get_touch_only () const
 Returns true if the gesture is only triggered by touch events. More...
 
void set_touch_only (bool touch_only=true)
 Sets whether to handle only touch events. More...
 
bool get_exclusive () const
 Gets whether a gesture is exclusive. More...
 
void set_exclusive (bool exclusive=true) const
 Sets whether gesture is exclusive. More...
 
unsigned int get_button () const
 Returns the button number gesture listens for. More...
 
void set_button (unsigned int button=0)
 Sets the button number gesture listens to. More...
 
unsigned int get_current_button () const
 Returns the button number currently interacting with gesture, or 0 if there is none. More...
 
Gdk::EventSequence * get_current_sequence ()
 Returns the event sequence currently interacting with gesture. More...
 
const Gdk::EventSequence * get_current_sequence () const
 Returns the event sequence currently interacting with gesture. More...
 
Glib::PropertyProxy< bool > property_touch_only ()
 Whether the gesture handles only touch events. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_touch_only () const
 Whether the gesture handles only touch events. More...
 
Glib::PropertyProxy< bool > property_exclusive ()
 Whether the gesture is exclusive. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_exclusive () const
 Whether the gesture is exclusive. More...
 
Glib::PropertyProxy< unsigned int > property_button ()
 Mouse button number to listen to, or 0 to listen for any button. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_button () const
 Mouse button number to listen to, or 0 to listen for any button. More...
 
- Public Member Functions inherited from Gtk::Gesture
 Gesture (Gesture && src) noexcept
 
Gestureoperator= (Gesture && src) noexcept
 
 ~Gesture () noexcept override
 
GtkGesture * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGesture * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkGesture * 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::RefPtr< Gdk::Deviceget_device ()
 Returns the logical Gdk::Device that is currently operating on gesture. More...
 
Glib::RefPtr< const Gdk::Deviceget_device () const
 Returns the logical Gdk::Device that is currently operating on gesture. More...
 
bool set_state (EventSequenceState state)
 Sets the state of all sequences that gesture is currently interacting with. More...
 
EventSequenceState get_sequence_state (Gdk::EventSequence * sequence) const
 Returns the sequence state, as seen by gesture. More...
 
bool set_sequence_state (Gdk::EventSequence * sequence, EventSequenceState state)
 Sets the state of sequence in gesture. More...
 
std::vector< const Gdk::EventSequence * > get_sequences () const
 Returns the list of Gdk::EventSequences currently being interpreted. More...
 
Gdk::EventSequence * get_last_updated_sequence ()
 Returns the Gdk::EventSequence that was last updated on gesture. More...
 
const Gdk::EventSequence * get_last_updated_sequence () const
 Returns the Gdk::EventSequence that was last updated on gesture. More...
 
bool handles_sequence (Gdk::EventSequence * sequence) const
 Returns true if gesture is currently handling events corresponding to sequence. More...
 
Glib::RefPtr< Gdk::Eventget_last_event (Gdk::EventSequence * sequence)
 Returns the last event that was processed for sequence. More...
 
Glib::RefPtr< const Gdk::Eventget_last_event (Gdk::EventSequence * sequence) const
 Returns the last event that was processed for sequence. More...
 
bool get_point (Gdk::EventSequence * sequence, double & x, double & y) const
 If sequence is currently being interpreted by gesture, returns true and fills in x and y with the last coordinates stored for that event sequence. More...
 
bool get_bounding_box (Gdk::Rectangle & rect) const
 If there are touch sequences being currently handled by gesture, returns true and fills in rect with the bounding box containing all active touches. More...
 
bool get_bounding_box_center (double & x, double & y) const
 If there are touch sequences being currently handled by gesture, returns true and fills in x and y with the center of the bounding box containing all active touches. More...
 
bool is_active () const
 Returns true if the gesture is currently active. More...
 
bool is_recognized () const
 Returns true if the gesture is currently recognized. More...
 
void group (const Glib::RefPtr< Gesture > & group_gesture)
 Adds gesture to the same group than group_gesture. More...
 
void ungroup ()
 Separates gesture into an isolated group. More...
 
std::vector< Glib::RefPtr< Gesture > > get_group ()
 Returns all gestures in the group of gesture. More...
 
std::vector< Glib::RefPtr< const Gesture > > get_group () const
 Returns all gestures in the group of gesture. More...
 
bool is_grouped_with (const Glib::RefPtr< Gesture > & other) const
 Returns true if both gestures pertain to the same group. More...
 
Glib::SignalProxy< void(Gdk::EventSequence *)> signal_begin ()
 
Glib::SignalProxy< void(Gdk::EventSequence *)> signal_end ()
 
Glib::SignalProxy< void(Gdk::EventSequence *)> signal_update ()
 
Glib::SignalProxy< void(Gdk::EventSequence *)> signal_cancel ()
 
Glib::SignalProxy< void(Gdk::EventSequence *, EventSequenceState)> signal_sequence_state_changed ()
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_n_points () const
 The number of touch points that trigger recognition on this gesture. More...
 
- Public Member Functions inherited from Gtk::EventController
 EventController (EventController && src) noexcept
 
EventControlleroperator= (EventController && src) noexcept
 
 ~EventController () noexcept override
 
GtkEventController * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkEventController * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkEventController * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Widgetget_widget ()
 Returns the Gtk::Widget this controller relates to. More...
 
const Widgetget_widget () const
 Returns the Gtk::Widget this controller relates to. More...
 
void reset ()
 Resets the controller to a clean state. More...
 
PropagationPhase get_propagation_phase () const
 Gets the propagation phase at which controller handles events. More...
 
void set_propagation_phase (PropagationPhase phase)
 Sets the propagation phase at which a controller handles events. More...
 
PropagationLimit get_propagation_limit () const
 Gets the propagation limit of the event controller. More...
 
void set_propagation_limit (PropagationLimit limit)
 Sets the event propagation limit on the event controller. More...
 
Glib::ustring get_name () const
 Gets the name of controller. More...
 
void set_name (const Glib::ustring & name)
 Sets a name on the controller that can be used for debugging. More...
 
Glib::RefPtr< const Gdk::Eventget_current_event () const
 Returns the event that is currently being handled by the controller. More...
 
guint32 get_current_event_time () const
 Returns the timestamp of the event that is currently being handled by the controller. More...
 
Glib::RefPtr< Gdk::Deviceget_current_event_device ()
 Returns the device of the event that is currently being handled by the controller. More...
 
Glib::RefPtr< const Gdk::Deviceget_current_event_device () const
 Returns the event that is currently being handled by the controller. More...
 
Gdk::ModifierType get_current_event_state () const
 Returns the modifier state of the event that is currently being handled by the controller. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_widget () const
 The widget receiving the Gdk::Events that the controller will handle. More...
 
Glib::PropertyProxy< PropagationPhaseproperty_propagation_phase ()
 The propagation phase at which this controller will handle events. More...
 
Glib::PropertyProxy_ReadOnly< PropagationPhaseproperty_propagation_phase () const
 The propagation phase at which this controller will handle events. More...
 
Glib::PropertyProxy< PropagationLimitproperty_propagation_limit ()
 The limit for which events this controller will handle. More...
 
Glib::PropertyProxy_ReadOnly< PropagationLimitproperty_propagation_limit () const
 The limit for which events this controller will handle. More...
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 The name for this controller, typically used for debugging purposes. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 The name for this controller, typically used for debugging purposes. More...
 

Static Public Member Functions

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 Gtk::Gesture
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 Gtk::EventController
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 GestureSingle ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created. More...
 
- Protected Member Functions inherited from Gtk::Gesture
 Gesture ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created. More...
 
- Protected Member Functions inherited from Gtk::EventController
 EventController ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::GestureSinglewrap (GtkGestureSingle * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Abstract base class for mouse/single-touch gestures.

This is a subclass of Gesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through get_current_sequence() while the gesture is being interacted with.

By default gestures only react to touch events. set_touch_only() can be used to change this default behavior. Callers may also specify a mouse button number to interact with through set_button().

Since gtkmm 3.14:

Constructor & Destructor Documentation

◆ GestureSingle() [1/2]

Gtk::GestureSingle::GestureSingle ( GestureSingle &&  src)
noexcept

◆ ~GestureSingle()

Gtk::GestureSingle::~GestureSingle ( )
overridenoexcept

◆ GestureSingle() [2/2]

Gtk::GestureSingle::GestureSingle ( )
protected

There is no create() method that corresponds to this constructor, because only derived classes shall be created.

Member Function Documentation

◆ get_button()

unsigned int Gtk::GestureSingle::get_button ( ) const

Returns the button number gesture listens for.

If this is 0, the gesture reacts to any button press.

Returns
The button number, or 0 for any button.

◆ get_current_button()

unsigned int Gtk::GestureSingle::get_current_button ( ) const

Returns the button number currently interacting with gesture, or 0 if there is none.

Returns
The current button number.

◆ get_current_sequence() [1/2]

Gdk::EventSequence* Gtk::GestureSingle::get_current_sequence ( )

Returns the event sequence currently interacting with gesture.

This is only meaningful if is_active() returns true.

Returns
The current sequence.

◆ get_current_sequence() [2/2]

const Gdk::EventSequence* Gtk::GestureSingle::get_current_sequence ( ) const

Returns the event sequence currently interacting with gesture.

This is only meaningful if is_active() returns true.

Returns
The current sequence.

◆ get_exclusive()

bool Gtk::GestureSingle::get_exclusive ( ) const

Gets whether a gesture is exclusive.

For more information, see set_exclusive().

Returns
Whether the gesture is exclusive.

◆ get_touch_only()

bool Gtk::GestureSingle::get_touch_only ( ) const

Returns true if the gesture is only triggered by touch events.

Returns
true if the gesture only handles touch events.

◆ get_type()

static GType Gtk::GestureSingle::get_type ( )
static

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

◆ gobj() [1/2]

GtkGestureSingle* Gtk::GestureSingle::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkGestureSingle* Gtk::GestureSingle::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkGestureSingle* Gtk::GestureSingle::gobj_copy ( )

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

◆ operator=()

GestureSingle& Gtk::GestureSingle::operator= ( GestureSingle &&  src)
noexcept

◆ property_button() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::GestureSingle::property_button ( )

Mouse button number to listen to, or 0 to listen for any button.

Default value: 1

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

◆ property_button() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::GestureSingle::property_button ( ) const

Mouse button number to listen to, or 0 to listen for any button.

Default value: 1

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_exclusive() [1/2]

Glib::PropertyProxy< bool > Gtk::GestureSingle::property_exclusive ( )

Whether the gesture is exclusive.

Exclusive gestures only listen to pointer and pointer emulated events.

Default value: false

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

◆ property_exclusive() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GestureSingle::property_exclusive ( ) const

Whether the gesture is exclusive.

Exclusive gestures only listen to pointer and pointer emulated events.

Default value: false

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_touch_only() [1/2]

Glib::PropertyProxy< bool > Gtk::GestureSingle::property_touch_only ( )

Whether the gesture handles only touch events.

Default value: false

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

◆ property_touch_only() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::GestureSingle::property_touch_only ( ) const

Whether the gesture handles only touch events.

Default value: false

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

◆ set_button()

void Gtk::GestureSingle::set_button ( unsigned int  button = 0)

Sets the button number gesture listens to.

If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.

Parameters
buttonButton number to listen to, or 0 for any button.

◆ set_exclusive()

void Gtk::GestureSingle::set_exclusive ( bool  exclusive = true) const

Sets whether gesture is exclusive.

An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those.

Parameters
exclusivetrue to make gesture exclusive.

◆ set_touch_only()

void Gtk::GestureSingle::set_touch_only ( bool  touch_only = true)

Sets whether to handle only touch events.

If touch_only is true, gesture will only handle events of type Gdk::EventType::TOUCH_BEGIN, Gdk::EventType::TOUCH_UPDATE or Gdk::EventType::TOUCH_END. If false, mouse events will be handled too.

Parameters
touch_onlyWhether gesture handles only touch events.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::GestureSingle > wrap ( GtkGestureSingle *  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.