package ecaml

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

Module Ecaml.OverlaySource

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

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

Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Ecaml_value.Valueable.S with type t := t
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Ecaml_value.Value.Type.t
Sourceval create : ?buffer:Buffer.t -> unit -> start:Position.t -> end_:Position.t -> t

(describe-function 'make-overlay)

Sourceval buffer : t -> Buffer.t

(describe-function 'overlay-buffer)

Sourceval start : t -> Position.t

(describe-function 'overlay-start)

Sourceval end_ : t -> Position.t

(describe-function 'overlay-end)

Sourceval delete : t -> unit

(describe-function 'delete-overlay)

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

(describe-function 'move-overlay)

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

(describe-function 'overlay-get)

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

(describe-function 'overlay-put)

Sourceval 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.

Sourceval at : Position.t -> t list

(describe-function 'overlays-at)

Sourceval 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")

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

(describe-function 'overlays-in)

Sourceval 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