gtkmm: Gtk::GestureSingle Class Reference
Abstract base class for mouse/single-touch gestures. More...
#include <gtkmm/gesturesingle.h>
Public Member Functions | |
GestureSingle (GestureSingle&& src) noexcept | |
GestureSingle& | operator= (GestureSingle&& src) noexcept |
~GestureSingle () noexcept override | |
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::EventType::TOUCH_BEGIN, Gdk::EventType::TOUCH_UPDATE or Gdk::EventType::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... | |
Gdk::EventSequence* | get_current_sequence () |
Returns the event sequence currently interacting with gesture. More... | |
const Gdk::EventSequence* | 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... | |
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. 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 logical 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 logical 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 (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::Event > | get_last_event (Gdk::EventSequence* sequence) |
Returns the last event that was processed for sequence. More... | |
Glib::RefPtr< const Gdk::Event > | get_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, 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... | |
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 | |
EventController& | operator= (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... | |
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... | |
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::Event > | get_current_event () const |
Returns the event that is currently being handled by the controller, and nullptr at other times. More... | |
guint32 | get_current_event_time () const |
Returns the timestamp of the event that is currently being handled by the controller, and 0 otherwise. More... | |
Glib::RefPtr< Gdk::Device > | get_current_event_device () |
Returns the device of the event that is currently being handled by the controller, and nullptr otherwise. More... | |
Glib::RefPtr< const Gdk::Device > | get_current_event_device () const |
Returns the event that is currently being handled by the controller, and nullptr at other times. More... | |
Gdk::ModifierType | get_current_event_state () const |
Returns the modifier state of the event that is currently being handled by the controller, and 0 otherwise. 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... | |
Glib::PropertyProxy< PropagationLimit > | property_propagation_limit () |
The limit for which events this controller will handle. More... | |
Glib::PropertyProxy_ReadOnly< PropagationLimit > | property_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... | |
Public Member Functions inherited from Glib::Object | |
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) |
Public Member Functions inherited from Glib::ObjectBase | |
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 |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (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 |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *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 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 | |
GestureSingle () | |
There is no create() method that corresponds to this constructor, because only derived classes shall be created. 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) | |
~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
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::GestureSingle > | wrap (GtkGestureSingle* 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(*)(gpointer data | DestroyNotify) |
Public Types inherited from sigc::trackable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
Abstract base class for mouse/single-touch gestures.
This is a subclass of Gesture, optimized (although not restricted) for dealing with mouse and single-touch gestures. Under interaction, these gestures stick to the first interacting sequence, which is accessible through get_current_sequence() while the gesture is being interacted with.
By default gestures only react to touch events. set_touch_only() can be used to change this default behavior. Callers may also specify a mouse button number to interact with through set_button().
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
protected |
There is no create() method that corresponds to this constructor, because only derived classes shall be created.
Member Function Documentation
unsigned int Gtk::GestureSingle::get_button | ( | ) | const |
Returns the button number gesture listens for, or 0 if gesture reacts to any button press.
- Returns
- The button number, or 0 for any button.
unsigned int Gtk::GestureSingle::get_current_button | ( | ) | const |
Returns the button number currently interacting with gesture, or 0 if there is none.
- Returns
- The current button number.
Gdk::EventSequence* Gtk::GestureSingle::get_current_sequence | ( | ) |
Returns the event sequence currently interacting with gesture.
This is only meaningful if is_active() returns true
.
- Returns
- The current sequence.
const Gdk::EventSequence* Gtk::GestureSingle::get_current_sequence | ( | ) | const |
Returns the event sequence currently interacting with gesture.
This is only meaningful if is_active() returns true
.
- Returns
- The current sequence.
bool Gtk::GestureSingle::get_exclusive | ( | ) | const |
Gets whether a gesture is exclusive.
For more information, see set_exclusive().
- Returns
- Whether the gesture is exclusive.
bool Gtk::GestureSingle::get_touch_only | ( | ) | const |
Returns true
if the gesture is only triggered by touch events.
- Returns
true
if the gesture only handles touch events.
|
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.
GtkGestureSingle* Gtk::GestureSingle::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< unsigned int > Gtk::GestureSingle::property_button | ( | ) |
Mouse button number to listen to, or 0 to listen for any button.
Default value: 1
- 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< unsigned int > Gtk::GestureSingle::property_button | ( | ) | const |
Mouse button number to listen to, or 0 to listen for any button.
Default value: 1
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::GestureSingle::property_exclusive | ( | ) |
Whether the gesture is exclusive.
Exclusive gestures only listen to pointer and pointer emulated events.
Default value: false
- 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< bool > Gtk::GestureSingle::property_exclusive | ( | ) | const |
Whether the gesture is exclusive.
Exclusive gestures only listen to pointer and pointer emulated events.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::GestureSingle::property_touch_only | ( | ) |
Whether the gesture handles only touch events.
Default value: false
- 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< bool > Gtk::GestureSingle::property_touch_only | ( | ) | const |
Whether the gesture handles only touch events.
Default value: false
- 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::GestureSingle::set_button | ( | unsigned int | button = 0 | ) |
Sets the button number gesture listens to.
If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.
- Parameters
-
button Button number to listen to, or 0 for any button.
void Gtk::GestureSingle::set_exclusive | ( | bool | exclusive = true | ) | const |
Sets whether gesture is exclusive.
An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those.
- Parameters
-
exclusive true
to make gesture exclusive.
void Gtk::GestureSingle::set_touch_only | ( | bool | touch_only = true | ) |
If touch_only is true
, gesture will only handle events of type Gdk::EventType::TOUCH_BEGIN, Gdk::EventType::TOUCH_UPDATE or Gdk::EventType::TOUCH_END.
If false
, mouse events will be handled too.
- Parameters
-
touch_only Whether gesture handles only touch events.
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.