package ecaml

  1. Overview
  2. Docs

Module Ecaml.Input_eventSource

(Info-goto-node "(elisp)Input Events")

include Ecaml_value.Value.Subtype with type t = Ecaml_value.Value.t

We expose private value for free identity conversions when the value is nested in some covariant type, e.g. (symbols : Symbol.t list :> Value.t list) rather than List.map symbols ~f:Symbol.to_value.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval eq : t -> t -> bool

eq t1 t2 = Value.eq (to_value t1) (to_value t2), i.e. eq checks whether the Emacs values underlying t1 and t2 are physically equal. This is different than phys_equal t1 t2, because we don't always wrap eq Emacs values in phys_equal OCaml values. I.e. phys_equal t1 t2 implies eq t1 t2, but not the converse.

Sourceval is_in_subtype : Ecaml_value.Value.t -> bool
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Ecaml_value.Value.Type.t
Sourceval description : t -> string

(describe-function 'single-key-description) (Info-goto-node "(elisp)Describing Characters")

Sourceval create_exn : string -> t

create_exn string is a specialized version of Key_sequence.create that raises unless string denotes a key sequence of length one.

(describe-function 'kbd) (Info-goto-node "(elisp)Key Sequences")

Here are some example inputs:

"C-c" "C-M-q" "<f5>" "C-<f5>" "C-<right>" "<mouse-2>" "C-<down-mouse-3>"

Sourceval read : unit -> t

(describe-function 'read-event) (Info-goto-node "(elisp)Reading One Event")

Sourcemodule Basic : sig ... end
Sourceval basic : t -> Basic.t

(describe-function 'event-basic-type) (Info-goto-node "(elisp)Classifying Events")

Sourcemodule Modifier : sig ... end
Sourceval modifiers : t -> Modifier.t list

(describe-function 'event-modifiers) (Info-goto-node "(elisp)Classifying Events")

Sourceval unread_command_input : t list Var.t

(describe-variable 'unread-command-events) (Info-goto-node "(elisp)Event Input Misc")

Sourceval enqueue_unread_command_input : t list -> unit
Sourceval recent_keys : unit -> t array

(describe-function 'recent-keys) (Info-goto-node "(elisp)Recording Input")

Sourcemodule Command_or_key : sig ... end
Sourceval recent_commands_and_keys : unit -> Command_or_key.t array

(describe-function 'recent-keys) (Info-goto-node "(elisp)Recording Input")