ui

package
v0.0.0-...-143e6d5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 24, 2026 License: GPL-3.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	ValueString = uiparse.ValueString
	ValueInt    = uiparse.ValueInt
	ValueFloat  = uiparse.ValueFloat
	ValueBool   = uiparse.ValueBool
	ValueIdent  = uiparse.ValueIdent
)

Variables

This section is empty.

Functions

This section is empty.

Types

type App 

type App struct {
	// contains filtered or unexported fields
}

App is the base struct for UI applications. Embed this in your app struct and implement handler methods that get bound to UI signals.

Usage: 

type MyApp struct {
    ui.App
}

func (a *MyApp) HandleClick() { ... }

func main() {
    app := &MyApp{}
    app.LoadFile("ui/demo.ui")
    app.Run()
}

func (*App) AddFocusable 

func (a *App) AddFocusable(widgets ...graphics.Widget)

AddFocusable registers focusable widgets.

func (*App) CloseMenu 

func (a *App) CloseMenu()

CloseMenu closes the currently open popup menu, if any.

func (*App) Configure 

func (a *App) Configure(fn func(*gapp.App))

Configure registers a callback invoked after app construction and before Run.

func (*App) FindElement 

func (a *App) FindElement(id string) *Element

FindElement searches the element tree by id.

func (*App) Focus 

func (a *App) Focus(widget graphics.Widget)

Focus sets initial or current focus.

func (*App) InternalApp 

func (a *App) InternalApp() *gapp.App

InternalApp returns the underlying app.App for advanced use.

func (*App) LoadFile 

func (a *App) LoadFile(path string, handler interface{}) error

LoadFile loads a .ui file and builds the element tree. The receiver (typically the embedding struct) is used as the signal handler.

func (*App) LoadString 

func (a *App) LoadString(source string, handler interface{}) error

LoadString loads UI from a string source.

func (*App) OpenMenu 

func (a *App) OpenMenu(menuID string, x, y int) bool

OpenMenu opens a popup menu at window-local coordinates (x, y) using the menu definition found by menuID in the current UI tree.

func (*App) Quit 

func (a *App) Quit()

Quit stops the application.

func (*App) Redraw 

func (a *App) Redraw()

Redraw forces a full screen redraw.

func (*App) RegisterClientShortcut 

func (a *App) RegisterClientShortcut(shortcutID, windowID uint32, key graphics.Key, ch rune, modifiers graphics.Modifiers, handler func(graphics.Event)) error

RegisterClientShortcut registers a shortcut scoped to this client. Pass windowID=0 to match any window from this client.

func (*App) RegisterGlobalShortcut 

func (a *App) RegisterGlobalShortcut(shortcutID uint32, key graphics.Key, ch rune, modifiers graphics.Modifiers, handler func(graphics.Event)) error

RegisterGlobalShortcut registers a global shortcut callback.

func (*App) RegisterShortcut 

func (a *App) RegisterShortcut(shortcutID, windowID, scope uint32, key graphics.Key, ch rune, modifiers graphics.Modifiers, handler func(graphics.Event)) error

RegisterShortcut registers a compositor shortcut callback. For rune-based shortcuts use key=graphics.KeyNone and set ch.

func (*App) RequestFrame 

func (a *App) RequestFrame()

RequestFrame schedules a render pass using incremental damage when possible.

func (*App) Root 

func (a *App) Root() *Element

Root returns the root element.

func (*App) Run 

func (a *App) Run() error

Run starts the application main loop.

func (*App) SetOptions 

func (a *App) SetOptions(opts gapp.Options)

SetOptions sets app.App options used when Run starts the app.

func (*App) UnregisterShortcut 

func (a *App) UnregisterShortcut(shortcutID uint32) error

UnregisterShortcut removes a previously registered shortcut callback.

type BuildError 

type BuildError = uiparse.BuildError

type ComponentDef 

type ComponentDef = uiparse.ComponentDef

type ComponentRegistry 

type ComponentRegistry struct {
	// contains filtered or unexported fields
}

ComponentRegistry holds parsed component definitions keyed by name.

func NewComponentRegistry 

func NewComponentRegistry() *ComponentRegistry

NewComponentRegistry creates an empty registry.

func (*ComponentRegistry) BuildElement 

func (r *ComponentRegistry) BuildElement(node *Node, handler interface{}) (*Element, error)

BuildElement builds an Element from an AST node, resolving components.

func (*ComponentRegistry) Has 

func (r *ComponentRegistry) Has(name string) bool

Has returns true if the registry has a component with the given name.

func (*ComponentRegistry) Instantiate 

func (r *ComponentRegistry) Instantiate(name string, node *Node, handler interface{}) (*Element, error)

Instantiate creates an Element from a component definition and an AST node. The node provides instance-specific property overrides and children.

func (*ComponentRegistry) Lookup 

func (r *ComponentRegistry) Lookup(name string) *ComponentDef

Lookup returns a component definition by name, or nil.

func (*ComponentRegistry) Register 

func (r *ComponentRegistry) Register(def *ComponentDef)

Register adds a component definition.

type Document 

type Document = uiparse.Document

func Parse 

func Parse(source string) (*Document, error)

type Element 

type Element struct {
	// contains filtered or unexported fields
}

Element is the universal DOM-like node. Every UI element is an Element. It implements graphics.Widget and renders entirely from attributes. Based on its attributes, it can behave as any widget: button, text input, checkbox, slider, container, etc.

func CollectFocusable 

func CollectFocusable(root *Element) []*Element

CollectFocusable collects all elements with focusable=true.

func FindElement 

func FindElement(root *Element, id string) *Element

FindElement searches the tree for an element by id.

func NewElement 

func NewElement(tag string) *Element

NewElement creates a new Element with the given tag.

func (*Element) AddChild 

func (e *Element) AddChild(child *Element)

AddChild adds a child element.

func (*Element) Attr 

func (e *Element) Attr(name, def string) string

Attr returns the string attribute or default.

func (*Element) AttrBool 

func (e *Element) AttrBool(name string, def bool) bool

AttrBool returns a boolean attribute or default.

func (*Element) AttrColor 

func (e *Element) AttrColor(name string, def graphics.Color) graphics.Color

AttrColor returns a color attribute or default.

func (*Element) AttrFloat 

func (e *Element) AttrFloat(name string, def float64) float64

AttrFloat returns a float attribute or default.

func (*Element) AttrInt 

func (e *Element) AttrInt(name string, def int) int

AttrInt returns an integer attribute or default.

func (*Element) BindSignal 

func (e *Element) BindSignal(name string, fn interface{}) bool

BindSignal binds a runtime signal handler (for example "clicked").

func (*Element) Bounds 

func (e *Element) Bounds() graphics.Rect

func (*Element) ChildElements 

func (e *Element) ChildElements() []*Element

ChildElements returns child elements.

func (*Element) Children 

func (e *Element) Children() []graphics.Widget

Children returns child widgets (for app.App damage tracking).

func (*Element) ClearChildren 

func (e *Element) ClearChildren()

ClearChildren removes all child elements.

func (*Element) DirtyRects 

func (e *Element) DirtyRects() []graphics.Rect

DirtyRects returns optional subregions that should be redrawn for this widget. Nil means repaint the full widget bounds.

func (*Element) Draw 

func (e *Element) Draw(buf *graphics.Buffer)

func (*Element) EmitSignal 

func (e *Element) EmitSignal(name string, args ...interface{})

EmitSignal emits a signal by name with optional args.

func (*Element) FindChild 

func (e *Element) FindChild(id string) *Element

FindChild finds a descendant by id (depth-first).

func (*Element) GetAttribute 

func (e *Element) GetAttribute(name string) string

GetAttribute returns an attribute value.

func (*Element) HandleEvent 

func (e *Element) HandleEvent(ev graphics.Event) bool

func (*Element) ID 

func (e *Element) ID() string

ID returns the element's id.

func (*Element) IsDirty 

func (e *Element) IsDirty() bool

func (*Element) IsFocused 

func (e *Element) IsFocused() bool

func (*Element) IsVisible 

func (e *Element) IsVisible() bool

func (*Element) MarkClean 

func (e *Element) MarkClean()

func (*Element) MarkDirty 

func (e *Element) MarkDirty()

func (*Element) MinSize 

func (e *Element) MinSize() graphics.Point

func (*Element) ScrollTextAreaToBottom 

func (e *Element) ScrollTextAreaToBottom()

ScrollTextAreaToBottom moves the multiline viewport to the newest lines.

func (*Element) SelfDirty 

func (e *Element) SelfDirty() bool

func (*Element) SetAttribute 

func (e *Element) SetAttribute(name string, value interface{})

SetAttribute sets an attribute value and marks dirty.

func (*Element) SetBounds 

func (e *Element) SetBounds(r graphics.Rect)

func (*Element) SetFocused 

func (e *Element) SetFocused(focused bool)

func (*Element) SetID 

func (e *Element) SetID(id string)

SetID updates the element id.

func (*Element) SetTerminalBuffer 

func (e *Element) SetTerminalBuffer(lines [][]TerminalCell, cursorCol, cursorRow int, showCursor bool)

SetTerminalBuffer updates a multiline element with terminal-styled cells. It keeps the text-area scroll state while replacing its backing lines.

func (*Element) SetVisible 

func (e *Element) SetVisible(visible bool)

func (*Element) Tag 

func (e *Element) Tag() string

Tag returns the element's tag name.

func (*Element) TextAreaAtBottom 

func (e *Element) TextAreaAtBottom(threshold int) bool

TextAreaAtBottom reports whether the current multiline viewport is at the end.

type Engine 

type Engine struct {
	Registry *ComponentRegistry
}

Engine loads .ui files and builds Element trees.

func NewEngine 

func NewEngine() (*Engine, error)

NewEngine creates a new Engine with the standard library loaded.

func (*Engine) LoadFile 

func (eng *Engine) LoadFile(path string, handler interface{}) (*Element, error)

LoadFile loads a .ui file from disk and builds the root Element.

func (*Engine) LoadString 

func (eng *Engine) LoadString(source string, handler interface{}) (*Element, error)

LoadString parses a .ui source string and builds the root Element. The handler receives signal connections (onXxx: MethodName).

type ImportDecl 

type ImportDecl = uiparse.ImportDecl

type Node 

type Node = uiparse.Node

type ParseError 

type ParseError = uiparse.ParseError

type Property 

type Property = uiparse.Property

type SignalDecl 

type SignalDecl = uiparse.SignalDecl

type TerminalCell 

type TerminalCell struct {
	Char      rune
	Fg        graphics.Color
	Bg        graphics.Color
	Underline bool
}

TerminalCell holds one terminal glyph with resolved foreground/background colors.

type Value 

type Value = uiparse.Value

type ValueKind 

type ValueKind = uiparse.ValueKind

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.