objects/label.go

package objects

import "git.tebibyte.media/tomo/tomo"
import "git.tebibyte.media/tomo/tomo/text"
import "git.tebibyte.media/tomo/tomo/event"

var _ tomo.Object = new(Label)

// Label is a simple text label.
type Label struct {
	box tomo.TextBox
}

// NewLabel creates a new text label.
func NewLabel (text string) *Label {
	this := &Label { box: tomo.NewTextBox() }
	this.box.SetRole(tomo.R("objects", "Label"))
	this.SetText(text)
	this.box.SetAttr(tomo.AAlign(tomo.AlignStart, tomo.AlignMiddle))
	this.box.SetSelectable(true)
	this.box.SetFocusable(true)
	return this
}

// GetBox returns the underlying box.
func (this *Label) GetBox () tomo.Box {
	return this.box
}

// SetFocused sets whether or not this label has keyboard focus. If set to true,
// this method will steal focus away from whichever object currently has focus.
func (this *Label) SetFocused (focused bool) {
	this.box.SetFocused(focused)
}

// SetText sets the text content of the label.
func (this *Label) SetText (text string) {
	this.box.SetText(text)
}

// Select sets the text cursor or selection.
func (this *Label) Select (dot text.Dot) {
	this.box.Select(dot)
}

// Dot returns the text cursor or selection.
func (this *Label) Dot () text.Dot {
	return this.box.Dot()
}

// OnDotChange specifies a function to be called when the text cursor or
// selection changes.
func (this *Label) OnDotChange (callback func ()) event.Cookie {
	return this.box.OnDotChange(callback)
}

// SetAlign sets the X and Y alignment of the label.
func (this *Label) SetAlign (x, y tomo.Align) {
	this.box.SetAttr(tomo.AAlign(x, y))
}

// SetOverflow sets the X and Y overflow of the label.
func (this *Label) SetOverflow (x, y bool) {
	this.box.SetAttr(tomo.AOverflow(x, y))
}