View Source Renewex.Document (renewex v0.14.0)

Renewex.Document captures the concept of a full Renew document as described by the content of an *.rnw file.

Summary

Functions

%Renewex.Document{}

A Renewex.Document consists of

new(version, root, refs \\ [], size \\ nil)

Initialize a new Renewex.Document struct.

Functions

%Renewex.Document{}

(struct)

A Renewex.Document consists of:

version: The file format version (see Renewex.Grammar.latest_version/0),
root: a root node (a Renewex.Storable.__struct__/0 or a {:ref, ...} to a Renewex.Storable.__struct__/0),
refs: a list of Renewex.Storable.__struct__/0 that can reference each other via index into this list,
size: an optional tuple {x, y, width, height} (or nil) describing the window dimensions of the Renew application window when the file was saved.

new(version, root, refs \\ [], size \\ nil)

Initialize a new Renewex.Document struct.

Parameters

version: The file format version (see Renewex.Grammar.latest_version/0)
root: a root node (a Renewex.Storable.__struct__/0 or a {:ref, ...} to a Renewex.Storable.__struct__/0),
refs: a list of Renewex.Storable.__struct__/0 that can reference each other via index into this list,
size: an optional tuple {x, y, width, height} (or nil) describing the window dimensions of the Renew application window when the file was saved.