gtkmm 3.16.0

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::GestureRotate Class Reference
Event Controllers and Gestures

Rotate gesture. More...

`#include <gtkmm/gesturerotate.h>`

Inheritance diagram for Gtk::GestureRotate:
[legend]

## Public Member Functions

virtual | ~GestureRotate ()
GtkGestureRotate* | gobj ()
| Provides access to the underlying C GObject. More...
const GtkGestureRotate* | gobj () const
| Provides access to the underlying C GObject. More...
GtkGestureRotate* | 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_angle_delta () const
| If gesture is active, this function returns the angle difference in radians since the gesture was first recognized. More...
Glib::SignalProxy2< void, double, double > | signal_angle_changed ()
Public Member Functions inherited from Gtk::Gesture
virtual | ~Gesture ()
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::Device > | get_device ()
| Returns the master Gdk::Device that is currently operating on gesture, or `0` if the gesture is not being interacted. More...
Glib::RefPtr< const Gdk::Device > | get_device () const
| Returns the master Gdk::Device that is currently operating on gesture, or `0` if the gesture is not being interacted. More...
bool | set_state (EventSequenceState state)
| Sets the state of all sequences that gesture is currently interacting with. More...
EventSequenceState | get_sequence_state (GdkEventSequence*sequence) const
| Returns the sequence state, as seen by gesture. More...
bool | set_sequence_state (GdkEventSequence*sequence, EventSequenceState state)
| Sets the state of sequence in gesture. More...
std::vector< const GdkEventSequence* > | get_sequences () const
| Returns the list of GdkEventSequences currently being interpreted. More...
GdkEventSequence* | get_last_updated_sequence ()
| Returns the Gdk::EventSequence that was last updated on gesture. More...
const GdkEventSequence* | get_last_updated_sequence () const
| Returns the Gdk::EventSequence that was last updated on gesture. More...
bool | handles_sequence (GdkEventSequence*sequence) const
| Returns `true` if gesture is currently handling events corresponding to sequence. More...
const GdkEvent* | get_last_event (GdkEventSequence*sequence) const
| Returns the last event that was processed for sequence. More...
bool | get_point (GdkEventSequence*sequence, double& x, double& y) const
| If sequence is currently being interpreted by gesture, this function 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, this function 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, this function 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...
Glib::RefPtr< Gdk::Window > | get_window ()
| Returns the user-defined window that receives the events handled by gesture. More...
Glib::RefPtr< const Gdk::Window > | get_window () const
| Returns the user-defined window that receives the events handled by gesture. More...
void | set_window (const Glib::RefPtr< Gdk::Window >& window)
| Sets a specific window to receive events about, so gesture will effectively handle only events targeting window, or a child of it. More...
void | unset_window ()
| Undoes the effect of previous calls to set_window(), so the gesture will handle events targeting any Gdk::Window that pertains to Gtk::EventController::get_widget(). 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::SignalProxy1< void, GdkEventSequence* > | signal_begin ()
Glib::SignalProxy1< void, GdkEventSequence* > | signal_end ()
Glib::SignalProxy1< void, GdkEventSequence* > | signal_update ()
Glib::SignalProxy1< void, GdkEventSequence* > | signal_cancel ()
Glib::SignalProxy2< void, GdkEventSequence*, EventSequenceState > | signal_sequence_state_changed ()
Glib::PropertyProxy_ReadOnly< unsigned int > | property_n_points () const
| Number of points needed to trigger the gesture. More...
Glib::PropertyProxy< Glib::RefPtr< Gdk::Window > > | property_window ()
| GdkWindow to receive events about. More...
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > | property_window () const
| GdkWindow to receive events about. More...
Public Member Functions inherited from Gtk::EventController
virtual | ~EventController ()
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...
Widget* | get_widget ()
| Returns the Gtk::Widget this controller relates to. More...
const Widget* | get_widget () const
| Returns the Gtk::Widget this controller relates to. More...
bool | handle_event (const GdkEvent* event)
| Feeds an events into controller, so it can be interpreted and the controller actions triggered. 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...
Glib::PropertyProxy_ReadOnly< Widget* > | property_widget () const
| Widget the gesture relates to. More...
Glib::PropertyProxy< PropagationPhase > | property_propagation_phase ()
| Propagation phase at which this controller is run. More...
Glib::PropertyProxy_ReadOnly< PropagationPhase > | property_propagation_phase () const
| Propagation phase at which this controller is run. More...
Public Member Functions inherited from Glib::Object
void * | get_data (const QueryQuark &key)
void | set_data (const Quark &key, void *data)
void | set_data (const Quark &key, void *data, DestroyNotify notify)
void | remove_data (const QueryQuark &quark)
void * | steal_data (const QueryQuark &quark)
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false)
Public Member Functions inherited from Glib::ObjectBase
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void | set_property (const Glib::ustring &property_name, const PropertyType &value)
void | get_property (const Glib::ustring &property_name, PropertyType &value) const
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void | freeze_notify ()
void | thaw_notify ()
virtual void | reference () const
virtual void | unreference () const
GObject * | gobj ()
const GObject * | gobj () const
GObject * | gobj_copy () const

## 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< GestureRotate > | create (Widget& widget)
| Creates a Gesture that recognizes 2-touch rotation gestures. 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

| GestureRotate ()
| There is no create() method that corresponds to this constructor, because this constructor shall only be used by derived classes. More...
| GestureRotate (Widget& widget)
| Constructs a Gesture that recognizes 2-touch rotation gestures. 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...
Protected Member Functions inherited from Glib::Object
| Object ()
| Object (const Glib::ConstructParams &construct_params)
| Object (GObject *castitem)
virtual | ~Object ()
Protected Member Functions inherited from Glib::ObjectBase
| ObjectBase ()
| ObjectBase (const char *custom_type_name)
| ObjectBase (const std::type_info &custom_type_info)
virtual | ~ObjectBase ()=0
void | initialize (GObject *castitem)

## Related Functions

(Note that these are not member functions.)
Glib::RefPtr< Gtk::GestureRotate > | wrap (GtkGestureRotate* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gtk::Gesture
Glib::RefPtr< Gtk::Gesture > | wrap (GtkGesture* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gtk::EventController
Glib::RefPtr< Gtk::EventController > | wrap (GtkEventController* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Additional Inherited Members

Public Types inherited from Glib::Object
typedef void(* | DestroyNotify) (gpointer data)

## Detailed Description

Rotate gesture.

This is a Gesture implementation able to recognize 2-finger rotations. Whenever the angle between both handled sequences changes, signal_angle_changed() is emitted.

Since gtkmm 3.14:

## Constructor & Destructor Documentation

virtual Gtk::GestureRotate::~GestureRotate | ( |  | ) |

virtual

Gtk::GestureRotate::GestureRotate | ( |  | ) |

protected

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

Gtk::GestureRotate::GestureRotate | ( | Widget& | widget | ) |

explicit protected

Constructs a Gesture that recognizes 2-touch rotation gestures.

## Member Function Documentation

static Glib::RefPtr<GestureRotate> Gtk::GestureRotate::create | ( | Widget& | widget | ) |

static

Creates a Gesture that recognizes 2-touch rotation gestures.

Since gtkmm 3.14:

Parameters

  widget | Widget the gesture relates to.

Returns
  A RefPtr to a new GestureRotate.

double Gtk::GestureRotate::get_angle_delta | ( |  | ) | const

If gesture is active, this function returns the angle difference in radians since the gesture was first recognized.

If gesture is not active, 0 is returned.

Since gtkmm 3.14:

Returns
  The angle delta in radians.

static GType Gtk::GestureRotate::get_type | ( |  | ) |

static

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

GtkGestureRotate* Gtk::GestureRotate::gobj | ( |  | ) |

inline

Provides access to the underlying C GObject.

const GtkGestureRotate* Gtk::GestureRotate::gobj | ( |  | ) | const

inline

Provides access to the underlying C GObject.

GtkGestureRotate* Gtk::GestureRotate::gobj_copy | ( |  | ) |

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

Glib::SignalProxy2< void,double,double > Gtk::GestureRotate::signal_angle_changed | ( |  | ) |

Slot Prototype:
  `void on_my_angle_changed(double angle, double angle_delta)`

This signal is emitted when the angle between both tracked points changes.

Since gtkmm 3.14:

Parameters

  angle | Current angle in radians.
  angle_delta | Difference with the starting angle, in radians.

## Friends And Related Function Documentation

Glib::RefPtr< Gtk::GestureRotate > wrap | ( | GtkGestureRotate * | object,
|  | bool | take_copy = `false`
| ) |  |

related

A Glib::wrap() method for this object.

Parameters

  object | The C instance.
  take_copy | False 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.