class Gtk::EventController

Overview

Gtk::EventController is the base class for event controllers.

These are ancillary objects associated to widgets, which react to Gdk::Events, and possibly trigger actions as a consequence.

Event controllers are added to a widget with Gtk::Widget#add_controller. It is rarely necessary to explicitly remove a controller with Gtk::Widget#remove_controller.

See the chapter on input handling for an overview of the basic concepts, such as the capture and bubble phases of even propagation.

Direct Known Subclasses

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/event_controller.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new #

Initialize a new EventController.


[View source]
def self.new(*, name : String | Nil = nil, propagation_limit : Gtk::PropagationLimit | Nil = nil, propagation_phase : Gtk::PropagationPhase | Nil = nil, widget : Gtk::Widget | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def current_event : Gdk::Event | Nil #

Returns the event that is currently being handled by the controller.

At other times, nil is returned.


[View source]
def current_event_device : Gdk::Device | Nil #

Returns the device of the event that is currently being handled by the controller.

At other times, nil is returned.


[View source]
def current_event_state : Gdk::ModifierType #

Returns the modifier state of the event that is currently being handled by the controller.

At other times, 0 is returned.


[View source]
def current_event_time : UInt32 #

Returns the timestamp of the event that is currently being handled by the controller.

At other times, 0 is returned.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String | Nil #

Gets the name of controller.


[View source]
def name=(value : String) : String #

[View source]
def name=(value : Nil) : Nil #

Set #name property to nil.


[View source]
def name=(name : String | Nil) : Nil #

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


[View source]
def name? : String | Nil #

Same as #name, but can return nil.


[View source]
def propagation_limit : Gtk::PropagationLimit #

Gets the propagation limit of the event controller.


[View source]
def propagation_limit=(limit : Gtk::PropagationLimit) : Nil #

Sets the event propagation limit on the event controller.

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


[View source]
def propagation_phase : Gtk::PropagationPhase #

Gets the propagation phase at which controller handles events.


[View source]
def propagation_phase=(phase : Gtk::PropagationPhase) : Nil #

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.


[View source]
def reset : Nil #

Resets the controller to a clean state.


[View source]
def widget : Gtk::Widget #

Returns the Gtk::Widget this controller relates to.


[View source]