Class: Gtk::EventController

Inherits:

Object

• Object
• Gtk::EventController

Defined in:

(unknown)

Direct Known Subclasses

DropControllerMotion, DropTarget, DropTargetAsync, EventControllerFocus, EventControllerKey, EventControllerLegacy, EventControllerMotion, EventControllerScroll, Gesture, PadController, ShortcutController

Instance Method Summary

• #current_event ⇒ Gdk::Event

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

• #current_event_device ⇒ Gdk::Device

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

• #current_event_state ⇒ Gdk::ModifierType

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

• #current_event_time ⇒ Integer

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

• #name ⇒ String

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

• #name=(name) ⇒ String

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

• #propagation_limit ⇒ Gtk::PropagationLimit

  The limit for which events this controller will handle.

• #propagation_limit=(propagation_limit) ⇒ Gtk::PropagationLimit

  The limit for which events this controller will handle.

• #propagation_phase ⇒ Gtk::PropagationPhase

  The propagation phase at which this controller will handle events.

• #propagation_phase=(propagation_phase) ⇒ Gtk::PropagationPhase

  The propagation phase at which this controller will handle events.

• #reset ⇒ nil

  Resets the controller to a clean state.

• #static_name=(name) ⇒ nil

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

• #widget ⇒ Gtk::Widget

  The widget receiving the GdkEvents that the controller will handle.

• #widget=(widget) ⇒ Gtk::Widget

  The widget receiving the GdkEvents that the controller will handle.

Instance Method Details

#current_event ⇒ Gdk::Event

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

At other times, nil is returned.

Returns:

• (Gdk::Event) —

  the event that is currently
  handled by controller

#current_event_device ⇒ Gdk::Device

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

At other times, nil is returned.

Returns:

• (Gdk::Device) —

  device of the event is
  currently handled by controller

#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.

Returns:

• (Gdk::ModifierType) —

  modifier state of the event is currently handled by controller

#current_event_time ⇒ Integer

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

At other times, 0 is returned.

Returns:

• (Integer) —

  timestamp of the event is currently handled by controller

#name ⇒ String

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

Returns:

• (String) —

  name

#name=(name) ⇒ String

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

Parameters:

• name (String)

Returns:

• (String) —

  name

• (String) —

  name

#propagation_limit ⇒ Gtk::PropagationLimit

The limit for which events this controller will handle.

Returns:

• (Gtk::PropagationLimit) —

  propagation-limit

#propagation_limit=(propagation_limit) ⇒ Gtk::PropagationLimit

The limit for which events this controller will handle.

Parameters:

• propagation_limit (Gtk::PropagationLimit)

Returns:

• (Gtk::PropagationLimit) —

  propagation-limit

• (Gtk::PropagationLimit) —

  propagation-limit

#propagation_phase ⇒ Gtk::PropagationPhase

The propagation phase at which this controller will handle events.

Returns:

• (Gtk::PropagationPhase) —

  propagation-phase

#propagation_phase=(propagation_phase) ⇒ Gtk::PropagationPhase

The propagation phase at which this controller will handle events.

Parameters:

• propagation_phase (Gtk::PropagationPhase)

Returns:

• (Gtk::PropagationPhase) —

  propagation-phase

• (Gtk::PropagationPhase) —

  propagation-phase

#reset ⇒ nil

Resets the controller to a clean state.

Returns:

• (nil)

#static_name=(name) ⇒ nil

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

Parameters:

• name (String) —

  a name for controller, must be a static string

Returns:

• (nil)

#widget ⇒ Gtk::Widget

The widget receiving the GdkEvents that the controller will handle.

Returns:

• (Gtk::Widget) —

  widget

#widget=(widget) ⇒ Gtk::Widget

The widget receiving the GdkEvents that the controller will handle.

Parameters:

• widget (Gtk::Widget)

Returns:

• (Gtk::Widget) —

  widget

• (Gtk::Widget) —

  widget