Module `Ecaml.Frame`

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 Ecaml__.Import0.Value.Subtype

type value
type t = private value: 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 -> Ppx_sexp_conv_lib.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 : value -> bool

include Ecaml_value__.Valueable0.S with type t := t

type t
type 'a type_

val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
val type_ : t type_
val t : t type_

val create : unit -> t: (describe-function 'make-frame)

val num_cols : t -> int: (describe-function 'frame-width)

val num_rows : t -> int: (describe-function 'frame-height)

val pixel_height : t -> int: (describe-function 'frame-pixel-height)

val pixel_width : t -> int: (describe-function 'frame-pixel-width)

val parameters : t -> (Symbol.t * Ecaml__.Import0.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 set_selected_temporarily : (_, 'a) Sync_or_async.t -> t -> f:(unit -> 'a) -> 'a: (describe-function 'with-selected-frame)

val is_visible : t -> bool: (describe-function 'frame-visible-p)

val all_visible : unit -> t list: (describe-function 'visible-frame-list)

val all_live : unit -> t list: (describe-function 'frame-list)

module Include_minibuffer : sig ... end

val window_list : ?⁠include_minibuffer:Include_minibuffer.t -> unit -> Ecaml__.Window0.t list: (describe-function 'window-list)

val is_live : t -> bool: (describe-function 'frame-live-p)

val other_frame : int -> unit: (describe-function 'other-frame)

val terminal : t -> Terminal.t: (describe-function 'frame-terminal)

val inherited_parameters : Symbol.t list Var.t: (describe-variable 'frame-inherited-parameters)

val window_tree : t -> Ecaml__.Window0.Tree.t: (describe-function 'window-tree)