mirror of
https://git.sr.ht/~eliasnaur/gio
synced 2026-07-01 15:45:38 +00:00
Elias Naur
3af01a3f43
Change the definition of Widget from the implicit
type Widget func()
to the explicit functional
type Widget func(gtx layout.Context) layout.Dimensions
The advantages are numerous:
- Clearer connection between the incoming context and the output dimensions.
- Returning the Dimensions are impossible to omit.
- Contexts passed by value, so its fields can be exported
and freely mutated by the program.
The only disadvantage is the longer function literals and the many "returns".
What tipped the scales in favour of the explicit Widget variant is that type
aliases can dramatically shorten the literals:
type (
C = layout.Context
D = layout.Dimensions
)
widget := func(gtx C) D {
...
}
Note that the aliases are not part of the Gio API and it is up to each user
whether they want to use them.
Finally the Go proposal for lightweight function literals,
https://github.com/golang/go/issues/21498, may remove the disadvantage
completely in future.
Context becomes a plain struct with only public fields, and its Reset is
replaced by a NewContext convenience constructor.
Signed-off-by: Elias Naur <mail@eliasnaur.com>
60 lines
2.0 KiB
Go
60 lines
2.0 KiB
Go
// SPDX-License-Identifier: Unlicense OR MIT
|
|
|
|
// Package material implements the Material design.
|
|
//
|
|
// To maximize reusability and visual flexibility, user interface controls are
|
|
// split into two parts: the stateful widget and the stateless drawing of it.
|
|
//
|
|
// For example, widget.Clickable encapsulates the state and event
|
|
// handling of all clickable areas, while the Theme is responsible to
|
|
// draw a specific area, for example a button.
|
|
//
|
|
// This snippet defines a button that prints a message when clicked:
|
|
//
|
|
// var gtx layout.Context
|
|
// button := new(widget.Clickable)
|
|
//
|
|
// for button.Clicked(gtx) {
|
|
// fmt.Println("Clicked!")
|
|
// }
|
|
//
|
|
// Use a Theme to draw the button:
|
|
//
|
|
// theme := material.NewTheme(...)
|
|
//
|
|
// material.Button(theme, "Click me!").Layout(gtx, button)
|
|
//
|
|
// Customization
|
|
//
|
|
// Quite often, a program needs to customize the theme-provided defaults. Several
|
|
// options are available, depending on the nature of the change.
|
|
//
|
|
// Mandatory parameters: Some parameters are not part of the widget state but
|
|
// have no obvious default. In the program above, the button text is a
|
|
// parameter to the Theme.Button method.
|
|
//
|
|
// Theme-global parameters: For changing the look of all widgets drawn with a
|
|
// particular theme, adjust the `Theme` fields:
|
|
//
|
|
// theme.Color.Primary = color.RGBA{...}
|
|
//
|
|
// Widget-local parameters: For changing the look of a particular widget,
|
|
// adjust the widget specific theme object:
|
|
//
|
|
// btn := material.Button(theme, "Click me!")
|
|
// btn.Font.Style = text.Italic
|
|
// btn.Layout(gtx, button)
|
|
//
|
|
// Widget variants: A widget can have several distinct representations even
|
|
// though the underlying state is the same. A widget.Clickable can be drawn as a
|
|
// round icon button:
|
|
//
|
|
// icon := material.NewIcon(...)
|
|
//
|
|
// material.IconButton(theme, icon).Layout(gtx, button)
|
|
//
|
|
// Specialized widgets: Theme both define a generic Label method
|
|
// that takes a text size, and specialized methods for standard text
|
|
// sizes such as Theme.H1 and Theme.Body2.
|
|
package material
|