package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

(Info-goto-node "(elisp)Text Properties")

type 'a t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
type 'a property_name := 'a t
val face : Face_spec.t t

(Info-goto-node "(elisp)Special Properties")

val mouse_face : Face_spec.t t
val font_lock_face : Face_spec.t t
val display : Display_spec.t t
val after_string : text t
val before_string : text t
val invisible : Ecaml_value.Value.t t
val help_echo : string t

value automatically displayed by Emacs on mouse-over

val kbd_help : string t

value automatically displayed by Emacs when text at point has the property, if help-at-pt-display-when-idle is enabled

val name : _ t -> Symbol.t
val name_as_value : _ t -> Ecaml_value.Value.t
val to_value : 'a t -> 'a -> Ecaml_value.Value.t
val of_value_exn : 'a t -> Ecaml_value.Value.t -> 'a
module Create : sig ... end

(<:) creates a new property name and makes it available for automatic typeful conversion of elisp property lists. Idiomatic usage looks like this:

module Packed : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct