-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
check.go
384 lines (324 loc) · 9.51 KB
/
check.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
package widget
import (
"fmt"
"image/color"
"fyne.io/fyne/v2"
"fyne.io/fyne/v2/canvas"
"fyne.io/fyne/v2/data/binding"
"fyne.io/fyne/v2/driver/desktop"
"fyne.io/fyne/v2/internal/widget"
"fyne.io/fyne/v2/theme"
)
// Check widget has a text label and a checked (or unchecked) icon and triggers an event func when toggled
type Check struct {
DisableableWidget
Text string
Checked bool
OnChanged func(bool) `json:"-"`
focused bool
hovered bool
binder basicBinder
minSize fyne.Size // cached for hover/tap position calculations
}
// NewCheck creates a new check widget with the set label and change handler
func NewCheck(label string, changed func(bool)) *Check {
c := &Check{
Text: label,
OnChanged: changed,
}
c.ExtendBaseWidget(c)
return c
}
// NewCheckWithData returns a check widget connected with the specified data source.
//
// Since: 2.0
func NewCheckWithData(label string, data binding.Bool) *Check {
check := NewCheck(label, nil)
check.Bind(data)
return check
}
// Bind connects the specified data source to this Check.
// The current value will be displayed and any changes in the data will cause the widget to update.
// User interactions with this Check will set the value into the data source.
//
// Since: 2.0
func (c *Check) Bind(data binding.Bool) {
c.binder.SetCallback(c.updateFromData)
c.binder.Bind(data)
c.OnChanged = func(_ bool) {
c.binder.CallWithData(c.writeData)
}
}
// SetChecked sets the the checked state and refreshes widget
func (c *Check) SetChecked(checked bool) {
c.propertyLock.Lock()
if checked == c.Checked {
c.propertyLock.Unlock()
return
}
c.Checked = checked
onChanged := c.OnChanged
c.propertyLock.Unlock()
if onChanged != nil {
onChanged(checked)
}
c.Refresh()
}
// Hide this widget, if it was previously visible
func (c *Check) Hide() {
if c.focused {
c.FocusLost()
impl := c.super()
if c := fyne.CurrentApp().Driver().CanvasForObject(impl); c != nil {
c.Focus(nil)
}
}
c.BaseWidget.Hide()
}
// MouseIn is called when a desktop pointer enters the widget
func (c *Check) MouseIn(me *desktop.MouseEvent) {
c.MouseMoved(me)
}
// MouseOut is called when a desktop pointer exits the widget
func (c *Check) MouseOut() {
if c.hovered {
c.hovered = false
c.Refresh()
}
}
// MouseMoved is called when a desktop pointer hovers over the widget
func (c *Check) MouseMoved(me *desktop.MouseEvent) {
if c.Disabled() {
return
}
oldHovered := c.hovered
// only hovered if cached minSize has not been initialized (test code)
// or the pointer is within the "active" area of the widget (its minSize)
c.hovered = c.minSize.IsZero() ||
(me.Position.X <= c.minSize.Width && me.Position.Y <= c.minSize.Height)
if oldHovered != c.hovered {
c.Refresh()
}
}
// Tapped is called when a pointer tapped event is captured and triggers any change handler
func (c *Check) Tapped(pe *fyne.PointEvent) {
if c.Disabled() {
return
}
if !c.minSize.IsZero() &&
(pe.Position.X > c.minSize.Width || pe.Position.Y > c.minSize.Height) {
// tapped outside the active area of the widget
return
}
if !c.focused && !fyne.CurrentDevice().IsMobile() {
impl := c.super()
if c := fyne.CurrentApp().Driver().CanvasForObject(impl); c != nil {
c.Focus(impl.(fyne.Focusable))
}
}
c.SetChecked(!c.Checked)
}
// MinSize returns the size that this widget should not shrink below
func (c *Check) MinSize() fyne.Size {
c.ExtendBaseWidget(c)
c.minSize = c.BaseWidget.MinSize()
return c.minSize
}
// CreateRenderer is a private method to Fyne which links this widget to its renderer
func (c *Check) CreateRenderer() fyne.WidgetRenderer {
th := c.Theme()
v := fyne.CurrentApp().Settings().ThemeVariant()
c.ExtendBaseWidget(c)
bg := canvas.NewImageFromResource(th.Icon(theme.IconNameCheckButtonFill))
icon := canvas.NewImageFromResource(th.Icon(theme.IconNameCheckButton))
c.propertyLock.RLock()
defer c.propertyLock.RUnlock()
text := canvas.NewText(c.Text, th.Color(theme.ColorNameForeground, v))
text.Alignment = fyne.TextAlignLeading
focusIndicator := canvas.NewCircle(th.Color(theme.ColorNameBackground, v))
r := &checkRenderer{
widget.NewBaseRenderer([]fyne.CanvasObject{focusIndicator, bg, icon, text}),
bg,
icon,
text,
focusIndicator,
c,
}
r.applyTheme(th, v)
r.updateLabel()
r.updateResource(th)
r.updateFocusIndicator(th, v)
return r
}
// FocusGained is called when the Check has been given focus.
func (c *Check) FocusGained() {
if c.Disabled() {
return
}
c.focused = true
c.Refresh()
}
// FocusLost is called when the Check has had focus removed.
func (c *Check) FocusLost() {
c.focused = false
c.Refresh()
}
// TypedRune receives text input events when the Check is focused.
func (c *Check) TypedRune(r rune) {
if c.Disabled() {
return
}
if r == ' ' {
c.SetChecked(!c.Checked)
}
}
// TypedKey receives key input events when the Check is focused.
func (c *Check) TypedKey(key *fyne.KeyEvent) {}
// SetText sets the text of the Check
//
// Since: 2.4
func (c *Check) SetText(text string) {
c.propertyLock.Lock()
c.Text = text
c.propertyLock.Unlock()
c.Refresh()
}
// Unbind disconnects any configured data source from this Check.
// The current value will remain at the last value of the data source.
//
// Since: 2.0
func (c *Check) Unbind() {
c.OnChanged = nil
c.binder.Unbind()
}
func (c *Check) updateFromData(data binding.DataItem) {
if data == nil {
return
}
boolSource, ok := data.(binding.Bool)
if !ok {
return
}
val, err := boolSource.Get()
if err != nil {
fyne.LogError("Error getting current data value", err)
return
}
c.SetChecked(val) // if val != c.Checked, this will call updateFromData again, but only once
}
func (c *Check) writeData(data binding.DataItem) {
if data == nil {
return
}
boolTarget, ok := data.(binding.Bool)
if !ok {
return
}
currentValue, err := boolTarget.Get()
if err != nil {
return
}
if currentValue != c.Checked {
err := boolTarget.Set(c.Checked)
if err != nil {
fyne.LogError(fmt.Sprintf("Failed to set binding value to %t", c.Checked), err)
}
}
}
type checkRenderer struct {
widget.BaseRenderer
bg, icon *canvas.Image
label *canvas.Text
focusIndicator *canvas.Circle
check *Check
}
// MinSize calculates the minimum size of a check.
// This is based on the contained text, the check icon and a standard amount of padding added.
func (c *checkRenderer) MinSize() fyne.Size {
th := c.check.Theme()
pad4 := th.Size(theme.SizeNameInnerPadding) * 2
min := c.label.MinSize().Add(fyne.NewSize(th.Size(theme.SizeNameInlineIcon)+pad4, pad4))
c.check.propertyLock.RLock()
text := c.check.Text
c.check.propertyLock.RUnlock()
if text != "" {
min.Add(fyne.NewSize(th.Size(theme.SizeNamePadding), 0))
}
return min
}
// Layout the components of the check widget
func (c *checkRenderer) Layout(size fyne.Size) {
th := c.check.Theme()
innerPadding := th.Size(theme.SizeNameInnerPadding)
borderSize := th.Size(theme.SizeNameInputBorder)
iconInlineSize := th.Size(theme.SizeNameInlineIcon)
focusIndicatorSize := fyne.NewSquareSize(iconInlineSize + innerPadding)
c.focusIndicator.Resize(focusIndicatorSize)
c.focusIndicator.Move(fyne.NewPos(borderSize, (size.Height-focusIndicatorSize.Height)/2))
xOff := focusIndicatorSize.Width + borderSize*2
labelSize := size.SubtractWidthHeight(xOff, 0)
c.label.Resize(labelSize)
c.label.Move(fyne.NewPos(xOff, 0))
iconPos := fyne.NewPos(innerPadding/2+borderSize, (size.Height-iconInlineSize)/2)
iconSize := fyne.NewSquareSize(iconInlineSize)
c.bg.Move(iconPos)
c.bg.Resize(iconSize)
c.icon.Move(iconPos)
c.icon.Resize(iconSize)
}
// applyTheme updates this Check to the current theme
func (c *checkRenderer) applyTheme(th fyne.Theme, v fyne.ThemeVariant) {
c.label.Color = th.Color(theme.ColorNameForeground, v)
c.label.TextSize = th.Size(theme.SizeNameText)
if c.check.disabled.Load() {
c.label.Color = th.Color(theme.ColorNameDisabled, v)
}
}
func (c *checkRenderer) Refresh() {
th := c.check.Theme()
v := fyne.CurrentApp().Settings().ThemeVariant()
c.check.propertyLock.RLock()
c.applyTheme(th, v)
c.updateLabel()
c.updateResource(th)
c.updateFocusIndicator(th, v)
c.check.propertyLock.RUnlock()
canvas.Refresh(c.check.super())
}
// must be called while holding c.check.propertyLock for reading
func (c *checkRenderer) updateLabel() {
c.label.Text = c.check.Text
}
// must be called while holding c.check.propertyLock for reading
func (c *checkRenderer) updateResource(th fyne.Theme) {
res := theme.NewThemedResource(th.Icon(theme.IconNameCheckButton))
res.ColorName = theme.ColorNameInputBorder
bgRes := theme.NewThemedResource(th.Icon(theme.IconNameCheckButtonFill))
bgRes.ColorName = theme.ColorNameInputBackground
if c.check.Checked {
res = theme.NewThemedResource(th.Icon(theme.IconNameCheckButtonChecked))
res.ColorName = theme.ColorNamePrimary
bgRes.ColorName = theme.ColorNameBackground
}
if c.check.disabled.Load() {
if c.check.Checked {
res = theme.NewThemedResource(theme.CheckButtonCheckedIcon())
}
res.ColorName = theme.ColorNameDisabled
bgRes.ColorName = theme.ColorNameBackground
}
c.icon.Resource = res
c.bg.Resource = bgRes
}
// must be called while holding c.check.propertyLock for reading
func (c *checkRenderer) updateFocusIndicator(th fyne.Theme, v fyne.ThemeVariant) {
if c.check.disabled.Load() {
c.focusIndicator.FillColor = color.Transparent
} else if c.check.focused {
c.focusIndicator.FillColor = th.Color(theme.ColorNameFocus, v)
} else if c.check.hovered {
c.focusIndicator.FillColor = th.Color(theme.ColorNameHover, v)
} else {
c.focusIndicator.FillColor = color.Transparent
}
}