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

Pan gesture. More...

#include <gtkmm/gesturepan.h>

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

Public Member Functions

 GesturePan (GesturePan && src) noexcept
 
GesturePanoperator= (GesturePan && src) noexcept
 
 ~GesturePan () noexcept override
 
GtkGesturePan * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGesturePan * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkGesturePan * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Orientation get_orientation () const
 Returns the orientation of the pan gestures that this gesture expects. More...
 
void set_orientation (Orientation orientation)
 Sets the orientation to be expected on pan gestures. More...
 
Glib::SignalProxy< void(PanDirection, double)> signal_pan ()
 
Glib::PropertyProxy< Orientationproperty_orientation ()
 The expected orientation of pan gestures. More...
 
Glib::PropertyProxy_ReadOnly< Orientationproperty_orientation () const
 The expected orientation of pan gestures. More...
 
- Public Member Functions inherited from Gtk::GestureDrag
 GestureDrag (GestureDrag && src) noexcept
 
GestureDragoperator= (GestureDrag && src) noexcept
 
 ~GestureDrag () noexcept override
 
GtkGestureDrag * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGestureDrag * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkGestureDrag * 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_start_point (double & x, double & y) const
 Gets the point where the drag started. More...
 
bool get_offset (double & x, double & y) const
 Gets the offset from the start point. More...
 
Glib::SignalProxy< void(double, double)> signal_drag_begin ()
 
Glib::SignalProxy< void(double, double)> signal_drag_update ()
 
Glib::SignalProxy< void(double, double)> signal_drag_end ()
 
- Public Member Functions inherited from Gtk::GestureSingle
 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 Glib::RefPtr< GesturePancreate (Orientation orientation)
 Creates a Gesture that recognizes pan gestures. More...
 
- Static Public Member Functions inherited from Gtk::GestureDrag
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< GestureDragcreate ()
 Creates a Gesture that recognizes drags. More...
 
- 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. 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

 GesturePan ()
 There is no create() method that corresponds to this constructor, because this constructor shall only be used by derived classes. More...
 
 GesturePan (Orientation orientation)
 Constructs a Gesture that recognizes pan gestures. More...
 
- Protected Member Functions inherited from Gtk::GestureDrag
 GestureDrag ()
 Constructs a Gesture that recognizes drags. More...
 
- 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. 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::GesturePanwrap (GtkGesturePan * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Pan gesture.

This is a Gesture implementation able to recognize pan gestures. Those are drags that are locked to happen along one axis. The axis that a GesturePan handles is defined at construct time, and can be changed through set_orientation().

When the gesture starts to be recognized, GesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, signal_pan() will be emitted as input events are received, containing the offset in the given axis.

Since gtkmm 3.14:

Constructor & Destructor Documentation

◆ GesturePan() [1/3]

Gtk::GesturePan::GesturePan ( GesturePan &&  src)
noexcept

◆ ~GesturePan()

Gtk::GesturePan::~GesturePan ( )
overridenoexcept

◆ GesturePan() [2/3]

Gtk::GesturePan::GesturePan ( )
protected

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

◆ GesturePan() [3/3]

Gtk::GesturePan::GesturePan ( Orientation  orientation)
explicitprotected

Constructs a Gesture that recognizes pan gestures.

Member Function Documentation

◆ create()

static Glib::RefPtr<GesturePan> Gtk::GesturePan::create ( Orientation  orientation)
static

Creates a Gesture that recognizes pan gestures.

Since gtkmm 3.14:
Parameters
orientationExpected orientation.
Returns
A RefPtr to a new GesturePan.

◆ get_orientation()

Orientation Gtk::GesturePan::get_orientation ( ) const

Returns the orientation of the pan gestures that this gesture expects.

Returns
The expected orientation for pan gestures.

◆ get_type()

static GType Gtk::GesturePan::get_type ( )
static

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

◆ gobj() [1/2]

GtkGesturePan* Gtk::GesturePan::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkGesturePan* Gtk::GesturePan::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkGesturePan* Gtk::GesturePan::gobj_copy ( )

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

◆ operator=()

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

◆ property_orientation() [1/2]

Glib::PropertyProxy< Orientation > Gtk::GesturePan::property_orientation ( )

The expected orientation of pan gestures.

Default value: Gtk::Orientation::HORIZONTAL

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

Glib::PropertyProxy_ReadOnly< Orientation > Gtk::GesturePan::property_orientation ( ) const

The expected orientation of pan gestures.

Default value: Gtk::Orientation::HORIZONTAL

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_orientation()

void Gtk::GesturePan::set_orientation ( Orientation  orientation)

Sets the orientation to be expected on pan gestures.

Parameters
orientationExpected orientation.

◆ signal_pan()

Glib::SignalProxy<void(PanDirection, double)> Gtk::GesturePan::signal_pan ( )
Slot Prototype:
void on_my_pan(PanDirection direction, double offset)

Flags: Run Last

Emitted once a panning gesture along the expected axis is detected.

Parameters
directionCurrent direction of the pan gesture.
offsetOffset along the gesture orientation.

Friends And Related Function Documentation

◆ wrap()

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