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__.Import.Value.Subtype
type value
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 thanList.map symbols ~f:Symbol.to_value
.
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.t
val eq : t -> t -> bool
eq t1 t2 = Value.eq (to_value t1) (to_value t2)
, i.e.eq
checks whether the Emacs values underlyingt1
andt2
are physically equal. This is different thanphys_equal t1 t2
, because we don't always wrapeq
Emacs values inphys_equal
OCaml values. I.e.phys_equal t1 t2
implieseq t1 t2
, but not the converse.
val is_in_subtype : value -> bool
include Ecaml_value__.Valueable0.S with type t := t
val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
val type_ : t type_
val t : t type_
val length : t -> int
val get : t -> int -> Input_event.t
val to_list : t -> Input_event.t list
(describe-function 'listify-key-sequence)
(Info-goto-node "(elisp)Event Input Misc")
val create_exn : string -> t
(describe-function 'read-kbd-macro)
(Info-goto-node "(elisp)Key Sequences")
(Info-goto-node "(elisp)Decribing Characters")
Here are some example inputs:
"C-c y" "C-M-q" "<f5>" "C-<f5>" "C-<right>" "<mouse-2>" "C-<down-mouse-3>"
val execute : t -> unit Async_kernel.Deferred.t
(describe-function 'execute-kbd-macro)
(Info-goto-node "(elisp)Keyboard Macros")
val am_executing : bool Var.t
(describe-variable 'executing-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")