ui

type Anchor ¶ added in v0.2.0

type Anchor uint8

Anchor is a bit set of output edges a layer surface attaches to.

const (
	AnchorTop Anchor = 1 << iota
	AnchorBottom
	AnchorLeft
	AnchorRight
)

type ButtonEvent ¶

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

Control event values are immutable snapshots; querying them never consumes events.

func (e ButtonEvent) Activated() bool

type ButtonOption ¶

type ButtonOption interface {
	// contains filtered or unexported methods
}

type ChangeEvent ¶

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

func (e ChangeEvent) Changed() bool

type CommonOption ¶

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

CommonOption is the concrete type of Key, ID, Class and Inline; it belongs to every option family. It is exported only so the root facade can return it.

func Class(class string) CommonOption

func ID(id string) CommonOption

func Inline(src string) CommonOption

func Key(key string) CommonOption

type ContainerOption ¶

type ContainerOption interface {
	// contains filtered or unexported methods
}

ContainerOption, ButtonOption and EditOption are separate option families.

type DisabledOption ¶

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

DisabledOption is the concrete type of Disabled. It applies to every interactive control (buttons, value controls and editors) but not to containers or headings. Exported only so the root facade can return it.

func Disabled(v bool) DisabledOption

type EditEvent ¶

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

func (e EditEvent) Changed() bool

func (e EditEvent) Submitted() bool

type EditOption ¶

type EditOption interface {
	// contains filtered or unexported methods
}

func Password(v bool) EditOption

func Placeholder(v string) EditOption

type Frame ¶

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

Frame is valid only during one call to the view function.

func (f *Frame) Diagnostics() []string

func (f *Frame) Root(options ...ContainerOption) Node

func (f *Frame) SetInputRects(rects []Rect) error

func (f *Frame) Size() (width, height float64)

type HeadingOption ¶

type HeadingOption interface {
	// contains filtered or unexported methods
}

HeadingOption accepts common CSS options and Level, but not control options.

func Level(level int) HeadingOption

type InputEvent ¶ added in v0.2.0

type InputEvent struct {
	Kind      InputKind
	X, Y      float64
	DX, DY    float64
	Button    uint32
	Pressed   bool
	Repeat    bool
	KeyName   string
	Text      string
	Modifiers Modifiers
}

InputEvent is a raw platform event, delivered on the owner loop before the normal control routing. Coordinates are logical, surface-local pixels. Size changes are not input; use OnResize and Frame.Size. Which fields are set depends on Kind:

pointer motion/press/release/axis: X, Y; press/release: Button (evdev code)
and Pressed; axis: DX, DY
key: KeyName, Text, Modifiers, Pressed, Repeat

type InputKind ¶ added in v0.2.0

type InputKind uint8

InputKind classifies an InputEvent.

const (
	InputPointerMotion InputKind = iota + 1
	InputPointerPress
	InputPointerRelease
	InputPointerAxis
	InputPointerLeave
	InputKey
	InputFocusIn
	InputFocusOut
	InputReset // platform dropped queued input; treat held state as released
)

type KeyboardMode ¶ added in v0.2.0

type KeyboardMode uint8

KeyboardMode is the layer surface keyboard interactivity. The zero value is KeyboardNone: the surface never takes keyboard focus. KeyboardOnDemand needs layer-shell version 4.

const (
	KeyboardNone KeyboardMode = iota
	KeyboardExclusive
	KeyboardOnDemand
)

type LayerConfig ¶ added in v0.2.0

type LayerConfig struct {
	Output string // output name; empty lets the compositor choose
	// AllOutputs puts one surface on every output, including outputs added
	// while Run is running; removed outputs lose theirs. Every surface shows
	// the same view and model, laid out at its own size and scale. Run then
	// returns only on cancellation or failure. It excludes Output, keyboard
	// interactivity, OnSurface, OnResize and RunFrames.
	AllOutputs    bool
	Namespace     string // defaults to "nefergui"
	Level         LayerLevel
	Anchors       Anchor
	Keyboard      KeyboardMode
	ExclusiveZone int32
	Margin        [4]int32 // top, right, bottom, left
	// InputRects, when non-nil, restricts pointer input to these rectangles.
	// An empty non-nil slice makes the surface fully click-through. Rects need
	// positive width and height.
	InputRects []Rect
}

LayerConfig requests a wlr-layer-shell surface instead of an xdg toplevel. Size still gives the initial logical size; an axis anchored to both opposite edges is sized by the compositor and reported through OnResize and Frame.Size. ExclusiveZone > 0 asks the compositor to reserve that many logical pixels from an anchored edge (only for one edge, or one edge plus both perpendicular edges); 0 reserves nothing and asks to avoid other surfaces' positive zones; -1 ignores other exclusive zones and extends to the anchored output edges.

type LayerLevel ¶ added in v0.2.0

type LayerLevel uint8

LayerLevel is the wlr-layer-shell stacking layer. The zero value is invalid, so a surface never silently lands below every window.

const (
	LayerBackground LayerLevel = iota + 1
	LayerBottom
	LayerTop
	LayerOverlay
)

type LockConfig ¶ added in v0.3.0

type LockConfig struct {
	// Display is the Wayland socket name; empty uses the environment.
	Display string
	// Styles is an optional author stylesheet path, as for the Styles option.
	Styles string
	// Secret receives typed input. Required.
	Secret *SecretBuffer
	// View builds the content of the one output that hosts it (the output whose
	// surface has keyboard focus, initially the first). Required. Other outputs
	// show plain opaque black.
	View func(*Frame, LockState)
	// OnLocked runs once on the owner loop when the compositor sends locked.
	OnLocked func()
	// OnSubmit runs on the owner loop when Enter is pressed after locked. It
	// must not block: verification is asynchronous. secret aliases Secret's
	// memory and is valid only during the call; it is wiped right after it
	// returns, so the callee copies or consumes it before returning.
	OnSubmit func(secret []byte)
	// Unlock, when it receives a value, asks RunLock to send
	// unlock_and_destroy, roundtrip and return nil. This is the only unlock
	// path: it is the caller's explicit request after its own verification. A
	// request received before the locked event is held until locked; closing
	// the channel is not a request. A nil channel never unlocks.
	Unlock <-chan struct{}
	// Status delivers the state shown as LockState.Status; each received value
	// schedules a redraw. Optional.
	Status <-chan LockStatus
	// Wake requests a redraw for each received value.
	Wake <-chan struct{}
	// OnOutputError reports an output added after acquisition that could not
	// get a lock surface; the compositor keeps it black. Optional, owner loop.
	OnOutputError func(output string, err error)
}

LockConfig configures RunLock.

type LockState ¶ added in v0.3.0

type LockState struct {
	Mask          int        // typed code points, for a mask of that many bullets
	Locked        bool       // the compositor confirmed the lock (locked event)
	Status        LockStatus // latest value received on LockConfig.Status
	Width, Height int        // logical size of the surface hosting the view
}

LockState is what the lock view may know: never the secret itself.

func (s LockState) Bullets() string

type LockStatus ¶ added in v0.3.0

type LockStatus uint8

LockStatus is an opaque caller-driven state shown by the view, for example while an authentication attempt runs. NeferGUI attaches no meaning to it.

const (
	LockIdle   LockStatus = iota // ready for input
	LockBusy                     // an attempt is being verified
	LockFailed                   // the last attempt was rejected
)

type Modifiers ¶ added in v0.2.0

type Modifiers uint8

Modifiers is a bit set of keyboard modifiers held during a key event.

const (
	ModShift Modifiers = 1 << iota
	ModCtrl
)

type Node ¶

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

Node is an ephemeral handle into the current frame. Do not retain it between frames.

func (n Node) Aside(options ...ContainerOption) Node

func (n Node) Box(options ...ContainerOption) Node

func (n Node) Button(label string, options ...ButtonOption) ButtonEvent

func (n Node) Checkbox(label string, value *bool, options ...ButtonOption) ChangeEvent

func (n Node) Column(options ...ContainerOption) Node

func (n Node) Element(typ string, options ...ContainerOption) Node

func (n Node) Footer(options ...ContainerOption) Node

func (n Node) Header(options ...ContainerOption) Node

func (n Node) Heading(text string, options ...HeadingOption)

func (n Node) Icon(name string, options ...ContainerOption)

func (n Node) Image(img image.Image, options ...ContainerOption)

func (n Node) Input(label string, value *string, options ...EditOption) EditEvent

func (n Node) Main(options ...ContainerOption) Node

func (n Node) Nav(options ...ContainerOption) Node

func (n Node) Radio(label, option string, selected *string, options ...ButtonOption) ChangeEvent

func (n Node) Rect(x, y, w, h float64) Node

func (n Node) Row(options ...ContainerOption) Node

func (n Node) Scroll(options ...ContainerOption) Node

func (n Node) Section(options ...ContainerOption) Node

func (n Node) Separator(options ...ContainerOption)

func (n Node) Slider(label string, value *float64, min, max, step float64, options ...ValueOption) ChangeEvent

func (n Node) Spacer(options ...ContainerOption)

func (n Node) Stack(options ...ContainerOption) Node

func (n Node) Text(text string, options ...ContainerOption)

func (n Node) Textarea(label string, value *string, options ...EditOption) EditEvent

type Rect ¶ added in v0.2.0

type Rect struct{ X, Y, Width, Height int32 }

Rect is an integer logical-pixel rectangle in surface coordinates.

type SecretBuffer ¶ added in v0.3.0

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

SecretBuffer is a caller-owned fixed-capacity byte buffer for typed secret input. Typed bytes never become a Go string and are never stored in the model, tree or render text; the view only sees Len. Bytes beyond the capacity are dropped. It is used from the lock owner loop only.

func NewSecretBuffer(capacity int) *SecretBuffer

func (b *SecretBuffer) Bytes() []byte

func (b *SecretBuffer) Len() int

func (b *SecretBuffer) Wipe()

type ValueOption ¶

type ValueOption interface {
	// contains filtered or unexported methods
}

ValueOption accepts CSS options and Disabled for pointer-backed controls.

type WaylandSurface ¶ added in v0.2.0

type WaylandSurface struct {
	Display *wl.Display
	Surface *core.Surface
}

WaylandSurface exposes the window's Wayland connection and wl_surface so an integrator can register extra protocol objects on the same client, such as clipboard or surface-marking extensions. It is the escape hatch to the underlying wlturbo objects; it does not add any protocol itself.

The values are owned by NeferGUI and valid until Run returns. Do not close the Display, destroy the Surface or attach buffers. Events for objects the callback creates are dispatched on the owner goroutine while requests such as roundtrips run before the event reader starts, and on NeferGUI's reader goroutine afterwards, so handlers must synchronize any state they share.

type WindowOption ¶

type WindowOption interface {
	// contains filtered or unexported methods
}

func Layer(c LayerConfig) WindowOption

func OnInput(fn func(InputEvent) bool) WindowOption

func OnResize(fn func(width, height int, scale float64)) WindowOption

func OnSurface(fn func(context.Context, WaylandSurface) error) WindowOption

func Size(w, h int) WindowOption

func Styles(s string) WindowOption

func Title(s string) WindowOption

func Transparent() WindowOption

func Wake(ch <-chan struct{}) WindowOption