objects

README

objects

Objects contains a standard collection of re-usable objects. All objects in this module visually conform to whatever the theme is set to.

Documentation

Index

• type Button
  • func NewButton(text string) *Button
  • func (this *Button) OnClick(callback func()) event.Cookie
  • func (this *Button) SetIcon(icon *Icon)
  • func (this *Button) SetText(text string)
• type Container
  • func NewInnerContainer(layout tomo.Layout, children ...tomo.Object) *Container
  • func NewOuterContainer(layout tomo.Layout, children ...tomo.Object) *Container
• type Heading
• type Icon
  • func NewIcon(id theme.Icon, size theme.IconSize) *Icon
  • func NewMimeIcon(mime data.Mime, size theme.IconSize) *Icon
  • func (this *Icon) SetTexture(texture canvas.Texture)
• type Label
  • func NewHeading(level int, text string) *Label
  • func NewLabel(text string) *Label
• type ScrollContainer
  • func NewScrollContainer(sides ScrollSide) *ScrollContainer
  • func (this *ScrollContainer) SetRoot(root tomo.ContentBox)
• type ScrollSide
  • func (sides ScrollSide) Horizontal() bool
  • func (sides ScrollSide) String() string
  • func (sides ScrollSide) Vertical() bool
• type Scrollbar
  • func NewHorizontalScrollbar() *Scrollbar
  • func NewVerticalScrollbar() *Scrollbar
  • func (this *Scrollbar) Link(box tomo.ContentBox) event.Cookie
  • func (this *Scrollbar) OnValueChange(callback func()) event.Cookie
  • func (this *Scrollbar) SetValue(value float64)
  • func (this *Scrollbar) Value() float64
• type Separator
  • func NewSeparator() *Separator
• type Slider
  • func NewHorizontalSlider(value float64) *Slider
  • func NewVerticalSlider(value float64) *Slider
  • func (this *Slider) OnValueChange(callback func()) event.Cookie
  • func (this *Slider) SetValue(value float64)
  • func (this *Slider) Value() float64
• type SliderHandle
• type TextInput
  • func NewTextInput(text string) *TextInput
  • func (this *TextInput) OnEnter(callback func()) event.Cookie
  • func (this *TextInput) SetText(text string)
  • func (this *TextInput) Text() string
• type TextView
  • func NewTextView(text string) *TextView

Types

type Button

type Button struct {
	tomo.ContainerBox
	// contains filtered or unexported fields
}

Button is a clickable button.

func NewButton

func NewButton(text string) *Button

NewButton creates a new button with the specified text.

func (*Button) OnClick

func (this *Button) OnClick(callback func()) event.Cookie

OnClick specifies a function to be called when the button is clicked.

func (*Button) SetIcon

func (this *Button) SetIcon(icon *Icon)

SetIcon sets an icon for this button. TODO: use tomo.Icon instead, use small size icons

func (*Button) SetText

func (this *Button) SetText(text string)

SetText sets the text of the button's label.

type Container

type Container struct {
	tomo.ContainerBox
}

Container is an object that can contain other objects. It can be used as a primitive for building more complex layouts. It has two variants: an outer container, and an inner container. The outer container has padding around its edges, whereas the inner container does not. The container will have a corresponding object role variation of either "outer" or "inner".

func NewInnerContainer

func NewInnerContainer(layout tomo.Layout, children ...tomo.Object) *Container

NewInnerContainer creates a new container that has no padding around it.

func NewOuterContainer

func NewOuterContainer(layout tomo.Layout, children ...tomo.Object) *Container

NewOuterContainer creates a new container that has padding around it.

type Heading

type Heading struct {
	tomo.TextBox
}

Heading is a label that denotes the start of some section of content. It can have a level from 0 to 2, with 0 being the most prominent and 2 being the most subtle. The level is described in the role variation.

type Icon

type Icon struct {
	tomo.Box
}

Icon displays a single icon.

func NewIcon

func NewIcon(id theme.Icon, size theme.IconSize) *Icon

NewIcon creates a new icon from an icon ID.

func NewMimeIcon

func NewMimeIcon(mime data.Mime, size theme.IconSize) *Icon

NewMimeIcon creates a new icon from a MIME type.

func (*Icon) SetTexture

func (this *Icon) SetTexture(texture canvas.Texture)

type Label

type Label struct {
	tomo.TextBox
}

Label is a simple text label.

func NewHeading

func NewHeading(level int, text string) *Label

NewHeading creates a new section heading. The level can be from 0 to 2.

func NewLabel

func NewLabel(text string) *Label

NewLabel creates a new text label.

type ScrollContainer

type ScrollContainer struct {
	tomo.ContainerBox
	// contains filtered or unexported fields
}

ScrollContainer couples a ContentBox with one or two Scrollbars.

func NewScrollContainer

func NewScrollContainer(sides ScrollSide) *ScrollContainer

NewScrollContainer creates a new scroll container.

func (*ScrollContainer) SetRoot

func (this *ScrollContainer) SetRoot(root tomo.ContentBox)

SetRoot sets the root child of the ScrollContainer. There can only be one at a time, and setting it will remove and unlink the current child if there is one.

type ScrollSide

type ScrollSide int

ScrollSide determines which Scrollbars are active in a ScrollContainer.

const (
	ScrollVertical ScrollSide = 1 << iota
	ScrollHorizontal
	ScrollBoth = ScrollVertical | ScrollHorizontal
)

func (ScrollSide) Horizontal

func (sides ScrollSide) Horizontal() bool

Horizontal returns true if the side includes a horizontal bar.

func (ScrollSide) String

func (sides ScrollSide) String() string

String returns one of:

• both
• horizontal
• vertical
• none

func (ScrollSide) Vertical

func (sides ScrollSide) Vertical() bool

Vertical returns true if the side includes a vertical bar.

type Scrollbar

type Scrollbar struct {
	tomo.ContainerBox
	// contains filtered or unexported fields
}

Scrollbar is a special type of slider that can control the scroll of any overflowing ContainerBox.

func NewHorizontalScrollbar

func NewHorizontalScrollbar() *Scrollbar

NewHorizontalScrollbar creates a new horizontal scrollbar.

func NewVerticalScrollbar

func NewVerticalScrollbar() *Scrollbar

NewVerticalScrollbar creates a new vertical scrollbar.

func (*Scrollbar) Link

func (this *Scrollbar) Link(box tomo.ContentBox) event.Cookie

Link assigns this scrollbar to a ContentBox. Closing the returned cookie will unlink it.

func (*Scrollbar) OnValueChange

func (this *Scrollbar) OnValueChange(callback func()) event.Cookie

OnValueChange specifies a function to be called when the position of the scrollbar changes.

func (*Scrollbar) SetValue

func (this *Scrollbar) SetValue(value float64)

SetValue sets the value of the scrollbar between 0 and 1, where 0 is scrolled all the way to the left/top, and 1 is scrolled all the way to the right/bottom.

func (*Scrollbar) Value

func (this *Scrollbar) Value() float64

Value returns the value of the scrollbar between 0 and 1 where 0 is scrolled all the way to the left/top, and 1 is scrolled all the way to the right/bottom.

type Separator

type Separator struct {
	tomo.Box
}

Separator is a line for visually separating elements.

func NewSeparator

func NewSeparator() *Separator

NewSeparator creates a new separator line.

type Slider

type Slider struct {
	tomo.ContainerBox
	// contains filtered or unexported fields
}

Slider is a control that selects a numeric value between 0 and 1.

func NewHorizontalSlider

func NewHorizontalSlider(value float64) *Slider

NewHorizontalSlider creates a new horizontal slider with the specified value.

func NewVerticalSlider

func NewVerticalSlider(value float64) *Slider

NewVerticalSlider creates a new vertical slider with the specified value.

func (*Slider) OnValueChange

func (this *Slider) OnValueChange(callback func()) event.Cookie

OnValueChange specifies a function to be called when the slider's value changes.

func (*Slider) SetValue

func (this *Slider) SetValue(value float64)

SetValue sets the value of the slider between 0 and 1.

func (*Slider) Value

func (this *Slider) Value() float64

Value returns the value of the slider between 0 and 1.

type SliderHandle

type SliderHandle struct {
	tomo.Box
}

SliderHandle is a simple object that serves as a handle for sliders and scrollbars. It is completely inert.

type TextInput

type TextInput struct {
	tomo.TextBox
	// contains filtered or unexported fields
}

TextInput is a single-line editable text box.

func NewTextInput

func NewTextInput(text string) *TextInput

NewTextInput creates a new text input containing the specified text.

func (*TextInput) OnEnter

func (this *TextInput) OnEnter(callback func()) event.Cookie

OnEnter specifies a function to be called when the user presses enter within the text input.

func (*TextInput) SetText

func (this *TextInput) SetText(text string)

SetText sets the text content of the input.

func (*TextInput) Text

func (this *TextInput) Text() string

Text returns the text content of the input.

type TextView

type TextView struct {
	tomo.TextBox
}

TextView is an area for displaying a large amount of multi-line text.

func NewTextView

func NewTextView(text string) *TextView

NewTextView creates a new text view.