Gtk::GestureDrag Class Reference

Drag gesture. More...

#include <gtkmm/gesturedrag.h>

Inheritance diagram for Gtk::GestureDrag:

Public Member Functions
	GestureDrag (GestureDrag &&src) noexcept
GestureDrag &	operator= (GestureDrag &&src) noexcept
	~GestureDrag () noexcept override
GtkGestureDrag *	gobj ()
	Provides access to the underlying C GObject.
const GtkGestureDrag *	gobj () const
	Provides access to the underlying C GObject.
GtkGestureDrag *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool	get_start_point (double &x, double &y) const
	Gets the point where the drag started.
bool	get_offset (double &x, double &y) const
	Gets the offset from the start point.
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
GestureSingle &	operator= (GestureSingle &&src) noexcept
	~GestureSingle () noexcept override
GtkGestureSingle *	gobj ()
	Provides access to the underlying C GObject.
const GtkGestureSingle *	gobj () const
	Provides access to the underlying C GObject.
GtkGestureSingle *	gobj_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
Gesture &	operator= (Gesture &&src) noexcept
	~Gesture () noexcept override
GtkGesture *	gobj ()
	Provides access to the underlying C GObject.
const GtkGesture *	gobj () const
	Provides access to the underlying C GObject.
GtkGesture *	gobj_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::Device >	get_device ()
	Returns the logical Gdk::Device that is currently operating on gesture.
Glib::RefPtr< const Gdk::Device >	get_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::Event >	get_last_event (Gdk::EventSequence *sequence)
	Returns the last event that was processed for sequence.
Glib::RefPtr< const Gdk::Event >	get_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
EventController &	operator= (EventController &&src) noexcept
	~EventController () noexcept override
GtkEventController *	gobj ()
	Provides access to the underlying C GObject.
const GtkEventController *	gobj () const
	Provides access to the underlying C GObject.
GtkEventController *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Widget *	get_widget ()
	Returns the Gtk::Widget this controller relates to.
const Widget *	get_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::Event >	get_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::Device >	get_current_event_device ()
	Returns the device of the event that is currently being handled by the controller.
Glib::RefPtr< const Gdk::Device >	get_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< PropagationPhase >	property_propagation_phase ()
	The propagation phase at which this controller will handle events.
Glib::PropertyProxy_ReadOnly< PropagationPhase >	property_propagation_phase () const
	The propagation phase at which this controller will handle events.
Glib::PropertyProxy< PropagationLimit >	property_propagation_limit ()
	The limit for which events this controller will handle.
Glib::PropertyProxy_ReadOnly< PropagationLimit >	property_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< GestureDrag >	create ()
	Creates a Gesture that recognizes drags.
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
	GestureDrag ()
	Constructs a Gesture that recognizes drags.
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::GestureDrag >	wrap (GtkGestureDrag *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::GestureSingle
Glib::RefPtr< Gtk::GestureSingle >	wrap (GtkGestureSingle *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Gesture
Glib::RefPtr< Gtk::Gesture >	wrap (GtkGesture *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::EventController
Glib::RefPtr< Gtk::EventController >	wrap (GtkEventController *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Drag gesture.

This is a Gesture implementation that recognizes drag operations. The drag operation itself can be tracked through signal_drag_begin(), signal_drag_update() and signal_drag_end(), or the relevant coordinates be extracted through get_offset() and get_start_point().

Since gtkmm 3.14:

Constructor & Destructor Documentation

GestureDrag() [1/2]

Gtk::GestureDrag::GestureDrag ( GestureDrag &&  src )

noexcept

~GestureDrag()

Gtk::GestureDrag::~GestureDrag ( )

overridenoexcept

GestureDrag() [2/2]

Gtk::GestureDrag::GestureDrag ( )

protected

Constructs a Gesture that recognizes drags.

Member Function Documentation

create()

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

static

Creates a Gesture that recognizes drags.

Since gtkmm 3.14:

Returns

A RefPtr to a new GestureDrag.

get_offset()

bool Gtk::GestureDrag::get_offset	(	double &	x,
		double &	y
	)		const

Gets the offset from the start point.

If the gesture is active, this function returns true and fills in x and y with the coordinates of the current point, as an offset to the starting drag point.

Parameters

x	X offset for the current point.
y	Y offset for the current point.

Returns

true if the gesture is active.

get_start_point()

bool Gtk::GestureDrag::get_start_point	(	double &	x,
		double &	y
	)		const

Gets the point where the drag started.

If the gesture is active, this function returns true and fills in x and y with the drag start coordinates, in widget-relative coordinates.

Parameters

x	X coordinate for the drag start point.
y	Y coordinate for the drag start point.

Returns

true if the gesture is active.

get_type()

static GType Gtk::GestureDrag::get_type ( )

static

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

gobj() [1/2]

GtkGestureDrag * Gtk::GestureDrag::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkGestureDrag * Gtk::GestureDrag::gobj ( ) const

inline

Provides access to the underlying C GObject.

gobj_copy()

GtkGestureDrag * Gtk::GestureDrag::gobj_copy

(

)

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

operator=()

GestureDrag & Gtk::GestureDrag::operator= ( GestureDrag &&  src )

noexcept

signal_drag_begin()

Glib::SignalProxy< void(double, double)> Gtk::GestureDrag::signal_drag_begin

(

)

Slot Prototype:

void on_my_drag_begin(double start_x, double start_y)

Flags: Run Last

Emitted whenever dragging starts.

Parameters

start_x	X coordinate, relative to the widget allocation.
start_y	Y coordinate, relative to the widget allocation.

signal_drag_end()

Glib::SignalProxy< void(double, double)> Gtk::GestureDrag::signal_drag_end

(

)

Slot Prototype:

void on_my_drag_end(double offset_x, double offset_y)

Flags: Run Last

Emitted whenever the dragging is finished.

Parameters

offset_x	X offset, relative to the start point.
offset_y	Y offset, relative to the start point.

signal_drag_update()

Glib::SignalProxy< void(double, double)> Gtk::GestureDrag::signal_drag_update

(

)

Slot Prototype:

void on_my_drag_update(double offset_x, double offset_y)

Flags: Run Last

Emitted whenever the dragging point moves.

Parameters

offset_x	X offset, relative to the start point.
offset_y	Y offset, relative to the start point.

Friends And Related Symbol Documentation

wrap()

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