gtkmm: Gtk::GesturePan Class Reference
Pan gesture. More...
#include <gtkmm/gesturepan.h>

Public Member Functions |
|
GesturePan ( GesturePan && src) noexcept | |
GesturePan & | operator= ( GesturePan && src) noexcept |
~GesturePan () noexceptoverride | |
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 < Orientation > | property_orientation () |
The expected orientation of pan gestures.
More...
|
|
Glib::PropertyProxy_ReadOnly < Orientation > | property_orientation () const |
The expected orientation of pan gestures.
More...
|
|
![]() |
|
GestureDrag ( GestureDrag && src) noexcept | |
GestureDrag & | operator= ( GestureDrag && src) noexcept |
~GestureDrag () noexceptoverride | |
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 |
If the
gesture
is active, this function returns
true
and fills in
x
and
y
with the drag start coordinates, in window-relative coordinates.
More...
|
|
bool | get_offset (double& x, double& y) const |
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.
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 () |
![]() |
|
GestureSingle ( GestureSingle && src) noexcept | |
GestureSingle & | operator= ( GestureSingle && src) noexcept |
~GestureSingle () noexceptoverride | |
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 () |
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...
|
|
![]() |
|
Gesture ( Gesture && src) noexcept | |
Gesture & | operator= ( Gesture && src) noexcept |
~Gesture () noexceptoverride | |
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
nullptr
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
nullptr
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::SignalProxy < void, GdkEventSequence* > | signal_begin () |
Glib::SignalProxy < void, GdkEventSequence* > | signal_end () |
Glib::SignalProxy < void, GdkEventSequence* > | signal_update () |
Glib::SignalProxy < void, GdkEventSequence* > | signal_cancel () |
Glib::SignalProxy < void, GdkEventSequence*, 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...
|
|
Glib::PropertyProxy < Glib::RefPtr < Gdk::Window > > | property_window () |
If non-
nullptr
, the gesture will only listen for events that happen on this
Gdk::Window
, or a child of it.
More...
|
|
Glib::PropertyProxy_ReadOnly < Glib::RefPtr < Gdk::Window > > | property_window () const |
If non-
nullptr
, the gesture will only listen for events that happen on this
Gdk::Window
, or a child of it.
More...
|
|
![]() |
|
EventController ( EventController && src) noexcept | |
EventController & | operator= ( EventController && src) noexcept |
~EventController () noexceptoverride | |
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 |
The widget receiving the Gdk::Events that the controller will handle.
More...
|
|
Glib::PropertyProxy < PropagationPhase > | property_propagation_phase () |
The propagation phase at which this controller will handle events.
More...
|
|
Glib::PropertyProxy_ReadOnly < PropagationPhase > | property_propagation_phase () const |
The propagation phase at which this controller will handle events.
More...
|
|
![]() |
|
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object ( Object &&src) noexcept | |
Object & | operator= ( Object &&src) noexcept |
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) |
![]() |
|
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
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) |
void | connect_property_changed (const Glib::ustring &property_name, sigc::slot < void > &&slot) |
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot < void > &slot) |
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, 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 |
![]() |
|
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable ( trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= ( trackable &&src) |
void | remove_destroy_notify_callback (void *data) 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 < GesturePan > | create ( Widget & widget, Orientation orientation) |
Creates a
Gesture
that recognizes pan gestures.
More...
|
|
![]() |
|
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
static Glib::RefPtr < GestureDrag > | create ( Widget & widget) |
Creates a
Gesture
that recognizes drags.
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 |
|
GesturePan () | |
There is no
create()
method that corresponds to this constructor, because this constructor shall only be used by derived classes.
More...
|
|
GesturePan ( Widget & widget, Orientation orientation) | |
Constructs a
Gesture
that recognizes pan gestures.
More...
|
|
![]() |
|
GestureDrag () | |
There is no
create()
method that corresponds to this constructor, because this constructor shall only be used by derived classes.
More...
|
|
GestureDrag ( Widget & widget) | |
Constructs a
Gesture
that recognizes drags.
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...
|
|
![]() |
|
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexceptoverride | |
![]() |
|
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase ( ObjectBase &&src) noexcept | |
ObjectBase & | operator= ( ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Related Functions |
|
(Note that these are not member functions.) |
|
Glib::RefPtr < Gtk::GesturePan > | wrap (GtkGesturePan* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
![]() |
|
Glib::RefPtr < Gtk::GestureDrag > | wrap (GtkGestureDrag* 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...
|
|
Additional Inherited Members |
|
![]() |
|
typedef void(*)(gpointer data | DestroyNotify ) |
![]() |
|
typedef internal::func_destroy_notify | func_destroy_notify |
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.
Constructor & Destructor Documentation
|
noexcept |
|
override noexcept |
|
protected |
There is no create() method that corresponds to this constructor, because this constructor shall only be used by derived classes.
|
explicit protected |
Constructs a Gesture that recognizes pan gestures.
Member Function Documentation
|
static |
Creates a Gesture that recognizes pan gestures.
- Parameters
-
widget Widget the gesture relates to. orientation Expected orientation.
- Returns
- A RefPtr to a new GesturePan .
Orientation Gtk::GesturePan::get_orientation | ( | ) | const |
Returns the orientation of the pan gestures that this gesture expects.
- Returns
- The expected orientation for pan gestures.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
|
noexcept |
Glib::PropertyProxy < Orientation > Gtk::GesturePan::property_orientation | ( | ) |
The expected orientation of pan gestures.
- 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.
Glib::PropertyProxy_ReadOnly < Orientation > Gtk::GesturePan::property_orientation | ( | ) | const |
The expected orientation of pan gestures.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::GesturePan::set_orientation | ( | Orientation | orientation | ) |
Sets the orientation to be expected on pan gestures.
- Parameters
-
orientation Expected orientation.
Glib::SignalProxy < void, PanDirection ,double > Gtk::GesturePan::signal_pan | ( | ) |
- Slot Prototype:
-
void on_my_pan(PanDirection direction, double offset)
This signal is emitted once a panning gesture along the expected axis is detected.
- Parameters
-
direction Current direction of the pan gesture. offset Offset along the gesture orientation.
Friends And Related Function Documentation
|
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.