Module Ecaml__.Key_sequence

A key sequence is a sequence of one or more input events that form a unit. Input events include characters, function keys, and mouse actions.

(Info-goto-node "(elisp)Key Sequences")

include Ecaml.Value.Subtype
type value
type 'a type_
type t = private value

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.

include sig ... end
val sexp_of_t : t ‑> Sexplib.Sexp.t
val of_value_exn : value ‑> t
val to_value : t ‑> value
val 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.

val type_ : t type_
val length : t ‑> int
val get : t ‑> int ‑> Ecaml.Input_event.t
val to_list : t ‑> Ecaml.Input_event.t list

(describe-function 'listify-key-sequence)(Info-goto-node "(elisp)Event Input Misc")

val create_exn : string ‑> t
val execute : t ‑> unit

(describe-function 'execute-kbd-macro)(Info-goto-node "(elisp)Keyboard Macros")

val read : unit ‑> prompt:string ‑> t

(describe-function 'read-key-sequence-vector)(Info-goto-node "(elisp)Key Sequence Input")

val enqueue_unread_command_input : t ‑> unit

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