gtkmm
3.13.5
|
Swipe gesture. More...
#include <gtkmm/gestureswipe.h>
Public Member Functions | |
virtual | ~GestureSwipe () |
GtkGestureSwipe* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkGestureSwipe* | gobj () const |
Provides access to the underlying C GObject. More... | |
GtkGestureSwipe* | 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_velocity (double& velocity_x, double& velocity_y) const |
If the gesture is recognized, this function returns true and fill in velocity_x and velocity_y with the recorded velocity, as per the last event(s) processed. More... | |
Glib::SignalProxy2< void, double, double > | signal_swipe () |
![]() | |
virtual | ~GestureSingle () |
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) |
If touch_only is true , gesture will only handle events of type Gdk::TOUCH_BEGIN, Gdk::TOUCH_UPDATE or Gdk::TOUCH_END. 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, or 0 if gesture reacts to any button press. 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... | |
GdkEventSequence* | get_current_sequence () |
Returns the event sequence currently interacting with gesture. More... | |
const GdkEventSequence* | 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 () |
Button number to listen to. More... | |
Glib::PropertyProxy_ReadOnly < unsigned int > | property_button () const |
Button number to listen to. More... | |
![]() | |
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... | |
![]() | |
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... | |
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< GestureSwipe > | create (Widget& widget) |
Creates a Gesture that recognizes swipes. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
GestureSwipe () | |
There is no create() method that corresponds to this constructor, because this constructor shall only be used by derived classes. More... | |
GestureSwipe (Widget& widget) | |
Constructs a Gesture that recognizes swipes. More... | |
![]() | |
GestureSingle () | |
There is no create() method that corresponds to this constructor, because only derived classes shall be created. More... | |
![]() | |
Gesture () | |
There is no create() method that corresponds to this constructor, because only derived classes shall be created. More... | |
![]() | |
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::GestureSwipe > | wrap (GtkGestureSwipe* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::GestureSingle > | wrap (GtkGestureSingle* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Gesture > | wrap (GtkGesture* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr < Gtk::EventController > | wrap (GtkEventController* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
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.
|
virtual |
|
protected |
There is no create() method that corresponds to this constructor, because this constructor shall only be used by derived classes.
|
explicitprotected |
Constructs a Gesture that recognizes swipes.
|
static |
Creates a Gesture that recognizes swipes.
widget | Widget the gesture relates to. |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::GestureSwipe::get_velocity | ( | double & | velocity_x, |
double & | velocity_y | ||
) | const |
If the gesture is recognized, this function returns true
and fill in velocity_x and velocity_y with the recorded velocity, as per the last event(s) processed.
velocity_x | Return value for the velocity in the X axis, in pixels/sec. |
velocity_y | Return value for the velocity in the Y axis, in pixels/sec. |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
Glib::SignalProxy2< void,double,double > Gtk::GestureSwipe::signal_swipe | ( | ) |
void on_my_swipe(double velocity_x, double velocity_y)
This signal is emitted when the recognized gesture is finished, velocity and direction are a product of previously recorded events.
velocity_x | Velocity in the X axis, in pixels/sec. |
velocity_y | Velocity in the Y axis, in pixels/sec. |
|
related |
A Glib::wrap() method for this object.
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. |