package ecaml

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

A "face" is a collection of graphical attributes for displaying text: font family, foreground color, background color, optional underlining, and so on. Faces control how buffer text is displayed, and how some parts of the frame, such as the mode-line, are displayed.

For most purposes, you refer to a face in Lisp programs using its "face name". Each face name is meaningful for all frames, and by default it has the same meaning in all frames. But you can arrange to give a particular face name a special meaning in one frame if you wish.

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

module Frame : sig ... end
include Ecaml_value.Value.Subtype
type t = private Ecaml_value.Value.t

We 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.t
val eq : t -> t -> bool

eq 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 -> bool
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
include Core.Equal.S with type t := t
val equal : t Base__Equal.equal
val default : t
val of_name : string -> t
val to_name : t -> string
module Background : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Box : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Extend : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Font : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Font_family : sig ... end

Font family name or fontset name; the wild-card characters `*' and `?' are allowed. (Info-goto-node "(elisp)Face Attributes").

module Font_foundry : sig ... end

The name of the "font foundry" in which the font family attribute is located; the wild-card characters `*' and `?' are allowed. (Info-goto-node "(elisp)Face Attributes")

module Foreground : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Height : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Inherit : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Inverse_video : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Overline : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Slant : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Stipple : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Strike_through : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Underline : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Weight : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Width : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Attribute : sig ... end

(Info-goto-node "(elisp)Face Attributes")

module Attribute_and_value : sig ... end
val all_defined : unit -> t list

(describe-function 'face-list)

val font_family_list : ?on:Frame.t -> unit -> string list

(describe-function 'face-attribute)

val attribute_value : ?on:Frame.t -> t -> 'a Attribute.t -> 'a

(describe-function 'face-attribute)

val set_attribute : ?on:Frame.t -> t -> 'a Attribute.t -> 'a -> unit

(describe-function 'set-face-attribute)

val attributes : ?on:Frame.t -> t -> Attribute_and_value.t list

(describe-function 'face-all-attributes)

val spec_set : t -> Attribute_and_value.t list -> unit

(describe-function 'face-spec-set)

val defface : string -> Core.Source_code_position.t -> docstring:string -> customization_group:Customization.Group.t -> Attribute_and_value.t list -> t

(describe-function 'defface)

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