Crate rat_event

Rat-Event

This crate defines a general event-handling trait, that can be used to create ratatui widgets.

The main idea here is not to try to unify the different event sources.

Instead, provide a trait that can be implemented once per event-type. And as there seem to be widely diverging opinions on what the right key-bindings should be, we add a marker type to allow for more than one key-binding.

If the widget is designed in a way, that each key binding only needs to call a function or two, the code duplication is negligible.

This accomplishes:

• Widget author can support different event types.
• Widget author can supply several key bindings.
• Application author can define ves own key bindings, and as the widget is designed this way it’s possible to do this.
• As there is a trait for this, widgets can be composed generically.

For examples see rat-input

Modules

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

Macros

• ct_event
  This macro produces pattern matches for crossterm events.

Structs

• FocusKeys
  Default key bindings when focused. Also handles all events that are MouseOnly.
• MouseOnly
  Handler for mouse events only.

Traits

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