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 Value.Subtypetype t = private Value.tWe 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.
val sexp_of_t : t -> Ppx_sexp_conv_lib.Sexp.teq 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 of_value_exn : Ecaml__.Value0.t -> tval to_value : t -> Ecaml__.Value0.tval type_ : t Value.Type.tval length : t -> intval get : t -> int -> Input_event.tval 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(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")