package ecaml

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

Module Ecaml.WindowSource

A "window" in Emacs is the physical area of the screen in which a buffer is displayed.

Each window has its own value of point, independent of the value of point in other windows displaying the same buffer. This makes it useful to have multiple windows showing one buffer.

A window is "live" as long as it displays a buffer. All functions other than is_live raise if supplied a t such that not (is_live t).

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

include Core.Equal.S with type t := t
include Ecaml_value.Value.Subtype with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval 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.

Sourceval is_in_subtype : Ecaml_value.Value.t -> bool
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 is_live : t -> bool

(describe-function 'window-live-p).

Accessors

Sourceval body_height_exn : t -> int

(describe-function 'window-body-height)

Sourceval buffer : t -> Buffer.t option

(describe-function 'window-buffer)

Sourceval buffer_exn : t -> Buffer.t

(describe-function 'window-buffer)

Sourceval get_buffer_window : Buffer.t -> t option

(describe-function 'get-buffer-window)

Sourceval height_exn : t -> int

(describe-function 'window-height)

Sourceval point_exn : t -> Position.t

(describe-function 'window-point)

Sourceval width_exn : t -> int

(describe-function 'window-width)

Sourceval set_buffer_exn : ?keep_margins:bool -> t -> Buffer.t -> unit Async_kernel.Deferred.t

(describe-function 'set-window-buffer)

Sourceval set_point_exn : t -> Position.t -> unit

(describe-function 'set-window-point)

Sourceval set_window_margins : ?left_margin:int -> ?right_margin:int -> t -> unit

(Info-goto-node "(elisp)Display Margins") (describe-function 'set-window-margins)

Sourceval delete_exn : t -> unit

(describe-function 'delete-window)

Sourceval delete_other_windows : t option -> unit

(describe-function 'delete-other-windows)

Sourceval start : t -> Position.t

(describe-function 'window-start)

Sourceval set_start : t -> Position.t -> unit

(describe-function 'set-window-start)

Sourceval end_ : ?update:bool -> t -> Position.t

(describe-function 'window-end)

Sourceval frame : t -> Frame.t

(describe-function 'window-frame)

Sourceval fit_to_buffer : ?max_columns:int -> ?max_lines:int -> ?min_columns:int -> ?min_lines:int -> ?preserve_size:bool -> t -> unit

(describe-function 'fit-window-to-buffer)

Sourcemodule Tree : sig ... end

(Info-goto-node "(elisp) Windows and Frames")

Sourcemodule Blocking : sig ... end
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