add some comments

2023-04-08 08:59:39 -07:00
parent a6b5e03476
commit 7298b6f8b9
10 changed files with 25 additions and 0 deletions
@@ -8,6 +8,8 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// The "aux" controls for playback, positioned to the right
+// of the BottomPanel. Currently only volume control.
 type AuxControls struct {
 	widget.BaseWidget

@@ -11,6 +11,9 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// A widget that can display an image or else
+// a placeholder with a rectangular border frame
+// and an icon positioned in the center of the frame.
 type ImagePlaceholder struct {
 	widget.BaseWidget
 	container *fyne.Container
@@ -14,6 +14,7 @@ var _ fyne.Tappable = (*ListRowBase)(nil)
 var _ fyne.Widget = (*ListRowBase)(nil)
 var _ fyne.Focusable = (*ListRowBase)(nil)

+// Base type used for all list rows in widgets such as Tracklist, etc.
 type ListRowBase struct {
 	widget.BaseWidget

@@ -10,6 +10,8 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// Shows the current album art, track name, artist name, and album name
+// for the currently playing track. Placed into the left side of the BottomPanel.
 type NowPlayingCard struct {
 	widget.BaseWidget

@@ -8,6 +8,8 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// A widget.Entry that allows restrictions on the text
+// that can be typed into it, based on a charAllowed callback.
 type TextRestrictedEntry struct {
 	widget.Entry

@@ -8,6 +8,9 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// Lays out multiple buttons horizontally with no padding,
+// and uses button.Importance to highlight exactly one which is "active".
+// Similar to a segmented control in other UI toolkits.
 type ToggleButtonGroup struct {
 	widget.BaseWidget

@@ -6,6 +6,9 @@ import (
 	"fyne.io/fyne/v2/widget"
 )

+// Similar to widgets.ToggleButtonGroup, but using text.
+// The "active" label is bolded non-interactive text,
+// while all the others are hyperlinks.
 type ToggleText struct {
 	widget.BaseWidget