widget

package
v1.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 19, 2019 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Overview

Package widget defines the UI widgets within the Fyne toolkit

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DestroyRenderer 

func DestroyRenderer(wid fyne.Widget)

DestroyRenderer frees a render implementation for a widget. This is typically for internal use only.

func Refresh 

func Refresh(wid fyne.Widget)

Refresh instructs the containing canvas to refresh the specified widget.

func Renderer 

func Renderer(wid fyne.Widget) fyne.WidgetRenderer

Renderer looks up the render implementation for a widget

Types

type Box 

type Box struct {
	Horizontal bool
	Children   []fyne.CanvasObject
	// contains filtered or unexported fields
}

Box widget is a simple list where the child elements are arranged in a single column for vertical or a single row for horizontal arrangement

func NewHBox 

func NewHBox(children ...fyne.CanvasObject) *Box

NewHBox creates a new horizontally aligned box widget with the specified list of child objects

func NewVBox 

func NewVBox(children ...fyne.CanvasObject) *Box

NewVBox creates a new vertically aligned box widget with the specified list of child objects

func (*Box) Append 

func (b *Box) Append(object fyne.CanvasObject)

Append adds a new CanvasObject to the end/right of the box

func (*Box) ApplyTheme 

func (b *Box) ApplyTheme()

ApplyTheme updates this box to match the current theme

func (*Box) CreateRenderer 

func (b *Box) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Box) Hide 

func (b *Box) Hide()

Hide this widget, if it was previously visible

func (*Box) MinSize 

func (b *Box) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Box) Move 

func (b *Box) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Box) Position 

func (w *Box) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Box) Prepend 

func (b *Box) Prepend(object fyne.CanvasObject)

Prepend inserts a new CanvasObject at the top/left of the box

func (*Box) Resize 

func (b *Box) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Box) Show 

func (b *Box) Show()

Show this widget, if it was previously hidden

func (*Box) Size 

func (w *Box) Size() fyne.Size

Get the current size of this widget.

func (*Box) Visible 

func (w *Box) Visible() bool

type Button 

type Button struct {
	Text  string
	Style ButtonStyle
	Icon  fyne.Resource

	OnTapped func() `json:"-"`
	// contains filtered or unexported fields
}

Button widget has a text label and triggers an event func when clicked

func NewButton 

func NewButton(label string, tapped func()) *Button

NewButton creates a new button widget with the set label and tap handler

func NewButtonWithIcon 

func NewButtonWithIcon(label string, icon fyne.Resource, tapped func()) *Button

NewButtonWithIcon creates a new button widget with the specified label, themed icon and tap handler

func (*Button) CreateRenderer 

func (b *Button) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Button) Hide 

func (b *Button) Hide()

Hide this widget, if it was previously visible

func (*Button) MinSize 

func (b *Button) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Button) Move 

func (b *Button) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Button) Position 

func (w *Button) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Button) Resize 

func (b *Button) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Button) SetIcon 

func (b *Button) SetIcon(icon fyne.Resource)

SetIcon updates the icon on a label - pass nil to hide an icon

func (*Button) SetText 

func (b *Button) SetText(text string)

SetText allows the button label to be changed

func (*Button) Show 

func (b *Button) Show()

Show this widget, if it was previously hidden

func (*Button) Size 

func (w *Button) Size() fyne.Size

Get the current size of this widget.

func (*Button) Tapped 

func (b *Button) Tapped(*fyne.PointEvent)

Tapped is called when a pointer tapped event is captured and triggers any tap handler

func (*Button) TappedSecondary 

func (b *Button) TappedSecondary(*fyne.PointEvent)

TappedSecondary is called when a secondary pointer tapped event is captured

func (*Button) Visible 

func (w *Button) Visible() bool

type ButtonStyle 

type ButtonStyle int

ButtonStyle determines the behaviour and rendering of a button. 

const (
	// DefaultButton is the standard button style
	DefaultButton ButtonStyle = iota
	// PrimaryButton that should be more prominent to the user
	PrimaryButton
)

type Check 

type Check struct {
	Text    string
	Checked bool

	OnChanged func(bool) `json:"-"`
	// contains filtered or unexported fields
}

Check widget has a text label and a checked (or unchecked) icon and triggers an event func when toggled

func NewCheck 

func NewCheck(label string, changed func(bool)) *Check

NewCheck creates a new check widget with the set label and change handler

func (*Check) CreateRenderer 

func (c *Check) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Check) Hide 

func (c *Check) Hide()

Hide this widget, if it was previously visible

func (*Check) MinSize 

func (c *Check) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Check) Move 

func (c *Check) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Check) Position 

func (w *Check) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Check) Resize 

func (c *Check) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Check) SetChecked 

func (c *Check) SetChecked(checked bool)

SetChecked sets the the checked state and refreshes widget

func (*Check) Show 

func (c *Check) Show()

Show this widget, if it was previously hidden

func (*Check) Size 

func (w *Check) Size() fyne.Size

Get the current size of this widget.

func (*Check) Tapped 

func (c *Check) Tapped(*fyne.PointEvent)

Tapped is called when a pointer tapped event is captured and triggers any change handler

func (*Check) TappedSecondary 

func (c *Check) TappedSecondary(*fyne.PointEvent)

TappedSecondary is called when a secondary pointer tapped event is captured

func (*Check) Visible 

func (w *Check) Visible() bool

type Entry 

type Entry struct {
	Text        string
	PlaceHolder string
	OnChanged   func(string) `json:"-"`
	Password    bool
	ReadOnly    bool
	MultiLine   bool

	CursorRow, CursorColumn int
	// contains filtered or unexported fields
}

Entry widget allows simple text to be input when focused.

func NewEntry 

func NewEntry() *Entry

NewEntry creates a new single line entry widget.

func NewMultiLineEntry 

func NewMultiLineEntry() *Entry

NewMultiLineEntry creates a new entry that allows multiple lines

func NewPasswordEntry 

func NewPasswordEntry() *Entry

NewPasswordEntry creates a new entry password widget

func (*Entry) CreateRenderer 

func (e *Entry) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Entry) FocusGained 

func (e *Entry) FocusGained()

FocusGained is called when the Entry has been given focus.

func (*Entry) FocusLost 

func (e *Entry) FocusLost()

FocusLost is called when the Entry has had focus removed.

func (*Entry) Focused 

func (e *Entry) Focused() bool

Focused returns whether or not this Entry has focus.

func (*Entry) Hide 

func (e *Entry) Hide()

Hide this widget, if it was previously visible

func (*Entry) MinSize 

func (e *Entry) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Entry) Move 

func (e *Entry) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Entry) Position 

func (w *Entry) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Entry) Resize 

func (e *Entry) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Entry) SetPlaceHolder 

func (e *Entry) SetPlaceHolder(text string)

SetPlaceHolder sets the text that will be displayed if the entry is otherwise empty

func (*Entry) SetReadOnly 

func (e *Entry) SetReadOnly(ro bool)

SetReadOnly sets whether or not the Entry should not be editable

func (*Entry) SetText 

func (e *Entry) SetText(text string)

SetText manually sets the text of the Entry to the given text value.

func (*Entry) Show 

func (e *Entry) Show()

Show this widget, if it was previously hidden

func (*Entry) Size 

func (w *Entry) Size() fyne.Size

Get the current size of this widget.

func (*Entry) TypedKey 

func (e *Entry) TypedKey(key *fyne.KeyEvent)

TypedKey receives key input events when the Entry widget is focused.

func (*Entry) TypedRune 

func (e *Entry) TypedRune(r rune)

TypedRune receives text input events when the Entry widget is focused.

func (*Entry) TypedShortcut 

func (e *Entry) TypedShortcut(shortcut fyne.Shortcut) bool

TypedShortcut implements the Shortcutable interface

func (*Entry) Visible 

func (w *Entry) Visible() bool

type Form 

type Form struct {
	Items    []*FormItem
	OnSubmit func()
	OnCancel func()
	// contains filtered or unexported fields
}

Form widget is two column grid where each row has a label and a widget (usually an input). The last row of the grid will contain the appropriate form control buttons if any should be shown. Setting OnSubmit will set the submit button to be visible and call back the function when tapped. Setting OnCancel will do the same for a cancel button.

func NewForm 

func NewForm(items ...*FormItem) *Form

NewForm creates a new form widget with the specified rows of form items and (if any of them should be shown) a form controls row at the bottom

func (*Form) Append 

func (f *Form) Append(text string, widget fyne.CanvasObject)

Append adds a new row to the form, using the text as a label next to the specified Widget

func (*Form) AppendItem 

func (f *Form) AppendItem(item *FormItem)

AppendItem adds the specified row to the end of the Form

func (*Form) CreateRenderer 

func (f *Form) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Form) Hide 

func (f *Form) Hide()

Hide this widget, if it was previously visible

func (*Form) MinSize 

func (f *Form) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Form) Move 

func (f *Form) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Form) Position 

func (w *Form) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Form) Resize 

func (f *Form) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Form) Show 

func (f *Form) Show()

Show this widget, if it was previously hidden

func (*Form) Size 

func (w *Form) Size() fyne.Size

Get the current size of this widget.

func (*Form) Visible 

func (w *Form) Visible() bool

type FormItem 

type FormItem struct {
	Text   string
	Widget fyne.CanvasObject
}

FormItem provides the details for a row in a form

type Group 

type Group struct {
	Text string
	// contains filtered or unexported fields
}

Group widget is list of widgets that contains a visual border around the list and a group title at the top.

func NewGroup 

func NewGroup(title string, children ...fyne.CanvasObject) *Group

NewGroup creates a new grouped list widget with a title and the specified list of child objects.

func NewGroupWithScroller 

func NewGroupWithScroller(title string, children ...fyne.CanvasObject) *Group

NewGroupWithScroller creates a new grouped list widget with a title and the specified list of child objects. This group will scroll when the available space is less than needed to display the items it contains.

func (*Group) Append 

func (g *Group) Append(object fyne.CanvasObject)

Append adds a new CanvasObject to the end of the group

func (*Group) CreateRenderer 

func (g *Group) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Group) Hide 

func (g *Group) Hide()

Hide this widget, if it was previously visible

func (*Group) MinSize 

func (g *Group) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Group) Move 

func (g *Group) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Group) Position 

func (w *Group) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Group) Prepend 

func (g *Group) Prepend(object fyne.CanvasObject)

Prepend inserts a new CanvasObject at the top of the group

func (*Group) Resize 

func (g *Group) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Group) Show 

func (g *Group) Show()

Show this widget, if it was previously hidden

func (*Group) Size 

func (w *Group) Size() fyne.Size

Get the current size of this widget.

func (*Group) Visible 

func (w *Group) Visible() bool
type Hyperlink struct {
	Text      string
	URL       *url.URL
	Alignment fyne.TextAlign // The alignment of the Text
	TextStyle fyne.TextStyle // The style of the hyperlink text
	// contains filtered or unexported fields
}

Hyperlink widget is a text component with appropriate padding and layout. When clicked, the default web browser should open with a URL 

func NewHyperlink(text string, url *url.URL) *Hyperlink

NewHyperlink creates a new hyperlink widget with the set text content

func NewHyperlinkWithStyle 

func NewHyperlinkWithStyle(text string, url *url.URL, alignment fyne.TextAlign, style fyne.TextStyle) *Hyperlink

NewHyperlinkWithStyle creates a new hyperlink widget with the set text content

func (*Hyperlink) CreateRenderer 

func (hl *Hyperlink) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Hyperlink) Hide 

func (hl *Hyperlink) Hide()

Hide this widget, if it was previously visible

func (*Hyperlink) MinSize 

func (hl *Hyperlink) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Hyperlink) Move 

func (hl *Hyperlink) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Hyperlink) Resize 

func (hl *Hyperlink) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Hyperlink) SetText 

func (hl *Hyperlink) SetText(text string)

SetText sets the text of the hyperlink

func (*Hyperlink) SetURL 

func (hl *Hyperlink) SetURL(url *url.URL)

SetURL sets the URL of the hyperlink, taking in a URL type

func (*Hyperlink) SetURLFromString 

func (hl *Hyperlink) SetURLFromString(str string) error

SetURLFromString sets the URL of the hyperlink, taking in a string type

func (*Hyperlink) Show 

func (hl *Hyperlink) Show()

Show this widget, if it was previously hidden

func (*Hyperlink) String 

func (t *Hyperlink) String() string

String returns the text widget buffer as string

func (*Hyperlink) Tapped 

func (hl *Hyperlink) Tapped(*fyne.PointEvent)

Tapped is called when a pointer tapped event is captured and triggers any change handler

func (*Hyperlink) TappedSecondary 

func (hl *Hyperlink) TappedSecondary(*fyne.PointEvent)

TappedSecondary is called when a secondary pointer tapped event is captured

type Icon 

type Icon struct {
	Resource fyne.Resource // The resource for this icon
	// contains filtered or unexported fields
}

Icon widget is a basic image component that load's its resource to match the theme.

func NewIcon 

func NewIcon(res fyne.Resource) *Icon

NewIcon returns a new icon widget that displays a themed icon resource

func (*Icon) CreateRenderer 

func (i *Icon) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Icon) Hide 

func (i *Icon) Hide()

Hide this widget, if it was previously visible

func (*Icon) MinSize 

func (i *Icon) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Icon) Move 

func (i *Icon) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Icon) Position 

func (w *Icon) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Icon) Resize 

func (i *Icon) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Icon) SetResource 

func (i *Icon) SetResource(res fyne.Resource)

SetResource updates the resource rendered in this icon widget

func (*Icon) Show 

func (i *Icon) Show()

Show this widget, if it was previously hidden

func (*Icon) Size 

func (w *Icon) Size() fyne.Size

Get the current size of this widget.

func (*Icon) Visible 

func (w *Icon) Visible() bool

type Label 

type Label struct {
	Text      string
	Alignment fyne.TextAlign // The alignment of the Text
	TextStyle fyne.TextStyle // The style of the label text
	// contains filtered or unexported fields
}

Label widget is a label component with appropriate padding and layout.

func NewLabel 

func NewLabel(text string) *Label

NewLabel creates a new label widget with the set text content

func NewLabelWithStyle 

func NewLabelWithStyle(text string, alignment fyne.TextAlign, style fyne.TextStyle) *Label

NewLabelWithStyle creates a new label widget with the set text content

func (*Label) CreateRenderer 

func (l *Label) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Label) Hide 

func (l *Label) Hide()

Hide this widget, if it was previously visible

func (*Label) MinSize 

func (l *Label) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Label) Move 

func (l *Label) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Label) Resize 

func (l *Label) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Label) SetText 

func (l *Label) SetText(text string)

SetText sets the text of the label

func (*Label) Show 

func (l *Label) Show()

Show this widget, if it was previously hidden

func (*Label) String 

func (t *Label) String() string

String returns the text widget buffer as string

type ProgressBar 

type ProgressBar struct {
	Min, Max, Value float64
	// contains filtered or unexported fields
}

ProgressBar widget creates a horizontal panel that indicates progress

func NewProgressBar 

func NewProgressBar() *ProgressBar

NewProgressBar creates a new progress bar widget. The default Min is 0 and Max is 1, Values set should be between those numbers. The display will convert this to a percentage.

func (*ProgressBar) CreateRenderer 

func (p *ProgressBar) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*ProgressBar) Hide 

func (p *ProgressBar) Hide()

Hide this widget, if it was previously visible

func (*ProgressBar) MinSize 

func (p *ProgressBar) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*ProgressBar) Move 

func (p *ProgressBar) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ProgressBar) Position 

func (w *ProgressBar) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*ProgressBar) Resize 

func (p *ProgressBar) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ProgressBar) SetValue 

func (p *ProgressBar) SetValue(v float64)

SetValue changes the current value of this progress bar (from p.Min to p.Max). The widget will be refreshed to indicate the change.

func (*ProgressBar) Show 

func (p *ProgressBar) Show()

Show this widget, if it was previously hidden

func (*ProgressBar) Size 

func (w *ProgressBar) Size() fyne.Size

Get the current size of this widget.

func (*ProgressBar) Visible 

func (w *ProgressBar) Visible() bool

type ProgressBarInfinite 

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

ProgressBarInfinite widget creates a horizontal panel that indicates waiting indefinitely An infinite progress bar loops 0% -> 100% repeatedly until Stop() is called

func NewProgressBarInfinite 

func NewProgressBarInfinite() *ProgressBarInfinite

NewProgressBarInfinite creates a new progress bar widget that loops indefinitely from 0% -> 100% SetValue() is not defined for infinite progress bar To stop the looping progress and set the progress bar to 100%, call ProgressBarInfinite.Stop()

func (*ProgressBarInfinite) CreateRenderer 

func (p *ProgressBarInfinite) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*ProgressBarInfinite) Hide 

func (p *ProgressBarInfinite) Hide()

Hide this widget, if it was previously visible

func (*ProgressBarInfinite) MinSize 

func (p *ProgressBarInfinite) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*ProgressBarInfinite) Move 

func (p *ProgressBarInfinite) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ProgressBarInfinite) Position 

func (w *ProgressBarInfinite) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*ProgressBarInfinite) Resize 

func (p *ProgressBarInfinite) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ProgressBarInfinite) Running 

func (p *ProgressBarInfinite) Running() bool

Running returns the current state of the infinite progress animation

func (*ProgressBarInfinite) Show 

func (p *ProgressBarInfinite) Show()

Show this widget, if it was previously hidden

func (*ProgressBarInfinite) Size 

func (w *ProgressBarInfinite) Size() fyne.Size

Get the current size of this widget.

func (*ProgressBarInfinite) Start 

func (p *ProgressBarInfinite) Start()

Start the infinite progress bar background thread to update it continuously

func (*ProgressBarInfinite) Stop 

func (p *ProgressBarInfinite) Stop()

Stop the infinite progress goroutine and sets value to the Max

func (*ProgressBarInfinite) Visible 

func (w *ProgressBarInfinite) Visible() bool

type Radio 

type Radio struct {
	Options  []string
	Selected string

	OnChanged func(string) `json:"-"`
	// contains filtered or unexported fields
}

Radio widget has a list of text labels and radio check icons next to each. Changing the selection (only one can be selected) will trigger the changed func.

func NewRadio 

func NewRadio(options []string, changed func(string)) *Radio

NewRadio creates a new radio widget with the set options and change handler

func (*Radio) CreateRenderer 

func (r *Radio) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Radio) Hide 

func (r *Radio) Hide()

Hide this widget, if it was previously visible

func (*Radio) MinSize 

func (r *Radio) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Radio) Move 

func (r *Radio) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Radio) Position 

func (w *Radio) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Radio) Resize 

func (r *Radio) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Radio) Show 

func (r *Radio) Show()

Show this widget, if it was previously hidden

func (*Radio) Size 

func (w *Radio) Size() fyne.Size

Get the current size of this widget.

func (*Radio) Tapped 

func (r *Radio) Tapped(event *fyne.PointEvent)

Tapped is called when a pointer tapped event is captured and triggers any change handler

func (*Radio) TappedSecondary 

func (r *Radio) TappedSecondary(*fyne.PointEvent)

TappedSecondary is called when a secondary pointer tapped event is captured

func (*Radio) Visible 

func (w *Radio) Visible() bool

type ScrollContainer 

type ScrollContainer struct {
	Content fyne.CanvasObject
	Offset  fyne.Position
	// contains filtered or unexported fields
}

ScrollContainer defines a container that is smaller than the Content. The Offset is used to determine the position of the child widgets within the container.

func NewScrollContainer 

func NewScrollContainer(content fyne.CanvasObject) *ScrollContainer

NewScrollContainer creates a scrollable parent wrapping the specified content. Note that this may cause the MinSize to be smaller than that of the passed objects.

func (*ScrollContainer) CreateRenderer 

func (s *ScrollContainer) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*ScrollContainer) Hide 

func (s *ScrollContainer) Hide()

Hide this widget, if it was previously visible

func (*ScrollContainer) MinSize 

func (s *ScrollContainer) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*ScrollContainer) Move 

func (s *ScrollContainer) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ScrollContainer) Position 

func (w *ScrollContainer) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*ScrollContainer) Resize 

func (s *ScrollContainer) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*ScrollContainer) Scrolled 

func (s *ScrollContainer) Scrolled(ev *fyne.ScrollEvent)

Scrolled is called when an input device triggers a scroll event

func (*ScrollContainer) Show 

func (s *ScrollContainer) Show()

Show this widget, if it was previously hidden

func (*ScrollContainer) Size 

func (w *ScrollContainer) Size() fyne.Size

Get the current size of this widget.

func (*ScrollContainer) Visible 

func (w *ScrollContainer) Visible() bool

type TabContainer 

type TabContainer struct {
	Items []*TabItem
	// contains filtered or unexported fields
}

TabContainer widget allows switching visible content from a list of TabItems. Each item is represented by a button at the top of the widget.

func NewTabContainer 

func NewTabContainer(items ...*TabItem) *TabContainer

NewTabContainer creates a new tab bar widget that allows the user to choose between different visible containers

func (*TabContainer) CreateRenderer 

func (t *TabContainer) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*TabContainer) CurrentTab 

func (t *TabContainer) CurrentTab() *TabItem

CurrentTab returns the currently selected TabItem.

func (*TabContainer) CurrentTabIndex 

func (t *TabContainer) CurrentTabIndex() int

CurrentTabIndex returns the index of the currently selected TabItem.

func (*TabContainer) Hide 

func (t *TabContainer) Hide()

Hide this widget, if it was previously visible

func (*TabContainer) MinSize 

func (t *TabContainer) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*TabContainer) Move 

func (t *TabContainer) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*TabContainer) Position 

func (w *TabContainer) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*TabContainer) Resize 

func (t *TabContainer) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*TabContainer) SelectTab 

func (t *TabContainer) SelectTab(item *TabItem)

SelectTab sets the specified TabItem to be selected and it's content visible.

func (*TabContainer) SelectTabIndex 

func (t *TabContainer) SelectTabIndex(index int)

SelectTabIndex sets the TabItem at the specifie index to be selected and it's content visible.

func (*TabContainer) Show 

func (t *TabContainer) Show()

Show this widget, if it was previously hidden

func (*TabContainer) Size 

func (w *TabContainer) Size() fyne.Size

Get the current size of this widget.

func (*TabContainer) Visible 

func (w *TabContainer) Visible() bool

type TabItem 

type TabItem struct {
	Text    string
	Content fyne.CanvasObject
}

TabItem represents a single view in a TabContainer. The Text is used for the tab button and the Content is shown when the corresponding tab is active.

func NewTabItem 

func NewTabItem(text string, content fyne.CanvasObject) *TabItem

NewTabItem creates a new item for a tabbed widget - each item specifies the content an a label for it's tab.

type Toolbar 

type Toolbar struct {
	Items []ToolbarItem
	// contains filtered or unexported fields
}

Toolbar widget creates a horizontal list of tool buttons

func NewToolbar 

func NewToolbar(items ...ToolbarItem) *Toolbar

NewToolbar creates a new toolbar widget.

func (*Toolbar) Append 

func (t *Toolbar) Append(item ToolbarItem)

Append a new ToolbarItem to the end of this Toolbar

func (*Toolbar) ApplyTheme 

func (t *Toolbar) ApplyTheme()

ApplyTheme updates this widget's visuals to reflect the current theme

func (*Toolbar) CreateRenderer 

func (t *Toolbar) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to it's renderer

func (*Toolbar) Hide 

func (t *Toolbar) Hide()

Hide this widget, if it was previously visible

func (*Toolbar) MinSize 

func (t *Toolbar) MinSize() fyne.Size

MinSize returns the smallest size this widget can shrink to

func (*Toolbar) Move 

func (t *Toolbar) Move(pos fyne.Position)

Move the widget to a new position, relative to it's parent. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Toolbar) Position 

func (w *Toolbar) Position() fyne.Position

Get the current position of this widget, relative to it's parent.

func (*Toolbar) Prepend 

func (t *Toolbar) Prepend(item ToolbarItem)

Prepend a new ToolbarItem to the start of this Toolbar

func (*Toolbar) Resize 

func (t *Toolbar) Resize(size fyne.Size)

Resize sets a new size for a widget. Note this should not be used if the widget is being managed by a Layout within a Container.

func (*Toolbar) Show 

func (t *Toolbar) Show()

Show this widget, if it was previously hidden

func (*Toolbar) Size 

func (w *Toolbar) Size() fyne.Size

Get the current size of this widget.

func (*Toolbar) Visible 

func (w *Toolbar) Visible() bool

type ToolbarAction 

type ToolbarAction struct {
	Icon        fyne.Resource
	OnActivated func()
}

ToolbarAction is push button style of ToolbarItem

func (*ToolbarAction) ToolbarObject 

func (t *ToolbarAction) ToolbarObject() fyne.CanvasObject

ToolbarObject gets a button to render this ToolbarAction

type ToolbarItem 

type ToolbarItem interface {
	ToolbarObject() fyne.CanvasObject
}

ToolbarItem represents any interface element that can be added to a toolbar

func NewToolbarAction 

func NewToolbarAction(icon fyne.Resource, onActivated func()) ToolbarItem

NewToolbarAction returns a new push button style ToolbarItem

func NewToolbarSeparator 

func NewToolbarSeparator() ToolbarItem

NewToolbarSeparator returns a new separator item for a Toolbar to assist with ToolbarItem grouping

func NewToolbarSpacer 

func NewToolbarSpacer() ToolbarItem

NewToolbarSpacer returns a new spacer item for a Toolbar to assist with ToolbarItem alignment

type ToolbarSeparator 

type ToolbarSeparator struct {
}

ToolbarSeparator is a thin, visible divide that can be added to a Toolbar. This is typically used to assist visual grouping of ToolbarItems.

func (*ToolbarSeparator) ToolbarObject 

func (t *ToolbarSeparator) ToolbarObject() fyne.CanvasObject

ToolbarObject gets the visible line object for this ToolbarSeparator

type ToolbarSpacer 

type ToolbarSpacer struct {
}

ToolbarSpacer is a blank, stretchable space for a toolbar. This is typically used to assist layout if you wish some left and some right aligned items. Space will be split evebly amongst all the spacers on a toolbar.

func (*ToolbarSpacer) ToolbarObject 

func (t *ToolbarSpacer) ToolbarObject() fyne.CanvasObject

ToolbarObject gets the actual spacer object for this ToolbarSpacer

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.