Module rat_widget::event

Event-handling traits and types.

Modules

• crossterm
• util
  Some utility functions that pop up all the time.

Macros

• ct_event
  This macro produces pattern matches for crossterm events.
• flow
  Breaks the control-flow if the block returns a value for with ConsumedEvent::is_consumed is true.
• flow_ok
  Breaks and Ok-wraps the control-flow if the block returns a value for with ConsumedEvent::is_consumed is true.

Structs

• DoubleClick
  Event-handler for double-click on the table.
• EditKeys
  Activates editing behaviour in addition to the normal table event handling.
• FocusKeys
  Default key bindings when focused. Also handles all events that are MouseOnly.
• MouseOnly
  Handler for mouse events only.
• Popup
  Runs only the event-handling for the popup-parts of a widget. These should be run before the standard FocusKey or MouseOnly event-handlers, to mitigate the front/back problem of overlaying widgets.
• ReadOnly
  Runs only the navigation events, not any editing.

Enums

• DoubleClickOutcome
  Result type for double-click event-handling.
• EditOutcome
  Result of handling EditKeys.
• Outcome
  A baseline Outcome for event-handling.
• ScrollOutcome
  Result value for event-handling. Used widgets in this crate.
• TextOutcome
  Result of event handling.

Traits

• ConsumedEvent
  When composing several widgets, the minimum information from the outcome of the inner widget is, whether it used & consumed the event.
• HandleEvent
  A very broad trait for an event handler for widgets.