Self-contained handler of series of events. More...
#include <gtkmm/eventcontroller.h>
Public Member Functions | |
| 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... | |
| 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... | |
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... | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr< Gtk::EventController > | wrap (GtkEventController * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
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 GdkEvents, and possibly trigger actions as a consequence of those.
Constructor & Destructor Documentation
◆ EventController() [1/2]
|
noexcept |
◆ ~EventController()
|
overridenoexcept |
◆ EventController() [2/2]
|
protected |
There is no create() method that corresponds to this constructor, because only derived classes shall be created.
Member Function Documentation
◆ get_propagation_phase()
| PropagationPhase Gtk::EventController::get_propagation_phase | ( | ) | const |
Gets the propagation phase at which controller handles events.
- Returns
- The propagation phase.
◆ get_type()
|
static |
Get the GType for this class, for use with the underlying GObject type system.
◆ get_widget() [1/2]
| Widget * Gtk::EventController::get_widget | ( | ) |
◆ get_widget() [2/2]
| const Widget * Gtk::EventController::get_widget | ( | ) | const |
◆ gobj() [1/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj() [2/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj_copy()
| 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.
◆ handle_event()
| bool Gtk::EventController::handle_event | ( | const GdkEvent * | event | ) |
Feeds an events into controller, so it can be interpreted and the controller actions triggered.
- Parameters
-
event A Gdk::Event.
- Returns
trueif the event was potentially useful to trigger the controller action.
◆ operator=()
|
noexcept |
◆ property_propagation_phase() [1/2]
| Glib::PropertyProxy< PropagationPhase > Gtk::EventController::property_propagation_phase | ( | ) |
The propagation phase at which this controller will handle events.
Default value: Gtk::PHASE_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.
◆ property_propagation_phase() [2/2]
| Glib::PropertyProxy_ReadOnly< PropagationPhase > Gtk::EventController::property_propagation_phase | ( | ) | const |
The propagation phase at which this controller will handle events.
Default value: Gtk::PHASE_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.
◆ property_widget()
| 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.
◆ reset()
| void Gtk::EventController::reset | ( | ) |
Resets the controller to a clean state.
Every interaction the controller did through Gtk::EventController::signal_handle_event() will be dropped at this point.
◆ set_propagation_phase()
| void Gtk::EventController::set_propagation_phase | ( | PropagationPhase | phase | ) |
Sets the propagation phase at which a controller handles events.
If phase is Gtk::PHASE_NONE, no automatic event handling will be performed, but other additional gesture maintenance will. In that phase, the events can be managed by calling handle_event().
- Parameters
-
phase A propagation phase.
Friends And Related Function Documentation
◆ wrap()
|
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.
