Documented the Label change.

newctrl/basicctrls.go

@@ -0,0 +1,118 @@
+// 7 july 2014
+
+package ui
+
+// Button is a clickable button that performs some task.
+type Button interface {
+	Control
+
+	// OnClicked sets the event handler for when the Button is clicked.
+	OnClicked(func())
+
+	// Text and SetText get and set the Button's label text.
+	Text() string
+	SetText(text string)
+}
+
+// NewButton creates a new Button with the given label text.
+func NewButton(text string) Button {
+	return newButton(text)
+}
+
+// Checkbox is a clickable box that indicates some Boolean value.
+type Checkbox interface {
+	Control
+
+	// OnToggled sets the event handler for when the Checkbox is toggled.
+	OnToggled(func())
+
+	// Text and SetText get and set the Checkbox's label text.
+	Text() string
+	SetText(text string)
+
+	// Checked and SetChecked get and set the Checkbox's check state.
+	Checked() bool
+	SetChecked(checked bool)
+}
+
+// NewCheckbox creates a new Checkbox with the given label text.
+// The Checkbox will be initially unchecked.
+func NewCheckbox(text string) Checkbox {
+	return newCheckbox(text)
+}
+
+// TextField is a Control in which the user can enter a single line of text.
+type TextField interface {
+	Control
+
+	// Text and SetText are Requests that get and set the TextField's text.
+	Text() string
+	SetText(text string)
+
+	// OnChanged is triggered when the text in a TextField is changed somehow.
+	// Do not bother trying to figure out how the text was changed; instead, perform your validation and use Invalid to inform the user that the entered text is invalid instead.
+	OnChanged(func())
+
+	// Invalid throws a non-modal alert (whose nature is system-defined) on or near the TextField that alerts the user that input is invalid.
+	// The string passed to Invalid will be displayed to the user to inform them of what specifically is wrong with the input.
+	// Pass an empty string to remove the warning.
+	Invalid(reason string)
+}
+
+// NewTextField creates a new TextField.
+func NewTextField() TextField {
+	return newTextField()
+}
+
+// NewPasswordField creates a new TextField for entering passwords; that is, it hides the text being entered.
+func NewPasswordField() TextField {
+	return newPasswordField()
+}
+
+// Tab is a Control that contains multiple pages of tabs, each containing a single Control.
+// You can add and remove tabs from the Tab at any time.
+// The appearance of a Tab with no tabs is implementation-defined.
+type Tab interface {
+	Control
+
+	// Append adds a new tab to Tab.
+	// The tab is added to the end of the current list of tabs.
+	Append(name string, control Control)
+}
+
+// NewTab creates a new Tab with no tabs.
+func NewTab() Tab {
+	return newTab()
+}
+
+// Label is a Control that shows a static line of text.
+// Label shows one line of text; any text that does not fit is truncated.
+// Labels are left-aligned. [FUTURE PLANS: For platform-specific horizontal alignment rules, use a Form.]
+type Label interface {
+	Control
+
+	// Text and SetText get and set the Label's text.
+	Text() string
+	SetText(text string)
+}
+
+// NewLabel creates a new Label with the given text.
+func NewLabel(text string) Label {
+	return newLabel(text)
+}
+
+// Group is a Control that holds a single Control; if that Control also contains other Controls, then the Controls will appear visually grouped together.
+// The appearance of a Group varies from system to system; for the most part a Group consists of a thin frame.
+// All Groups have a text label indicating what the Group is for.
+type Group interface {
+	Control
+
+	// Text and SetText get and set the Group's label text.
+	Text() string
+	SetText(text string)
+}
+
+// NewGroup creates a new Group with the given text label and child Control.
+func NewGroup(text string, control Control) Group {
+	return newGroup(text, control)
+}