The library documents itself · GUI & reactive
stzUiDocument
27 own methods · 1 forms written with extensions, listed under their method
the source: base/gui/stzUiDocument.ring(opens in a new tab) · All classes · The area reference: GUI & reactive
Under each method, its extensions (Q CS XT Z ZZ IB W U): bold and ticked, it exists; struck, it does not. The extensions and what they mean
No method of this class is run on this page: the class reaches files, the network, processes, the clock, chance or sound, and an example run here would only be an example of its effects. Each method carries the explanation the library gives of itself.
Method
Explanation, as the source carries it
init
(no comment in the source: the name reads as a sentence) initno extension
Diagnostics
the verdictno extension
Errors
(no comment in the source: the name reads as a sentence) errorsno extension
IsClean
(no comment in the source: the name reads as a sentence) is cleanno extension
Report
One line per finding, for a human at a terminal.no extension
Declarations
inspectionno extension
DeclOf
(no comment in the source: the name reads as a sentence) decl ofno extension
PanelDecl
(no comment in the source: the name reads as a sentence) panel declno extension
Names
(no comment in the source: the name reads as a sentence) namesno extension
TextsToPaint
[ [ id, content, size, color, isRtl ], ... ] for every TEXT -- the G1 bridge: the font engine is a stub until G2, so a caller paints the glyphs itself at BoxOf(id) with the graphics plane's own pipeline. This method disappears into the emitter when G2 lands.no extension
ToText
the canonical print (round-trip fixpoint)no extension
ToRml
the projection ------------------------------------------------------ The RML this document means. The defaults here are §4b's table: every divergence G1 found is absorbed so the author never sees it.no extension
ToHtml
THIS SHARES EVERY RULE WITH ToRml. The two projections differ only where stzUiProfile records a DIVERGENCE, and they ask the profile for the spelling rather than carrying their own copy -- which is the whole reason the profile had to become data. If the shared half ever forks, the fixture below is what says so.no extension
ToFixture
paNativeBoxes is [ [ name, x, y, w, h ], ... ] from the laid-out panel -- BoxOf() for every named element.no extension
IsStrictWidth
Is this element's geometry DECLARED, rather than measured from its text? Only a declared one is a strict observable -- see StzUiProfileIsStrictBox.no extension
IsStrictHeight
(no comment in the source: the name reads as a sentence) is strict heightno extension
IsStrictlyPlaced
A box sits where its predecessors left it, so its POSITION is only claimed when it and every earlier sibling fix their own size.no extension
DirectionOf
The direction in force for a declaration -- its own, or the nearest ancestor's. Answers "ltr" for anything the panel does not reach.no extension
IsRtl
(no comment in the source: the name reads as a sentence) is rtlno extension
UseFont
to a living panel --------------------------------------------------- Bind the family a document's FONT field names to real bytes. Called before ToPanel so the layout is measured with the glyphs it will be painted with -- which is G2's whole point.QCSXTZZZIBWU
FontFamily
(no comment in the source: the name reads as a sentence) font familyno extension
ToPanel
(no comment in the source: the name reads as a sentence) to panelno extension
Roles
The closed role vocabulary, for a caller that wants to offer it.no extension
IntentsOf
AND NO WARNING ON AN ORPHAN. Every existing document would raise on every element, which is noise rather than a trail, and the finding did not ask for one. `Orphans()` answers the question instead, so the inversion's test is available the moment anyone wants it. The intents one declaration claims to satisfy, [] when it claims none.no extension
SatisfiedIntents
Every intent named anywhere in the document, in first-seen order. What a later binding phase reads to know what to look for.no extension
Orphans
The ELEMENTS that trace to no intent -- the founding inversion's own test, answerable now and without resolving anything. STYLE declarations are absent by construction, not by omission.no extension
TracesToIntent
(no comment in the source: the name reads as a sentence) traces to intentno extension