mirror of
https://git.sr.ht/~eliasnaur/gio
synced 2026-07-01 15:45:38 +00:00
Elias Naur
50 lines
1.6 KiB
Go
50 lines
1.6 KiB
Go
// SPDX-License-Identifier: Unlicense OR MIT
|
|
|
|
/*
|
|
Package layout implements layouts common to GUI programs.
|
|
|
|
Constraints and dimensions
|
|
|
|
Constraints and dimensions form the interface between
|
|
layouts and interface child elements. Every layout operation
|
|
start with a set of constraints for acceptable widths and heights
|
|
of a child. The operation ends with the child computing and returning
|
|
its size and baseline (if any).
|
|
|
|
For example, to add space above a widget:
|
|
|
|
var cs layout.Constraints = ...
|
|
|
|
// Configure a top inset.
|
|
inset := layout.Inset{Top: ui.Dp(8), ...}
|
|
// Use the inset to lay out a widget.
|
|
inset.Layout(..., cs, func(cs layout.Constraints) layout.Dimensions {
|
|
// Lay out widget and determine its size given the constraints.
|
|
dimensions := widget.Layout(..., cs)
|
|
return dimensions
|
|
})
|
|
|
|
Note that the example does not generate any garbage even though the
|
|
Inset is transient. Layouts that don't accept user input are designed
|
|
to escape to the heap during their use.
|
|
|
|
Layout operations are recursive: a child in a layout operation can
|
|
itself be another layout. That way, complex user interfaces can
|
|
be created from a few generic layouts.
|
|
|
|
This example both aligns and insets a child:
|
|
|
|
inset := layout.Inset{...}
|
|
inset.Layout(..., cs, func(cs layout.Constraints) layout.Dimensions {
|
|
align := layout.Align{...}
|
|
return align.Layout(..., cs, func(cs layout.Constraints) layout.Dimensions {
|
|
return widget.Layout(..., cs)
|
|
})
|
|
})
|
|
|
|
More complex layouts such as Stack and Flex lay out multiple children,
|
|
and stateful layouts such as List accept user input.
|
|
|
|
*/
|
|
package layout
|