gtkmm: Gtk::EventController Class Reference

Self-contained handler of series of events. More...

#include <gtkmm/eventcontroller.h>

Inheritance diagram for Gtk::EventController:

Public Member Functions

 EventController (EventController&& src) noexcept
 
EventControlleroperator= (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...

 
Widgetget_widget ()
 Returns the Gtk::Widget this controller relates to. More...

 
const Widgetget_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::Eventget_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::Deviceget_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::Deviceget_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< PropagationPhaseproperty_propagation_phase ()
 The propagation phase at which this controller will handle events. More...

 
Glib::PropertyProxy_ReadOnly< PropagationPhaseproperty_propagation_phase () const
 The propagation phase at which this controller will handle events. More...

 
Glib::PropertyProxy< PropagationLimitproperty_propagation_limit ()
 The limit for which events this controller will handle. More...

 
Glib::PropertyProxy_ReadOnly< PropagationLimitproperty_propagation_limit () const
 The limit for which events this controller will handle. More...

 
Glib::PropertyProxy< Glib::ustringproperty_name ()
 The name for this controller, typically used for debugging purposes. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 The name for this controller, typically used for debugging purposes. More...

 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (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::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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 ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (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...

 

Protected Member Functions

 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
 
ObjectBaseoperator= (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::EventControllerwrap (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

Self-contained handler of series of events.

This is an abstract base class, low-level implementation for event controllers. Those react to a series of Gdk::Events, and possibly trigger actions as a consequence of those.

Since gtkmm 3.14:

Constructor & Destructor Documentation

Gtk::EventController::EventController ( EventController&&  src)
noexcept
Gtk::EventController::~EventController ( )
overridenoexcept
Gtk::EventController::EventController ( )
protected

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

Member Function Documentation

Glib::RefPtr<const Gdk::Event> Gtk::EventController::get_current_event ( ) const

Returns the event that is currently being handled by the controller, and nullptr at other times.

Returns
The event is current handled by controller.
Glib::RefPtr<Gdk::Device> Gtk::EventController::get_current_event_device ( )

Returns the device of the event that is currently being handled by the controller, and nullptr otherwise.

Returns
Device of the event is current handled by controller.
Glib::RefPtr<const Gdk::Device> Gtk::EventController::get_current_event_device ( ) const

Returns the event that is currently being handled by the controller, and nullptr at other times.

Returns
The event is current handled by controller.
Gdk::ModifierType Gtk::EventController::get_current_event_state ( ) const

Returns the modifier state of the event that is currently being handled by the controller, and 0 otherwise.

Returns
Modifier state of the event is current handled by controller.
guint32 Gtk::EventController::get_current_event_time ( ) const

Returns the timestamp of the event that is currently being handled by the controller, and 0 otherwise.

Returns
Timestamp of the event is current handled by controller.
Glib::ustring Gtk::EventController::get_name ( ) const

Gets the name of controller.

PropagationLimit Gtk::EventController::get_propagation_limit ( ) const

Gets the propagation limit of the event controller.

Returns
The propagation limit.
PropagationPhase Gtk::EventController::get_propagation_phase ( ) const

Gets the propagation phase at which controller handles events.

Returns
The propagation phase.
static GType Gtk::EventController::get_type ( )
static

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

Widget* Gtk::EventController::get_widget ( )

Returns the Gtk::Widget this controller relates to.

Returns
A Gtk::Widget.
const Widget* Gtk::EventController::get_widget ( ) const

Returns the Gtk::Widget this controller relates to.

Returns
A Gtk::Widget.
GtkEventController* Gtk::EventController::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkEventController* Gtk::EventController::gobj ( ) const
inline

Provides access to the underlying C GObject.

GtkEventController* Gtk::EventController::gobj_copy ( )

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

EventController& Gtk::EventController::operator= ( EventController&&  src)
noexcept
Glib::PropertyProxy< Glib::ustring > Gtk::EventController::property_name ( )

The name for this controller, typically used for debugging purposes.

Default value: ""

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< Glib::ustring > Gtk::EventController::property_name ( ) const

The name for this controller, typically used for debugging purposes.

Default value: ""

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< PropagationLimit > Gtk::EventController::property_propagation_limit ( )

The limit for which events this controller will handle.

Default value: Gtk::PropagationLimit::SAME_NATIVE

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< PropagationLimit > Gtk::EventController::property_propagation_limit ( ) const

The limit for which events this controller will handle.

Default value: Gtk::PropagationLimit::SAME_NATIVE

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< PropagationPhase > Gtk::EventController::property_propagation_phase ( )

The propagation phase at which this controller will handle events.

Default value: Gtk::PropagationPhase::BUBBLE

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< PropagationPhase > Gtk::EventController::property_propagation_phase ( ) const

The propagation phase at which this controller will handle events.

Default value: Gtk::PropagationPhase::BUBBLE

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_ReadOnly< Widget* > Gtk::EventController::property_widget ( ) const

The widget receiving the Gdk::Events that the controller will handle.

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::EventController::reset ( )

Resets the controller to a clean state.

Every interaction the controller did through gtk_event_controller_handle_event() will be dropped at this point.

void Gtk::EventController::set_name ( const Glib::ustring name)

Sets a name on the controller that can be used for debugging.

Parameters
nameA name for controller.
void Gtk::EventController::set_propagation_limit ( PropagationLimit  limit)

Sets the event propagation limit on the event controller.

If the limit is set to Gtk::PropagationLimit::SAME_NATIVE, the controller won't handle events that are targeted at widgets on a different surface, such as popovers.

Parameters
limitThe propagation limit.
void Gtk::EventController::set_propagation_phase ( PropagationPhase  phase)

Sets the propagation phase at which a controller handles events.

If phase is Gtk::PropagationPhase::NONE, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling gtk_event_controller_handle_event().

Parameters
phaseA propagation phase.

Friends And Related Function Documentation

Glib::RefPtr< Gtk::EventController > wrap ( GtkEventController *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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.