ui · thing ·

yuiLayoutEngine

A yui layout engine record carrying items, measured, arranged, scalePercent, measuredReady, and related state.

cpumethodsource-examplethinguiyeho

Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.

external thing yuiLayoutEngine

Status: source-declared

Fields and methods (27)
list of yuiLayoutItem items
Stores items as list of yuiLayoutItem.
list of yuiMeasuredLayout measured
Stores measured as list of yuiMeasuredLayout.
list of yuiArrangedLayout arranged
Stores arranged as list of yuiArrangedLayout.
int scalePercent
Stores scale percent as int.
bool measuredReady
Stores measured ready as bool.
bool arrangedReady
Stores arranged ready as bool.
text diagnostic
Stores diagnostic as text.
yuiLayoutEngine()
Yui layout engine.
ItemIndex(text id) returns int
Item index. Complete example
AddItem(yuiLayoutItem item) returns bool
Add item. Complete example
ChildCount(text parentId) returns int
Child count. Complete example
MeasureLeaf(int index) returns yuiLayoutSize
Measure leaf. Complete example
MeasureRow(int index) returns yuiLayoutSize
Measure row. Complete example
MeasureColumn(int index) returns yuiLayoutSize
Measure column. Complete example
MeasureOverlay(int index) returns yuiLayoutSize
Measure overlay. Complete example
MeasureNode(int index) returns yuiLayoutSize
Measure node. Complete example
MeasureLayout(yuiLayoutConstraints constraints) returns bool
Measure layout. Complete example
InnerRect(int index) returns yuiLayoutRect
Inner rect. Complete example
ChildClip(int index, yuiLayoutRect inner) returns yuiLayoutRect
Child clip. Complete example
ArrangeRowChildren(int index)
Arrange row children. Complete example
ArrangeColumnChildren(int index)
Arrange column children. Complete example
ArrangeOverlayChildren(int index)
Arrange overlay children. Complete example
ArrangeLayout(yuiLayoutRect rootRect) returns bool
Arrange layout. Complete example
HitTest(yuiTree tree, int x, int y) returns text
Hit test. Complete example
ValidateAgainstTree(yuiTree tree) returns bool
Validate against tree. Complete example
RenderMeasureReport() returns text
Render measure report. Complete example
RenderArrangeReport() returns text
Render arrange report. Complete example

Use yuiLayoutEngine

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiLayoutEngine sample = yuiLayoutEngine()
Console.Log(Text.From(sample.scalePercent))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ItemIndex

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Item index.
yuiLayoutEngine instance = yuiLayoutEngine()
text argument_id = "argument id"
int result = instance.ItemIndex(argument_id)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.AddItem

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Add item.
yuiLayoutEngine instance = yuiLayoutEngine()
yuiLayoutItem argument_item = yuiLayoutItem("id", "parent Id", "kind", "example", 1, 1)
bool result = instance.AddItem(argument_item)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ChildCount

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Child count.
yuiLayoutEngine instance = yuiLayoutEngine()
text argument_parentId = "argument parent Id"
int result = instance.ChildCount(argument_parentId)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureLeaf

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure leaf.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutSize result = instance.MeasureLeaf(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureRow

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure row.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutSize result = instance.MeasureRow(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureColumn

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure column.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutSize result = instance.MeasureColumn(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureOverlay

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure overlay.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutSize result = instance.MeasureOverlay(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureNode

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure node.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutSize result = instance.MeasureNode(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.MeasureLayout

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Measure layout.
yuiLayoutEngine instance = yuiLayoutEngine()
yuiLayoutConstraints argument_constraints = yuiLayoutConstraints(1, 1, 1, 1, 1, "example")
bool result = instance.MeasureLayout(argument_constraints)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.InnerRect

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Inner rect.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutRect result = instance.InnerRect(argument_index)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ChildClip

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Child clip.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
yuiLayoutRect argument_inner = yuiLayoutRect(1, 1, 1, 1)
yuiLayoutRect result = instance.ChildClip(argument_index, argument_inner)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ArrangeRowChildren

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Arrange row children.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
instance.ArrangeRowChildren(argument_index)
Console.Log("ArrangeRowChildren completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ArrangeColumnChildren

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Arrange column children.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
instance.ArrangeColumnChildren(argument_index)
Console.Log("ArrangeColumnChildren completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ArrangeOverlayChildren

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Arrange overlay children.
yuiLayoutEngine instance = yuiLayoutEngine()
int argument_index = 1
instance.ArrangeOverlayChildren(argument_index)
Console.Log("ArrangeOverlayChildren completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ArrangeLayout

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Arrange layout.
yuiLayoutEngine instance = yuiLayoutEngine()
yuiLayoutRect argument_rootRect = yuiLayoutRect(1, 1, 1, 1)
bool result = instance.ArrangeLayout(argument_rootRect)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.HitTest

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Hit test.
yuiLayoutEngine instance = yuiLayoutEngine()
yuiTree argument_tree = yuiTree("id")
int argument_x = 1
int argument_y = 1
text result = instance.HitTest(argument_tree, argument_x, argument_y)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.ValidateAgainstTree

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Validate against tree.
yuiLayoutEngine instance = yuiLayoutEngine()
yuiTree argument_tree = yuiTree("id")
bool result = instance.ValidateAgainstTree(argument_tree)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.RenderMeasureReport

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Render measure report.
yuiLayoutEngine instance = yuiLayoutEngine()
text result = instance.RenderMeasureReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiLayoutEngine.RenderArrangeReport

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Render arrange report.
yuiLayoutEngine instance = yuiLayoutEngine()
text result = instance.RenderArrangeReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuilayoutengine"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

yeho/packages/ui/layout-engine.yh:55