ui · thing ·

yuiCommandMap

A yui command map record carrying bindings, diagnostic.

cpumethodsource-examplethinguiyeho

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

external thing yuiCommandMap

Status: source-declared

Fields and methods (8)
list of yuiCommandBinding bindings
Stores bindings as list of yuiCommandBinding.
text diagnostic
Stores diagnostic as text.
yuiCommandMap()
Yui command map.
BindingIndex(text id) returns int
Binding index. Complete example
AddBinding(yuiCommandBinding binding) returns bool
Add binding. Complete example
SetEnabled(text bindingId, bool enabled) returns bool
Set enabled. Complete example
Resolve(yuiTree tree, text focusedNodeId, text chord) returns yuiCommandResolution
Resolve. Complete example
RenderCommandMapReport() returns text
Render command map report. Complete example

Use yuiCommandMap

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.
yuiCommandMap sample = yuiCommandMap()
Console.Log(Text.From(sample.diagnostic))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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"

yuiCommandMap.BindingIndex

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

// Binding index.
yuiCommandMap instance = yuiCommandMap()
text argument_id = "argument id"
int result = instance.BindingIndex(argument_id)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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"

yuiCommandMap.AddBinding

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 binding.
yuiCommandMap instance = yuiCommandMap()
yuiCommandBinding argument_binding = yuiCommandBinding("id", "scope Root Id", "chord", "command", "example")
bool result = instance.AddBinding(argument_binding)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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"

yuiCommandMap.SetEnabled

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 enabled.
yuiCommandMap instance = yuiCommandMap()
text argument_bindingId = "argument binding Id"
bool argument_enabled = true
bool result = instance.SetEnabled(argument_bindingId, argument_enabled)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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"

yuiCommandMap.Resolve

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

// Resolve.
yuiCommandMap instance = yuiCommandMap()
yuiTree argument_tree = yuiTree("id")
text argument_focusedNodeId = "argument focused Node Id"
text argument_chord = "argument chord"
yuiCommandResolution result = instance.Resolve(argument_tree, argument_focusedNodeId, argument_chord)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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"

yuiCommandMap.RenderCommandMapReport

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 command map report.
yuiCommandMap instance = yuiCommandMap()
text result = instance.RenderCommandMapReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuicommandmap"
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/interaction-commands.yh:61