controls

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2018 License: BSD-3-Clause Imports: 9 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CenterAligner 

func CenterAligner(containerSize float32, elementSize float32) float32

CenterAligner positions the element centered within the container.

func DefaultSliderValueFormatter 

func DefaultSliderValueFormatter(value int64) string

DefaultSliderValueFormatter returns the value in string form.

func LeftAligner 

func LeftAligner(containerSize float32, elementSize float32) float32

LeftAligner always positions the element at zero.

func RightAligner 

func RightAligner(containerSize float32, elementSize float32) float32

RightAligner positions the element right bound within the container.

Types

type ActionHandler 

type ActionHandler func()

ActionHandler is the callback for a firing button (actionable).

type Aligner 

type Aligner func(containerSize float32, elementSize float32) float32

Aligner is a function to calculate the left position of an element within a container. The returned value is the relative offset from left.

type BitmapTexturizer 

type BitmapTexturizer func(*graphics.Bitmap) *graphics.BitmapTexture

BitmapTexturizer creates a bitmap texture from bitmap information.

type ComboBox 

type ComboBox struct {
	// contains filtered or unexported fields
}

ComboBox provides the ability to select one item from a list.

func (*ComboBox) Dispose 

func (box *ComboBox) Dispose()

Dispose releases the resources.

func (*ComboBox) SetItems 

func (box *ComboBox) SetItems(items []ComboBoxItem)

SetItems sets the lits of available items.

func (*ComboBox) SetSelectedItem 

func (box *ComboBox) SetSelectedItem(item ComboBoxItem)

SetSelectedItem changes what is currently selected. Does not fire change handler.

type ComboBoxBuilder 

type ComboBoxBuilder struct {
	// contains filtered or unexported fields
}

ComboBoxBuilder is a builder for ComboBox instances.

func NewComboBoxBuilder 

func NewComboBoxBuilder(labelBuilder *LabelBuilder, rectRenderer *graphics.RectangleRenderer) *ComboBoxBuilder

NewComboBoxBuilder returns a new ComboBoxBuilder instance.

func (*ComboBoxBuilder) Build 

func (builder *ComboBoxBuilder) Build() *ComboBox

Build creates a new ComboBox instance from the current parameters.

func (*ComboBoxBuilder) SetBottom 

func (builder *ComboBoxBuilder) SetBottom(value ui.Anchor) *ComboBoxBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*ComboBoxBuilder) SetLeft 

func (builder *ComboBoxBuilder) SetLeft(value ui.Anchor) *ComboBoxBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*ComboBoxBuilder) SetParent 

func (builder *ComboBoxBuilder) SetParent(parent *ui.Area) *ComboBoxBuilder

SetParent sets the parent area.

func (*ComboBoxBuilder) SetRight 

func (builder *ComboBoxBuilder) SetRight(value ui.Anchor) *ComboBoxBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*ComboBoxBuilder) SetTop 

func (builder *ComboBoxBuilder) SetTop(value ui.Anchor) *ComboBoxBuilder

SetTop sets the top anchor. Default: ZeroAnchor

func (*ComboBoxBuilder) WithItems 

func (builder *ComboBoxBuilder) WithItems(items []ComboBoxItem) *ComboBoxBuilder

WithItems sets the list of contained items.

func (*ComboBoxBuilder) WithSelectionChangeHandler 

func (builder *ComboBoxBuilder) WithSelectionChangeHandler(handler SelectionChangeHandler) *ComboBoxBuilder

WithSelectionChangeHandler sets the handler for a selection change.

type ComboBoxItem 

type ComboBoxItem interface{}

ComboBoxItem is the interface type for items within a combo box.

type Factory 

type Factory interface {
	Scale() float32
	ForLabel() *LabelBuilder
	ForTextButton() *TextButtonBuilder
	ForComboBox() *ComboBoxBuilder
	ForTextureSelector() *TextureSelectorBuilder
	ForSlider() *SliderBuilder
	ForImageDisplay() *ImageDisplayBuilder
}

Factory is an interface for creating controls with a common look-and-feel.

type ImageDisplay 

type ImageDisplay struct {
	// contains filtered or unexported fields
}

ImageDisplay is a graphical selection tool for textures.

func (*ImageDisplay) Dispose 

func (control *ImageDisplay) Dispose()

Dispose releases all current resources.

type ImageDisplayBuilder 

type ImageDisplayBuilder struct {
	// contains filtered or unexported fields
}

ImageDisplayBuilder creates new instances of an ImageDisplay.

func NewImageDisplayBuilder 

func NewImageDisplayBuilder(textureRenderer graphics.TextureRenderer) *ImageDisplayBuilder

NewImageDisplayBuilder returns a new instance of an ImageDisplayBuilder.

func (*ImageDisplayBuilder) Build 

func (builder *ImageDisplayBuilder) Build() *ImageDisplay

Build creates a new ImageDisplay instance from the current parameters.

func (*ImageDisplayBuilder) SetBottom 

func (builder *ImageDisplayBuilder) SetBottom(value ui.Anchor) *ImageDisplayBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*ImageDisplayBuilder) SetLeft 

func (builder *ImageDisplayBuilder) SetLeft(value ui.Anchor) *ImageDisplayBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*ImageDisplayBuilder) SetParent 

func (builder *ImageDisplayBuilder) SetParent(parent *ui.Area) *ImageDisplayBuilder

SetParent sets the parent area.

func (*ImageDisplayBuilder) SetRight 

func (builder *ImageDisplayBuilder) SetRight(value ui.Anchor) *ImageDisplayBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*ImageDisplayBuilder) SetTop 

func (builder *ImageDisplayBuilder) SetTop(value ui.Anchor) *ImageDisplayBuilder

SetTop sets the top anchor. Default: ZeroAnchor

func (*ImageDisplayBuilder) WithProvider 

func (builder *ImageDisplayBuilder) WithProvider(provider ImageProvider) *ImageDisplayBuilder

WithProvider registers the image source

type ImageProvider 

type ImageProvider func() *graphics.BitmapTexture

ImageProvider returns the image to render in the display.

type Label 

type Label struct {
	// contains filtered or unexported fields
}

Label is a control for displaying a text within an area.

func (*Label) AllowTextChange 

func (label *Label) AllowTextChange(handler TextChangeRequestHandler)

AllowTextChange enables the label to receive text updates from the user.

func (*Label) Dispose 

func (label *Label) Dispose()

Dispose releases all resources and removes the area from the tree.

func (*Label) SetText 

func (label *Label) SetText(text string)

SetText updates the current label text.

type LabelBuilder 

type LabelBuilder struct {
	// contains filtered or unexported fields
}

LabelBuilder creates new label controls.

func NewLabelBuilder 

func NewLabelBuilder(textPainter graphics.TextPainter, texturizer BitmapTexturizer,
	textureRenderer graphics.TextureRenderer) *LabelBuilder

NewLabelBuilder returns a new instance of a LabelBuilder.

func (*LabelBuilder) AlignedHorizontallyBy 

func (builder *LabelBuilder) AlignedHorizontallyBy(aligner Aligner) *LabelBuilder

AlignedHorizontallyBy sets the aligner for the horizontal axis. Default: Center.

func (*LabelBuilder) AlignedVerticallyBy 

func (builder *LabelBuilder) AlignedVerticallyBy(aligner Aligner) *LabelBuilder

AlignedVerticallyBy sets the aligner for the vertical axis. Default: Center.

func (*LabelBuilder) Build 

func (builder *LabelBuilder) Build() *Label

Build creates a new Label instance from the current parameters

func (*LabelBuilder) SetBottom 

func (builder *LabelBuilder) SetBottom(value ui.Anchor) *LabelBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*LabelBuilder) SetFitToWidth 

func (builder *LabelBuilder) SetFitToWidth() *LabelBuilder

SetFitToWidth has the label always fit its text into the width.

func (*LabelBuilder) SetLeft 

func (builder *LabelBuilder) SetLeft(value ui.Anchor) *LabelBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*LabelBuilder) SetParent 

func (builder *LabelBuilder) SetParent(parent *ui.Area) *LabelBuilder

SetParent sets the parent area.

func (*LabelBuilder) SetRight 

func (builder *LabelBuilder) SetRight(value ui.Anchor) *LabelBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*LabelBuilder) SetScale 

func (builder *LabelBuilder) SetScale(value float32) *LabelBuilder

SetScale sets the scaling factor of the text. Default: 1.0

func (*LabelBuilder) SetTop 

func (builder *LabelBuilder) SetTop(value ui.Anchor) *LabelBuilder

SetTop sets the top anchor. Default: ZeroAnchor

type SelectionChangeHandler 

type SelectionChangeHandler func(item ComboBoxItem)

SelectionChangeHandler is a callback for notifying the current selection.

type Slider 

type Slider struct {
	// contains filtered or unexported fields
}

Slider is a control for selecting a numerical value with a slider.

func (*Slider) Dispose 

func (slider *Slider) Dispose()

Dispose releases all resources and removes the area from the tree.

func (*Slider) SetRange 

func (slider *Slider) SetRange(min, max int64)

SetRange sets the minimum and maximum of valid values.

func (*Slider) SetValue 

func (slider *Slider) SetValue(value int64)

SetValue updates the current value.

func (*Slider) SetValueFormatter 

func (slider *Slider) SetValueFormatter(formatter SliderValueFormatter)

SetValueFormatter sets the formatter to use. nil resets to default.

func (*Slider) SetValueUndefined 

func (slider *Slider) SetValueUndefined()

SetValueUndefined clears the current value.

type SliderBuilder 

type SliderBuilder struct {
	// contains filtered or unexported fields
}

SliderBuilder is a builder for Slider instances.

func NewSliderBuilder 

func NewSliderBuilder(labelBuilder *LabelBuilder, rectRenderer *graphics.RectangleRenderer) *SliderBuilder

NewSliderBuilder returns a new SliderBuilder instance.

func (*SliderBuilder) Build 

func (builder *SliderBuilder) Build() *Slider

Build creates a new Slider instance from the current parameters.

func (*SliderBuilder) SetBottom 

func (builder *SliderBuilder) SetBottom(value ui.Anchor) *SliderBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*SliderBuilder) SetLeft 

func (builder *SliderBuilder) SetLeft(value ui.Anchor) *SliderBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*SliderBuilder) SetParent 

func (builder *SliderBuilder) SetParent(parent *ui.Area) *SliderBuilder

SetParent sets the parent area.

func (*SliderBuilder) SetRight 

func (builder *SliderBuilder) SetRight(value ui.Anchor) *SliderBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*SliderBuilder) SetTop 

func (builder *SliderBuilder) SetTop(value ui.Anchor) *SliderBuilder

SetTop sets the top anchor. Default: ZeroAnchor

func (*SliderBuilder) WithRange 

func (builder *SliderBuilder) WithRange(valueMin, valueMax int64) *SliderBuilder

WithRange sets the allowed range of the slider.

func (*SliderBuilder) WithSliderChangeHandler 

func (builder *SliderBuilder) WithSliderChangeHandler(handler SliderChangeHandler) *SliderBuilder

WithSliderChangeHandler sets the handler for a value change.

type SliderChangeHandler 

type SliderChangeHandler func(value int64)

SliderChangeHandler is a callback for notifying the current value.

type SliderValueFormatter 

type SliderValueFormatter func(value int64) string

SliderValueFormatter creates a text representation for the current value.

type TextButton 

type TextButton struct {
	// contains filtered or unexported fields
}

TextButton is a button with a text label on it.

func (*TextButton) Dispose 

func (button *TextButton) Dispose()

Dispose releases all resources.

type TextButtonBuilder 

type TextButtonBuilder struct {
	// contains filtered or unexported fields
}

TextButtonBuilder is a builder for TextButton instances.

func NewTextButtonBuilder 

func NewTextButtonBuilder(labelBuilder *LabelBuilder, rectRenderer *graphics.RectangleRenderer) *TextButtonBuilder

NewTextButtonBuilder returns a new TextButtonBuilder instance.

func (*TextButtonBuilder) Build 

func (builder *TextButtonBuilder) Build() *TextButton

Build creates a new TextButton instance from the current parameters.

func (*TextButtonBuilder) OnAction 

func (builder *TextButtonBuilder) OnAction(handler ActionHandler) *TextButtonBuilder

OnAction sets the action handler of the new button.

func (*TextButtonBuilder) SetBottom 

func (builder *TextButtonBuilder) SetBottom(value ui.Anchor) *TextButtonBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*TextButtonBuilder) SetLeft 

func (builder *TextButtonBuilder) SetLeft(value ui.Anchor) *TextButtonBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*TextButtonBuilder) SetParent 

func (builder *TextButtonBuilder) SetParent(parent *ui.Area) *TextButtonBuilder

SetParent sets the parent area.

func (*TextButtonBuilder) SetRight 

func (builder *TextButtonBuilder) SetRight(value ui.Anchor) *TextButtonBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*TextButtonBuilder) SetTop 

func (builder *TextButtonBuilder) SetTop(value ui.Anchor) *TextButtonBuilder

SetTop sets the top anchor. Default: ZeroAnchor

func (*TextButtonBuilder) WithIdleColor 

func (builder *TextButtonBuilder) WithIdleColor(color graphics.Color) *TextButtonBuilder

WithIdleColor sets the idle background color.

func (*TextButtonBuilder) WithPreparedColor 

func (builder *TextButtonBuilder) WithPreparedColor(color graphics.Color) *TextButtonBuilder

WithPreparedColor sets the background color for the prepared state.

func (*TextButtonBuilder) WithText 

func (builder *TextButtonBuilder) WithText(value string) *TextButtonBuilder

WithText sets the label text to be used for the new button.

type TextChangeRequestHandler 

type TextChangeRequestHandler func(string)

TextChangeRequestHandler requests to change the text from within the label.

type TextureProvider 

type TextureProvider func() []*graphics.BitmapTexture

TextureProvider returns the textures available to the selector.

type TextureSelectionChangeHandler 

type TextureSelectionChangeHandler func(index int)

TextureSelectionChangeHandler is the type of the callback for changed selections.

type TextureSelector 

type TextureSelector struct {
	// contains filtered or unexported fields
}

TextureSelector is a graphical selection tool for textures.

func (*TextureSelector) DisplaySelectedIndex 

func (selector *TextureSelector) DisplaySelectedIndex()

DisplaySelectedIndex sets the first displayed index to the currently selected item.

func (*TextureSelector) Dispose 

func (selector *TextureSelector) Dispose()

Dispose releases all current resources.

func (*TextureSelector) SetSelectedIndex 

func (selector *TextureSelector) SetSelectedIndex(index int)

SetSelectedIndex updates the currently selected item. The change handler will no be called.

type TextureSelectorBuilder 

type TextureSelectorBuilder struct {
	// contains filtered or unexported fields
}

TextureSelectorBuilder creates new instances of a TextureSelector.

func NewTextureSelectorBuilder 

func NewTextureSelectorBuilder(rectangleRenderer *graphics.RectangleRenderer, textureRenderer graphics.TextureRenderer) *TextureSelectorBuilder

NewTextureSelectorBuilder returns a new instance of a TextureSelectorBuilder.

func (*TextureSelectorBuilder) Build 

func (builder *TextureSelectorBuilder) Build() *TextureSelector

Build creates a new TextureSelector instance from the current parameters.

func (*TextureSelectorBuilder) SetBottom 

func (builder *TextureSelectorBuilder) SetBottom(value ui.Anchor) *TextureSelectorBuilder

SetBottom sets the bottom anchor. Default: ZeroAnchor

func (*TextureSelectorBuilder) SetLeft 

func (builder *TextureSelectorBuilder) SetLeft(value ui.Anchor) *TextureSelectorBuilder

SetLeft sets the left anchor. Default: ZeroAnchor

func (*TextureSelectorBuilder) SetParent 

func (builder *TextureSelectorBuilder) SetParent(parent *ui.Area) *TextureSelectorBuilder

SetParent sets the parent area.

func (*TextureSelectorBuilder) SetRight 

func (builder *TextureSelectorBuilder) SetRight(value ui.Anchor) *TextureSelectorBuilder

SetRight sets the right anchor. Default: ZeroAnchor

func (*TextureSelectorBuilder) SetTop 

func (builder *TextureSelectorBuilder) SetTop(value ui.Anchor) *TextureSelectorBuilder

SetTop sets the top anchor. Default: ZeroAnchor

func (*TextureSelectorBuilder) WithProvider 

func (builder *TextureSelectorBuilder) WithProvider(provider TextureProvider) *TextureSelectorBuilder

WithProvider sets the provider of textures

func (*TextureSelectorBuilder) WithSelectionChangeHandler 

func (builder *TextureSelectorBuilder) WithSelectionChangeHandler(handler TextureSelectionChangeHandler) *TextureSelectorBuilder

WithSelectionChangeHandler registers the callback for a changed selection.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.