package ecaml
Module Ecaml.Keymap
The command bindings of input events are recorded in data structures called keymaps. Each entry in a keymap associates (or "binds") an individual event type, either to another keymap or to a command. When an event type is bound to a keymap, that keymap is used to look up the next input event; this continues until a command is found. The whole process is called "key lookup".
(Info-goto-node "(elisp)Keymaps")
include Ecaml_value.Value.Subtype
type t = private Ecaml_value.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 -> Sexplib0.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 is_in_subtype : Ecaml_value.Value.t -> boolval of_value_exn : Ecaml_value__.Value0.t -> tval to_value : t -> Ecaml_value__.Value0.tval type_ : t Ecaml_value.Value.Type.tval t : t Ecaml_value.Value.Type.ttype keymap := tinclude Core.Equal.S with type t := t
val equal : t Core.Equal.equal(describe-function 'keymap-parent) (Info-goto-node "(elisp)Inheritance and Keymaps")
(describe-function 'set-keymap-parent) (Info-goto-node "(elisp)Inheritance and Keymaps")
module Kind : sig ... end(describe-function 'make-sparse-keymap) (describe-function 'make-keymap) (Info-goto-node "(elisp) Creating Keymaps")
val global : unit -> t(describe-function 'current-global-map) (Info-goto-node "(elisp)Controlling Active Maps")
val set_global : t -> unit(describe-function 'use-global-map) (Info-goto-node "(elisp)Controlling Active Maps")
val set_transient : ?keep_if_used:bool -> t -> unit(describe-function 'set-transient-map)
module Entry : sig ... endval lookup_key :
?accept_defaults:bool ->
t ->
Key_sequence.t ->
Entry.t Core.Or_error.t(describe-function 'lookup-key) (Info-goto-node "(elisp)Functions for Key Lookup")
val define_key : t -> Key_sequence.t -> Entry.t -> unit(describe-function 'define-key) (Info-goto-node "(elisp)Functions for Key Lookup")
override_minor_mode_map minor_mode ~f overrides the bindings for minor_mode in the current buffer with the result of calling f on the keymap for minor_mode.
If no such map exists, an empty sparse map is created.
(describe-variable 'minor-mode-map-alist) (describe-variable 'minor-mode-overriding-map-alist) (Info-goto-node "(elisp)Controlling Active Maps")
val suppress_keymap : ?suppress_digits:bool -> t -> unit(describe-function 'suppress-keymap)