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

Zoom gesture. More...

#include <gtkmm/gesturezoom.h>

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

Public Member Functions

 GestureZoom (GestureZoom && src) noexcept
 
GestureZoomoperator= (GestureZoom && src) noexcept
 
 ~GestureZoom () noexcept override
 
GtkGestureZoom * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkGestureZoom * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkGestureZoom * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
double get_scale_delta () const
 Gets the scale delta. More...
 
Glib::SignalProxy< void(double)> signal_scale_changed ()
 
- 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< GestureZoomcreate ()
 Creates a Gesture that recognizes zoom in/out gestures (usually known as pinch/zoom). 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

 GestureZoom ()
 Constructs a Gesture that recognizes zoom in/out gestures (usually known as pinch/zoom). 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::GestureZoomwrap (GtkGestureZoom * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Zoom gesture.

This is a Gesture implementation able to recognize pinch/zoom gestures. Whenever the distance between both tracked sequences changes, signal_scale_changed() is emitted to report the scale factor.

Since gtkmm 3.14:

Constructor & Destructor Documentation

◆ GestureZoom() [1/2]

Gtk::GestureZoom::GestureZoom ( GestureZoom &&  src)
noexcept

◆ ~GestureZoom()

Gtk::GestureZoom::~GestureZoom ( )
overridenoexcept

◆ GestureZoom() [2/2]

Gtk::GestureZoom::GestureZoom ( )
protected

Constructs a Gesture that recognizes zoom in/out gestures (usually known as pinch/zoom).

Member Function Documentation

◆ create()

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

Creates a Gesture that recognizes zoom in/out gestures (usually known as pinch/zoom).

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

◆ get_scale_delta()

double Gtk::GestureZoom::get_scale_delta ( ) const

Gets the scale delta.

If gesture is active, this function returns the zooming difference since the gesture was recognized (hence the starting point is considered 1:1). If gesture is not active, 1 is returned.

Returns
The scale delta.

◆ get_type()

static GType Gtk::GestureZoom::get_type ( )
static

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

◆ gobj() [1/2]

GtkGestureZoom* Gtk::GestureZoom::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkGestureZoom* Gtk::GestureZoom::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkGestureZoom* Gtk::GestureZoom::gobj_copy ( )

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

◆ operator=()

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

◆ signal_scale_changed()

Glib::SignalProxy<void(double)> Gtk::GestureZoom::signal_scale_changed ( )
Slot Prototype:
void on_my_scale_changed(double scale)

Flags: Run First

Emitted whenever the distance between both tracked sequences changes.

Parameters
scaleScale delta, taking the initial state as 1:1.

Friends And Related Function Documentation

◆ wrap()

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