ui · thing ·

yuiScrollState

A yui scroll state record carrying contentWidth, contentHeight, viewportWidth, viewportHeight, offsetX, and related state.

cpumethodsource-examplethinguiyeho

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

external thing yuiScrollState

Status: source-declared

Fields and methods (25)
int contentWidth
Stores content width as int.
int contentHeight
Stores content height as int.
int viewportWidth
Stores viewport width as int.
int viewportHeight
Stores viewport height as int.
int offsetX
Stores offset x as int.
int offsetY
Stores offset y as int.
int lineStep
Stores line step as int.
int pageOverlap
Stores page overlap as int.
text source
Stores source as text.
text diagnostic
Stores diagnostic as text.
yuiScrollState(int lineStep, int pageOverlap, text source)
Yui scroll state.
MaximumOffsetX() returns int
Maximum offset x. Complete example
MaximumOffsetY() returns int
Maximum offset y. Complete example
ValidationIssue() returns text
Validation issue. Complete example
ClampOffsets()
Clamp offsets. Complete example
SetGeometry(int contentWidth, int contentHeight, int viewportWidth, int viewportHeight) returns bool
Set geometry. Complete example
ScrollBy(int deltaX, int deltaY) returns bool
Scroll by. Complete example
ScrollWheel(int wheelX, int wheelY) returns bool
Scroll wheel. Complete example
PageStepX() returns int
Page step x. Complete example
PageStepY() returns int
Page step y. Complete example
HandleKey(text key) returns bool
Handle key. Complete example
BringIntoView(yuiLayoutRect contentRect) returns bool
Bring into view. Complete example
VisibleContentRect() returns yuiLayoutRect
Visible content rect. Complete example
BarGeometry(text axis, int trackStart, int trackLength, int minimumThumbLength) returns yuiScrollBarGeometry
Bar geometry. Complete example
RenderReport() returns text
Render report. Complete example

Use yuiScrollState

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.
yuiScrollState sample = yuiScrollState(1, 1, "example")
Console.Log(Text.From(sample.contentWidth))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.MaximumOffsetX

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

// Maximum offset x.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int result = instance.MaximumOffsetX()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.MaximumOffsetY

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

// Maximum offset y.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int result = instance.MaximumOffsetY()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.ValidationIssue

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

// Validation issue.
yuiScrollState instance = yuiScrollState(1, 1, "example")
text result = instance.ValidationIssue()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.ClampOffsets

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

// Clamp offsets.
yuiScrollState instance = yuiScrollState(1, 1, "example")
instance.ClampOffsets()
Console.Log("ClampOffsets completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.SetGeometry

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

// Set geometry.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int argument_contentWidth = 1
int argument_contentHeight = 1
int argument_viewportWidth = 1
int argument_viewportHeight = 1
bool result = instance.SetGeometry(argument_contentWidth, argument_contentHeight, argument_viewportWidth, argument_viewportHeight)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.ScrollBy

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

// Scroll by.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int argument_deltaX = 1
int argument_deltaY = 1
bool result = instance.ScrollBy(argument_deltaX, argument_deltaY)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.ScrollWheel

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

// Scroll wheel.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int argument_wheelX = 1
int argument_wheelY = 1
bool result = instance.ScrollWheel(argument_wheelX, argument_wheelY)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.PageStepX

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

// Page step x.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int result = instance.PageStepX()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.PageStepY

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

// Page step y.
yuiScrollState instance = yuiScrollState(1, 1, "example")
int result = instance.PageStepY()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.HandleKey

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

// Handle key.
yuiScrollState instance = yuiScrollState(1, 1, "example")
text argument_key = "argument key"
bool result = instance.HandleKey(argument_key)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.BringIntoView

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

// Bring into view.
yuiScrollState instance = yuiScrollState(1, 1, "example")
yuiLayoutRect argument_contentRect = yuiLayoutRect(1, 1, 1, 1)
bool result = instance.BringIntoView(argument_contentRect)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.VisibleContentRect

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

// Visible content rect.
yuiScrollState instance = yuiScrollState(1, 1, "example")
yuiLayoutRect result = instance.VisibleContentRect()
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.BarGeometry

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

// Bar geometry.
yuiScrollState instance = yuiScrollState(1, 1, "example")
text argument_axis = "argument axis"
int argument_trackStart = 1
int argument_trackLength = 1
int argument_minimumThumbLength = 1
yuiScrollBarGeometry result = instance.BarGeometry(argument_axis, argument_trackStart, argument_trackLength, argument_minimumThumbLength)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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"

yuiScrollState.RenderReport

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 report.
yuiScrollState instance = yuiScrollState(1, 1, "example")
text result = instance.RenderReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiscrollstate"
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-scroll.yh:30