gtkmm 4.14.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gtk::GestureSwipe Class Reference

Swipe gesture. More...

#include <gtkmm/gestureswipe.h>

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

Public Member Functions

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

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static Glib::RefPtr< GestureSwipecreate ()
 Creates a Gesture that recognizes swipes.
 
- Static Public Member Functions inherited from Gtk::GestureSingle
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
- 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.
 
- 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.
 

Protected Member Functions

 GestureSwipe ()
 Constructs a Gesture that recognizes swipes.
 
- Protected Member Functions inherited from Gtk::GestureSingle
 GestureSingle ()
 There is no create() method that corresponds to this constructor, because only derived classes shall be created.
 
- 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.
 
- 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.
 

Related Symbols

(Note that these are not member symbols.)

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

Detailed Description

Swipe gesture.

This is a Gesture implementation able to recognize swipes. After a press/move/.../move/release sequence happens, signal_swipe() will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, get_velocity() can be called on eg. a Gesture::signal_update() handler.

All velocities are reported in pixels/sec units.

Since gtkmm 3.14:

Constructor & Destructor Documentation

◆ GestureSwipe() [1/2]

Gtk::GestureSwipe::GestureSwipe ( GestureSwipe &&  src)
noexcept

◆ ~GestureSwipe()

Gtk::GestureSwipe::~GestureSwipe ( )
overridenoexcept

◆ GestureSwipe() [2/2]

Gtk::GestureSwipe::GestureSwipe ( )
protected

Constructs a Gesture that recognizes swipes.

Member Function Documentation

◆ create()

static Glib::RefPtr< GestureSwipe > Gtk::GestureSwipe::create ( )
static

Creates a Gesture that recognizes swipes.

Since gtkmm 3.14:
Returns
A RefPtr to a new GestureSwipe.

◆ get_type()

static GType Gtk::GestureSwipe::get_type ( )
static

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

◆ get_velocity()

bool Gtk::GestureSwipe::get_velocity ( double velocity_x,
double velocity_y 
) const

Gets the current velocity.

If the gesture is recognized, this function returns true and fills in velocity_x and velocity_y with the recorded velocity, as per the last events processed.

Parameters
velocity_xReturn value for the velocity in the X axis, in pixels/sec.
velocity_yReturn value for the velocity in the Y axis, in pixels/sec.
Returns
Whether velocity could be calculated.

◆ gobj() [1/2]

GtkGestureSwipe * Gtk::GestureSwipe::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkGestureSwipe * Gtk::GestureSwipe::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkGestureSwipe * Gtk::GestureSwipe::gobj_copy ( )

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

◆ operator=()

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

◆ signal_swipe()

Glib::SignalProxy< void(double, double)> Gtk::GestureSwipe::signal_swipe ( )
Slot Prototype:
void on_my_swipe(double velocity_x, double velocity_y)

Flags: Run Last

Emitted when the recognized gesture is finished.

Velocity and direction are a product of previously recorded events.

Parameters
velocity_xVelocity in the X axis, in pixels/sec.
velocity_yVelocity in the Y axis, in pixels/sec.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::GestureSwipe > wrap ( GtkGestureSwipe 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.