From 060cff257f1ddbbe20030fb8408bba33760f0522 Mon Sep 17 00:00:00 2001 From: Elias Naur Date: Sun, 3 May 2020 12:29:41 +0200 Subject: [PATCH] material: make theme constructors stand-alone functions The multitude of widget methods on Theme is unnecessary coupling in that all possible widgets either have to be included in package material, or be different than 3rd party widgets: var th *Theme // Core widget, calling a method on Theme. th.Button(...).Layout(...) // 3rd party widget, calling a function taking a Theme. datepicker.New(th, ...).Layout(...) Another reason for the Theme methods was to enable a poor man's theme replacement, so that you could use the same code for compatible themes. For example, mat.Button(...).Layout(...) would not need to change if the type of mat changed, as long as the new type had a compatible method Button. However, that point misses the fact that the mat variable had to be declared somewhere, naming the theme package: var mat *material.Theme (or, say, *cocoa.Theme) A better and complete way to replace a theme is to use import renaming. For example, to replace the material theme with a hypothetical Windows theme, replace import theme "gioui.org/widget/material" with import theme "github.com/somebody/windows This change moves all Theme widget methods to be standalone functions, and renames the widget style types accordingly. For example, instead of the method func (t *Theme) Button(...) Button there is now a function func Button(t *Theme, ...) ButtonStyle Signed-off-by: Elias Naur --- widget/material/button.go | 40 ++++++++++++++-------------- widget/material/checkbox.go | 20 +++++++------- widget/material/doc.go | 10 +++---- widget/material/editor.go | 16 ++++++------ widget/material/label.go | 48 +++++++++++++++++----------------- widget/material/progressbar.go | 10 +++---- widget/material/radiobutton.go | 20 +++++++------- 7 files changed, 82 insertions(+), 82 deletions(-) diff --git a/widget/material/button.go b/widget/material/button.go index c78d7204..98dc6807 100644 --- a/widget/material/button.go +++ b/widget/material/button.go @@ -17,7 +17,7 @@ import ( "gioui.org/widget" ) -type Button struct { +type ButtonStyle struct { Text string // Color is the text color. Color color.RGBA @@ -29,14 +29,14 @@ type Button struct { shaper text.Shaper } -type ButtonLayout struct { +type ButtonLayoutStyle struct { Background color.RGBA Color color.RGBA CornerRadius unit.Value Inset layout.Inset } -type IconButton struct { +type IconButtonStyle struct { Background color.RGBA Color color.RGBA Icon *widget.Icon @@ -45,42 +45,42 @@ type IconButton struct { Inset layout.Inset } -func (t *Theme) Button(txt string) Button { - return Button{ +func Button(th *Theme, txt string) ButtonStyle { + return ButtonStyle{ Text: txt, Color: rgb(0xffffff), CornerRadius: unit.Dp(4), - Background: t.Color.Primary, - TextSize: t.TextSize.Scale(14.0 / 16.0), + Background: th.Color.Primary, + TextSize: th.TextSize.Scale(14.0 / 16.0), Inset: layout.Inset{ Top: unit.Dp(10), Bottom: unit.Dp(10), Left: unit.Dp(12), Right: unit.Dp(12), }, - shaper: t.Shaper, + shaper: th.Shaper, } } -func (t *Theme) ButtonLayout() ButtonLayout { - return ButtonLayout{ - Background: t.Color.Primary, - Color: t.Color.InvText, +func ButtonLayout(th *Theme) ButtonLayoutStyle { + return ButtonLayoutStyle{ + Background: th.Color.Primary, + Color: th.Color.InvText, CornerRadius: unit.Dp(4), Inset: layout.UniformInset(unit.Dp(12)), } } -func (t *Theme) IconButton(icon *widget.Icon) IconButton { - return IconButton{ - Background: t.Color.Primary, - Color: t.Color.InvText, +func IconButton(th *Theme, icon *widget.Icon) IconButtonStyle { + return IconButtonStyle{ + Background: th.Color.Primary, + Color: th.Color.InvText, Icon: icon, Size: unit.Dp(56), Padding: unit.Dp(16), } } -func (b Button) Layout(gtx *layout.Context, button *widget.Button) { - ButtonLayout{ +func (b ButtonStyle) Layout(gtx *layout.Context, button *widget.Button) { + ButtonLayoutStyle{ Background: b.Background, CornerRadius: b.CornerRadius, Color: b.Color, @@ -90,7 +90,7 @@ func (b Button) Layout(gtx *layout.Context, button *widget.Button) { }) } -func (b ButtonLayout) Layout(gtx *layout.Context, button *widget.Button, w layout.Widget) { +func (b ButtonLayoutStyle) Layout(gtx *layout.Context, button *widget.Button, w layout.Widget) { hmin := gtx.Constraints.Width.Min vmin := gtx.Constraints.Height.Min layout.Stack{Alignment: layout.Center}.Layout(gtx, @@ -123,7 +123,7 @@ func (b ButtonLayout) Layout(gtx *layout.Context, button *widget.Button, w layou ) } -func (b IconButton) Layout(gtx *layout.Context, button *widget.Button) { +func (b IconButtonStyle) Layout(gtx *layout.Context, button *widget.Button) { layout.Stack{Alignment: layout.Center}.Layout(gtx, layout.Expanded(func() { size := gtx.Constraints.Width.Min diff --git a/widget/material/checkbox.go b/widget/material/checkbox.go index b655d135..3fea13a7 100644 --- a/widget/material/checkbox.go +++ b/widget/material/checkbox.go @@ -8,26 +8,26 @@ import ( "gioui.org/widget" ) -type CheckBox struct { +type CheckBoxStyle struct { checkable } -func (t *Theme) CheckBox(label string) CheckBox { - return CheckBox{ +func CheckBox(th *Theme, label string) CheckBoxStyle { + return CheckBoxStyle{ checkable{ Label: label, - Color: t.Color.Text, - IconColor: t.Color.Primary, - TextSize: t.TextSize.Scale(14.0 / 16.0), + Color: th.Color.Text, + IconColor: th.Color.Primary, + TextSize: th.TextSize.Scale(14.0 / 16.0), Size: unit.Dp(26), - shaper: t.Shaper, - checkedStateIcon: t.checkBoxCheckedIcon, - uncheckedStateIcon: t.checkBoxUncheckedIcon, + shaper: th.Shaper, + checkedStateIcon: th.checkBoxCheckedIcon, + uncheckedStateIcon: th.checkBoxUncheckedIcon, }, } } -func (c CheckBox) Layout(gtx *layout.Context, checkBox *widget.CheckBox) { +func (c CheckBoxStyle) Layout(gtx *layout.Context, checkBox *widget.CheckBox) { c.layout(gtx, checkBox.Checked(gtx)) checkBox.Layout(gtx) } diff --git a/widget/material/doc.go b/widget/material/doc.go index 4fd1a251..25f1dcf9 100644 --- a/widget/material/doc.go +++ b/widget/material/doc.go @@ -22,12 +22,12 @@ // // theme := material.NewTheme(...) // -// th.Button("Click me!").Layout(gtx, button) +// 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: +// 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 @@ -41,7 +41,7 @@ // Widget-local parameters: For changing the look of a particular widget, // adjust the widget specific theme object: // -// btn := th.Button("Click me!") +// btn := material.Button(theme, "Click me!") // btn.Font.Style = text.Italic // btn.Layout(gtx) // @@ -51,7 +51,7 @@ // // icon := material.NewIcon(...) // -// th.IconButton(icon).Layout(gtx, button) +// 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 diff --git a/widget/material/editor.go b/widget/material/editor.go index d11ff88a..d150f364 100644 --- a/widget/material/editor.go +++ b/widget/material/editor.go @@ -13,7 +13,7 @@ import ( "gioui.org/widget" ) -type Editor struct { +type EditorStyle struct { Font text.Font TextSize unit.Value // Color is the text color. @@ -26,17 +26,17 @@ type Editor struct { shaper text.Shaper } -func (t *Theme) Editor(hint string) Editor { - return Editor{ - TextSize: t.TextSize, - Color: t.Color.Text, - shaper: t.Shaper, +func Editor(th *Theme, hint string) EditorStyle { + return EditorStyle{ + TextSize: th.TextSize, + Color: th.Color.Text, + shaper: th.Shaper, Hint: hint, - HintColor: t.Color.Hint, + HintColor: th.Color.Hint, } } -func (e Editor) Layout(gtx *layout.Context, editor *widget.Editor) { +func (e EditorStyle) Layout(gtx *layout.Context, editor *widget.Editor) { var stack op.StackOp stack.Push(gtx.Ops) var macro op.MacroOp diff --git a/widget/material/label.go b/widget/material/label.go index 10d6e5e8..96830be5 100644 --- a/widget/material/label.go +++ b/widget/material/label.go @@ -12,7 +12,7 @@ import ( "gioui.org/widget" ) -type Label struct { +type LabelStyle struct { // Face defines the text style. Font text.Font // Color is the text color. @@ -27,52 +27,52 @@ type Label struct { shaper text.Shaper } -func (t *Theme) H1(txt string) Label { - return t.Label(t.TextSize.Scale(96.0/16.0), txt) +func H1(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(96.0/16.0), txt) } -func (t *Theme) H2(txt string) Label { - return t.Label(t.TextSize.Scale(60.0/16.0), txt) +func H2(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(60.0/16.0), txt) } -func (t *Theme) H3(txt string) Label { - return t.Label(t.TextSize.Scale(48.0/16.0), txt) +func H3(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(48.0/16.0), txt) } -func (t *Theme) H4(txt string) Label { - return t.Label(t.TextSize.Scale(34.0/16.0), txt) +func H4(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(34.0/16.0), txt) } -func (t *Theme) H5(txt string) Label { - return t.Label(t.TextSize.Scale(24.0/16.0), txt) +func H5(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(24.0/16.0), txt) } -func (t *Theme) H6(txt string) Label { - return t.Label(t.TextSize.Scale(20.0/16.0), txt) +func H6(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(20.0/16.0), txt) } -func (t *Theme) Body1(txt string) Label { - return t.Label(t.TextSize, txt) +func Body1(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize, txt) } -func (t *Theme) Body2(txt string) Label { - return t.Label(t.TextSize.Scale(14.0/16.0), txt) +func Body2(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(14.0/16.0), txt) } -func (t *Theme) Caption(txt string) Label { - return t.Label(t.TextSize.Scale(12.0/16.0), txt) +func Caption(th *Theme, txt string) LabelStyle { + return Label(th, th.TextSize.Scale(12.0/16.0), txt) } -func (t *Theme) Label(size unit.Value, txt string) Label { - return Label{ +func Label(th *Theme, size unit.Value, txt string) LabelStyle { + return LabelStyle{ Text: txt, - Color: t.Color.Text, + Color: th.Color.Text, TextSize: size, - shaper: t.Shaper, + shaper: th.Shaper, } } -func (l Label) Layout(gtx *layout.Context) { +func (l LabelStyle) Layout(gtx *layout.Context) { paint.ColorOp{Color: l.Color}.Add(gtx.Ops) tl := widget.Label{Alignment: l.Alignment, MaxLines: l.MaxLines} tl.Layout(gtx, l.shaper, l.Font, l.TextSize, l.Text) diff --git a/widget/material/progressbar.go b/widget/material/progressbar.go index a21a18dc..12c9f758 100644 --- a/widget/material/progressbar.go +++ b/widget/material/progressbar.go @@ -13,17 +13,17 @@ import ( "gioui.org/unit" ) -type ProgressBar struct { +type ProgressBarStyle struct { Color color.RGBA } -func (t *Theme) ProgressBar() ProgressBar { - return ProgressBar{ - Color: t.Color.Primary, +func ProgressBar(th *Theme) ProgressBarStyle { + return ProgressBarStyle{ + Color: th.Color.Primary, } } -func (b ProgressBar) Layout(gtx *layout.Context, progress int) { +func (b ProgressBarStyle) Layout(gtx *layout.Context, progress int) { shader := func(width float32, color color.RGBA) { maxHeight := unit.Dp(4) rr := float32(gtx.Px(unit.Dp(2))) diff --git a/widget/material/radiobutton.go b/widget/material/radiobutton.go index 1152256f..a8d53ffd 100644 --- a/widget/material/radiobutton.go +++ b/widget/material/radiobutton.go @@ -8,31 +8,31 @@ import ( "gioui.org/widget" ) -type RadioButton struct { +type RadioButtonStyle struct { checkable Key string } // RadioButton returns a RadioButton with a label. The key specifies // the value for the Enum. -func (t *Theme) RadioButton(key, label string) RadioButton { - return RadioButton{ +func RadioButton(th *Theme, key, label string) RadioButtonStyle { + return RadioButtonStyle{ checkable: checkable{ Label: label, - Color: t.Color.Text, - IconColor: t.Color.Primary, - TextSize: t.TextSize.Scale(14.0 / 16.0), + Color: th.Color.Text, + IconColor: th.Color.Primary, + TextSize: th.TextSize.Scale(14.0 / 16.0), Size: unit.Dp(26), - shaper: t.Shaper, - checkedStateIcon: t.radioCheckedIcon, - uncheckedStateIcon: t.radioUncheckedIcon, + shaper: th.Shaper, + checkedStateIcon: th.radioCheckedIcon, + uncheckedStateIcon: th.radioUncheckedIcon, }, Key: key, } } -func (r RadioButton) Layout(gtx *layout.Context, enum *widget.Enum) { +func (r RadioButtonStyle) Layout(gtx *layout.Context, enum *widget.Enum) { r.layout(gtx, enum.Value(gtx) == r.Key) enum.Layout(gtx, r.Key) }