package mosaic

  1. Overview
  2. Docs
Terminal UI framework for OCaml with The Elm Architecture

Install

dune-project
 Dependency

Authors

Maintainers

Sources

mosaic-0.1.0.tbz
sha256=9e4e90d17f9b2af1b07071fe425bc2c519c849c4f1d1ab73cde512be2d874849
sha512=06e9c4a741590942e81a27738d0b5c0413fafec8cf3b7dae047ad69f155e7b718aa4223818dc161b7d028efffcfd3365905e264d6fd31d453910ddfa91dcf9b9

doc/mosaic.ui/Mosaic_ui/Event/Key/index.html

Module Event.KeySource

Sourcetype t

The type for keyboard events.

Wraps an Input.Key.event with propagation and default-prevention flags that the renderer inspects during two-tier dispatch (global handlers first, then focused-node handlers).

Sourceval of_input : Input.Key.event -> t

of_input ev is a keyboard event wrapping ev. Propagation and default-prevention flags start as false.

Sourceval data : t -> Input.Key.event

data t is the underlying terminal key event.

Sourceval stop_propagation : t -> unit

stop_propagation t prevents t from reaching the focused-node handler tier. When called in a global handler, the event is not dispatched to focused-node handlers.

Sourceval propagation_stopped : t -> bool

propagation_stopped t is true iff stop_propagation has been called on t.

Sourceval prevent_default : t -> unit

prevent_default t marks renderer-level default behaviour as prevented. After all handlers run, the renderer skips its default key behaviour for the focused node.

Sourceval default_prevented : t -> bool

default_prevented t is true iff prevent_default has been called on t.

Sourceval equal : t -> t -> bool

equal a b is true iff a and b wrap the same key event. Dispatch control state is ignored.

Sourceval pp : Format.formatter -> t -> unit

pp formats a keyboard event for debugging.