package ecaml

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

A "frame" is a screen object that contains one or more Emacs windows. It is the kind of object called a "window" in the terminology of graphical environments; but we can't call it a "window" here, because Emacs uses that word in a different way.

(Info-goto-node "(elisp)Frames").

include Value.Subtype
type t = private 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.

include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
val of_value_exn : Value.t -> t
val to_value : t -> Value.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 type_ : t Value.Type.t
val num_cols : t -> int

Accessors

(describe-function 'frame-width)

val num_rows : t -> int

(describe-function 'frame-width)

(describe-function 'frame-height)

val pixel_height : t -> int

(describe-function 'frame-height)

(describe-function 'frame-pixel-height)

val pixel_width : t -> int

(describe-function 'frame-pixel-height)

(describe-function 'frame-pixel-width)

val parameters : t -> (Symbol.t * Value.t) list

(describe-function 'frame-parameters)

val selected : unit -> t

(describe-function 'selected-frame)

val set_selected : t -> unit

(describe-function 'select-frame)

val all_visible : unit -> t list

(describe-function 'visible-frame-list)

val all_live : unit -> t list

(describe-function 'frame-list)