Gtk.EventController – gtk4 – Vala Binding Reference

Description:

[ CCode ( type_id = "gtk_event_controller_get_type ()" ) ]
public abstract class EventController : Object

`GtkEventController` is the base class for event controllers.

These are ancillary objects associated to widgets, which react to `GdkEvents`, and possibly trigger actions as a consequence.

Event controllers are added to a widget with [[email protected]_controller]. It is rarely necessary to explicitly remove a controller with [[email protected]_controller].

See the chapter on [input handling](input-handling.html) for an overview of the basic concepts, such as the capture and bubble phases of even propagation.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public string name { get; set; }

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

public PropagationLimit propagation_limit { get; set; }

The limit for which events this controller will handle.

public PropagationPhase propagation_phase { get; set; }

The propagation phase at which this controller will handle events.

public Widget widget { get; }

The widget receiving the `GdkEvents` that the controller will handle.

Creation methods:

Methods:

public unowned Event? get_current_event ()

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

public unowned Device? get_current_event_device ()

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

public ModifierType get_current_event_state ()

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

public uint32 get_current_event_time ()

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

public unowned string? get_name ()

Gets the name of this.

public PropagationLimit get_propagation_limit ()

Gets the propagation limit of the event controller.

public PropagationPhase get_propagation_phase ()

Gets the propagation phase at which this handles events.

public unowned Widget get_widget ()

Returns the `GtkWidget` this controller relates to.

public void reset ()

Resets the this to a clean state.

public void set_name (string? name)

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

public void set_propagation_limit (PropagationLimit limit)

Sets the event propagation limit on the event controller.

public void set_propagation_phase (PropagationPhase phase)

Sets the propagation phase at which a controller handles events.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref