package brr

  1. Overview
  2. Docs
Browser programming toolkit for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-3-Clause License Edit opam file Versions (3)

Authors

  1. T
    The brr programmers

Maintainers

  1. Daniel Bünzli

Sources

brr-0.0.9.tbz
sha512=45cdf73c6a23c8fc4609a32ae2196d4790e5bdba34ca0b784bff9c0b70dab233eb336f1c11dc3002451042ff4cf25b643098ad0d011f14c3d6175842113bed21

doc/brr/Brr/Window/index.html

Module Brr.WindowSource

Window objects.

Some of the objects and methods that are accessed from Window objects are in other modules:

The type for Window objects. See G.window for the global window object.

Sourceval as_target : t -> Ev.target

as_target w is the window as an event target.

Sourceval closed : t -> bool

closed w is true if w is closed.

Sourceval scroll_x : t -> float

scroll_x w is the number of (sub)pixels the window is horizontally scrolled by.

Sourceval scroll_y : t -> float

scroll_y w is the number of (sub)pixels the window is vertically scrolled by.

Sourceval inner_width : t -> int

inner_width w is the interior width of the window in CSS pixels, including the width of the vertical scroll bar, if present.

Sourceval inner_height : t -> int

inner_height w is the interior height of the window in CSS pixels, including the height of the horizontal scroll bar, if present.

Sourceval parent : t -> t option

parent w is the parent of the window, if it has one.

When a window is loaded in an <iframe>, <object>, or <frame>, its parent is the window with the element embedding the window.

Media properties

Sourceval device_pixel_ratio : t -> float

device_pixel_ratio w is the ratio between physical and CSS pixels. A value of 2. indicates that two physical pixels are used to draw a single CSS pixel.

Sourceval matches_media : t -> Jstr.t -> bool

matches_media w mq is true if the media query mq matches. See Window.matchMedia.

Sourceval prefers_dark_color_scheme : t -> bool

prefers_dark_scheme w is true if the "(prefers-color-scheme: dark)" media query matches.

Operations

Sourceval open' : ?features:Jstr.t -> ?name:Jstr.t -> t -> Jstr.t -> t option

open' w url ~name ~features loads the specified resource url into a new or existing browsing context with the specified name and window features. None is returned if the window could not be opened.

Sourceval close : t -> unit

close w closes window w.

Sourceval print : t -> unit

print w opens the print dialog to print the window document.

Sourceval reload : t -> unit

reload w reloads w (on its location property).

Location and history

Sourceval location : t -> Uri.t

location w is the window's location.

Note we do not bind the Location object, everything you need can be done with Uri, set_location, reload and possibly History.

Sourceval set_location : t -> Uri.t -> unit

set_location w l sets the window location to l.

Sourcemodule History : sig ... end

Browser history.

Sourceval history : t -> History.t

history w is the history of w.