package ecaml

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

Overlays modify the appearance of a buffer's text, for presentation's sake.

(Info-goto-node "(elisp)Overlays")

type t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Ecaml_value.Valueable.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 Ecaml_value.Value.Type.t
val create : ?buffer:Buffer.t -> unit -> start:Position.t -> end_:Position.t -> t

(describe-function 'make-overlay)

val buffer : t -> Buffer.t

(describe-function 'overlay-buffer)

val start : t -> Position.t

(describe-function 'overlay-start)

val end_ : t -> Position.t

(describe-function 'overlay-end)

val delete : t -> unit

(describe-function 'delete-overlay)

val move : ?buffer:Buffer.t -> t -> start:Position.t -> end_:Position.t -> t

(describe-function 'move-overlay)

val get_property : t -> 'a Text.Property_name.t -> 'a

(describe-function 'overlay-get)

val put_property : t -> 'a Text.Property_name.t -> 'a -> unit

(describe-function 'overlay-put)

val delete_property : t -> Symbol.t -> unit

Delete the property from the overlay. This actually sets the property to nil, because Emacs doesn't expose a way to actually remove the property from the list.

val at : Position.t -> t list

(describe-function 'overlays-at)

val remove_overlays : ?start:Position.t -> ?end_:Position.t -> ?with_property:('a Text.Property_name.t * 'a) -> unit -> unit

(describe-function 'remove-overlays). (Info-goto-node "(elisp)Managing Overlays")

val in_ : start:Position.t -> end_:Position.t -> t list

(describe-function 'overlays-in)

val equal : t -> t -> bool
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