class: EventControllerMeta

[290:14] static extends: object

Generated metadata helpers for EventController class surfaces.

Methods

• properties ()

  Returns property metadata for EventController.

  • @r A list.

class: EventController

[19:7] extends: object

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 [method@Gtk.Widget.add_controller]. It is rarely necessary to explicitly remove a controller with [method@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 event propagation.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• EventController (Handle = null)

  Creates a new EventController by wrapping a native handle or another wrapper.

  • @p Handle is the native handle or another wrapper whose handle to adopt.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• getProperty (string Name)

  Reads one generated property by name.

• setProperty (string Name, Value)

  Writes one generated property by name.

• setName (string Value)

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

  • @p Value is the new property value.
  • @r None.

• setPropagationlimit (string Value)

  The limit for which events this controller will handle.

  • @p Value is the new property value.
  • @r None.

• setPropagationphase (string Value)

  The propagation phase at which this controller will handle events.

  • @p Value is the new property value.
  • @r None.

• get_current_event ()

  Returns the event that is currently being handled by the controller. At other times, %NULL is returned.

• get_current_event_device ()

  Returns the device of the event that is currently being handled by the controller. At other times, %NULL is returned.

• get_current_event_state ()

  Returns the modifier state of the event that is currently being handled by the controller. At other times, 0 is returned.

• get_name ()

  Gets the name of @controller.

• get_propagation_limit ()

  Gets the propagation limit of the event controller.

• get_propagation_phase ()

  Gets the propagation phase at which @controller handles events.

• get_widget ()

  Returns the GtkWidget this controller relates to.

• reset ()

  Resets the @controller to a clean state.

  • @r None.

• set_name (string name)

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

  • @p name is a name for @controller.
  • @r None.

• set_propagation_limit (string limit)

  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.

  • @p limit is the propagation limit.
  • @r None.

• set_propagation_phase (string 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.
  • @p phase is a propagation phase.
  • @r None.

• set_static_name (string name)

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

  • @p name is a name for @controller, must be a static string.
  • @r None.