widget

package
v2.7.2 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2026 License: BSD-3-Clause Imports: 38 Imported by: 2,516

Documentation

Overview

Package widget defines the UI widgets within the Fyne toolkit.

Index

Constants

This section is empty.

Variables

View Source 
var (
	// RichTextStyleBlockquote represents a quote presented in an indented block.
	//
	// Since: 2.1
	RichTextStyleBlockquote = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    false,
		SizeName:  theme.SizeNameText,
		TextStyle: fyne.TextStyle{Italic: true},
	}
	// RichTextStyleCodeBlock represents a code blog segment.
	//
	// Since: 2.1
	RichTextStyleCodeBlock = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    false,
		SizeName:  theme.SizeNameText,
		TextStyle: fyne.TextStyle{Monospace: true},
	}
	// RichTextStyleCodeInline represents an inline code segment.
	//
	// Since: 2.1
	RichTextStyleCodeInline = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    true,
		SizeName:  theme.SizeNameText,
		TextStyle: fyne.TextStyle{Monospace: true},
	}
	// RichTextStyleEmphasis represents regular text with emphasis.
	//
	// Since: 2.1
	RichTextStyleEmphasis = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    true,
		SizeName:  theme.SizeNameText,
		TextStyle: fyne.TextStyle{Italic: true},
	}
	// RichTextStyleHeading represents a heading text that stands on its own line.
	//
	// Since: 2.1
	RichTextStyleHeading = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    false,
		SizeName:  theme.SizeNameHeadingText,
		TextStyle: fyne.TextStyle{Bold: true},
	}
	// RichTextStyleInline represents standard text that can be surrounded by other elements.
	//
	// Since: 2.1
	RichTextStyleInline = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    true,
		SizeName:  theme.SizeNameText,
	}
	// RichTextStyleParagraph represents standard text that should appear separate from other text.
	//
	// Since: 2.1
	RichTextStyleParagraph = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    false,
		SizeName:  theme.SizeNameText,
	}
	// RichTextStylePassword represents standard sized text where the characters are obscured.
	//
	// Since: 2.1
	RichTextStylePassword = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    true,
		SizeName:  theme.SizeNameText,
		// contains filtered or unexported fields
	}
	// RichTextStyleStrong represents regular text with a strong emphasis.
	//
	// Since: 2.1
	RichTextStyleStrong = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    true,
		SizeName:  theme.SizeNameText,
		TextStyle: fyne.TextStyle{Bold: true},
	}
	// RichTextStyleSubHeading represents a sub-heading text that stands on its own line.
	//
	// Since: 2.1
	RichTextStyleSubHeading = RichTextStyle{
		ColorName: theme.ColorNameForeground,
		Inline:    false,
		SizeName:  theme.SizeNameSubHeadingText,
		TextStyle: fyne.TextStyle{Bold: true},
	}
)

Functions

func NewSimpleRenderer added in v2.1.0 

func NewSimpleRenderer(object fyne.CanvasObject) fyne.WidgetRenderer

NewSimpleRenderer creates a new SimpleRenderer to render a widget using a single fyne.CanvasObject.

Since: 2.1

func ShowModalPopUp 

func ShowModalPopUp(content fyne.CanvasObject, canvas fyne.Canvas)

ShowModalPopUp creates a new popUp for the specified content and displays it on the passed canvas. A modal PopUp blocks interactions with underlying elements, covered with a semi-transparent overlay.

func ShowPopUp 

func ShowPopUp(content fyne.CanvasObject, canvas fyne.Canvas)

ShowPopUp creates a new popUp for the specified content and displays it on the passed canvas.

func ShowPopUpAtPosition 

func ShowPopUpAtPosition(content fyne.CanvasObject, canvas fyne.Canvas, pos fyne.Position)

ShowPopUpAtPosition creates a new popUp for the specified content at the specified absolute position. It will then display the popup on the passed canvas.

func ShowPopUpAtRelativePosition added in v2.4.0 

func ShowPopUpAtRelativePosition(content fyne.CanvasObject, canvas fyne.Canvas, rel fyne.Position, to fyne.CanvasObject)

ShowPopUpAtRelativePosition shows a new popUp for the specified content at the given position relative to stated object. It will then display the popup on the passed canvas.

Since 2.4

func ShowPopUpMenuAtPosition 

func ShowPopUpMenuAtPosition(menu *fyne.Menu, c fyne.Canvas, pos fyne.Position)

ShowPopUpMenuAtPosition creates a PopUp menu populated with items from the passed menu structure. It will automatically be positioned at the provided location and shown as an overlay on the specified canvas.

func ShowPopUpMenuAtRelativePosition added in v2.4.0 

func ShowPopUpMenuAtRelativePosition(menu *fyne.Menu, c fyne.Canvas, rel fyne.Position, to fyne.CanvasObject)

ShowPopUpMenuAtRelativePosition creates a PopUp menu populated with menu items from the passed menu structure. It will automatically be positioned at the given position relative to stated object and shown as an overlay on the specified canvas.

Since 2.4

Types

type Accordion 

type Accordion struct {
	BaseWidget
	Items     []*AccordionItem
	MultiOpen bool
}

Accordion displays a list of AccordionItems. Each item is represented by a button that reveals a detailed view when tapped.

func NewAccordion 

func NewAccordion(items ...*AccordionItem) *Accordion

NewAccordion creates a new accordion widget.

func (*Accordion) Append 

func (a *Accordion) Append(item *AccordionItem)

Append adds the given item to this Accordion.

func (*Accordion) Close 

func (a *Accordion) Close(index int)

Close collapses the item at the given index.

func (*Accordion) CloseAll 

func (a *Accordion) CloseAll()

CloseAll collapses all items.

func (*Accordion) CreateRenderer 

func (a *Accordion) CreateRenderer() fyne.WidgetRenderer

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Accordion) MinSize 

func (a *Accordion) MinSize() fyne.Size

MinSize returns the size that this widget should not shrink below.

func (*Accordion) Open 

func (a *Accordion) Open(index int)

Open expands the item at the given index.

func (*Accordion) OpenAll 

func (a *Accordion) OpenAll()

OpenAll expands all items, note that your Accordion should have [MultiOpen] set to `true` for this to operate as expected. For single-open accordions it will open only the first item.

func (*Accordion) Prepend added in v2.6.0 

func (a *Accordion) Prepend(item *AccordionItem)

Prepend adds the given item to the beginning of this Accordion.

Since: 2.6

func (*Accordion) Remove 

func (a *Accordion) Remove(item *AccordionItem)

Remove deletes the given item from this Accordion.

func (*Accordion) RemoveIndex 

func (a *Accordion) RemoveIndex(index int)

RemoveIndex deletes the item at the given index from this Accordion.

type AccordionItem 

type AccordionItem struct {
	Title  string
	Detail fyne.CanvasObject
	Open   bool
}

AccordionItem represents a single item in an Acc rdion.

func NewAccordionItem 

func NewAccordionItem(title string, detail fyne.CanvasObject) *AccordionItem

NewAccordionItem creates a new item for an Accordion.

type Activity added in v2.5.0 

type Activity struct {
	BaseWidget
	// contains filtered or unexported fields
}

Activity is used to indicate that something is happening that should be waited for, or is in the background (depending on usage).

Since: 2.5

func NewActivity added in v2.5.0 

func NewActivity() *Activity

NewActivity returns a widget for indicating activity

Since: 2.5

func (*Activity) CreateRenderer added in v2.5.0 

func (a *Activity) CreateRenderer() fyne.WidgetRenderer

func (*Activity) MinSize added in v2.5.0 

func (a *Activity) MinSize() fyne.Size

func (*Activity) Start added in v2.5.0 

func (a *Activity) Start()

Start the activity indicator animation

func (*Activity) Stop added in v2.5.0 

func (a *Activity) Stop()

Stop the activity indicator animation

type BaseWidget 

type BaseWidget struct {
	Hidden bool
	// contains filtered or unexported fields
}

BaseWidget provides a helper that handles basic widget behaviours.

func (*BaseWidget) ExtendBaseWidget 

func (w *BaseWidget) ExtendBaseWidget(wid fyne.Widget)

ExtendBaseWidget is used by an extending widget to make use of BaseWidget functionality.

func (*BaseWidget) Hide 

func (w *BaseWidget) Hide()

Hide this widget so it is no longer visible

func (*BaseWidget) MinSize 

func (w *BaseWidget) MinSize() fyne.Size

MinSize for the widget - it should never be resized below this value.

func (*BaseWidget) Move 

func (w *BaseWidget) Move(pos fyne.Position)

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

func (*BaseWidget) Position 

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

Position gets the current position of this widget, relative to its parent.

func (*BaseWidget) Refresh 

func (w *BaseWidget) Refresh()

Refresh causes this widget to be redrawn in its current state

func (*BaseWidget) Resize 

func (w *BaseWidget) 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 (*BaseWidget) Show 

func (w *BaseWidget) Show()

Show this widget so it becomes visible

func (*BaseWidget) Size 

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

Size gets the current size of this widget.

func (*BaseWidget) Theme added in v2.5.0 

func (w *BaseWidget) Theme() fyne.Theme

Theme returns a cached Theme instance for this widget (or its extending widget). This will be the app theme in most cases, or a widget specific theme if it is inside a ThemeOverride container.

Since: 2.5

func (*BaseWidget) Visible 

func (w *BaseWidget) Visible() bool

Visible returns whether or not this widget should be visible. Note that this may not mean it is currently visible if a parent has been hidden.

type Button 

type Button struct {
	DisableableWidget
	Text string
	Icon fyne.Resource
	// Specify how prominent the button should be, High will highlight the button and Low will remove some decoration.
	//
	// Since: 1.4
	Importance    Importance
	Alignment     ButtonAlign
	IconPlacement ButtonIconPlacement

	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 its renderer

func (*Button) Cursor 

func (b *Button) Cursor() desktop.Cursor

Cursor returns the cursor type of this widget

func (*Button) FocusGained added in v2.1.0 

func (b *Button) FocusGained()

FocusGained is a hook called by the focus handling logic after this object gained the focus.

func (*Button) FocusLost added in v2.1.0 

func (b *Button) FocusLost()

FocusLost is a hook called by the focus handling logic after this object lost the focus.

func (*Button) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Button) MouseIn 

func (b *Button) MouseIn(*desktop.MouseEvent)

MouseIn is called when a desktop pointer enters the widget

func (*Button) MouseMoved 

func (b *Button) MouseMoved(*desktop.MouseEvent)

MouseMoved is called when a desktop pointer hovers over the widget

func (*Button) MouseOut 

func (b *Button) MouseOut()

MouseOut is called when a desktop pointer exits the widget

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) Tapped 

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

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

func (*Button) TypedKey added in v2.1.0 

func (b *Button) TypedKey(ev *fyne.KeyEvent)

TypedKey is a hook called by the input handling logic on key events if this object is focused.

func (*Button) TypedRune added in v2.1.0 

func (b *Button) TypedRune(rune)

TypedRune is a hook called by the input handling logic on text input events if this object is focused.

type ButtonAlign 

type ButtonAlign int

ButtonAlign represents the horizontal alignment of a button. 

const (
	// ButtonAlignCenter aligns the icon and the text centrally.
	ButtonAlignCenter ButtonAlign = iota
	// ButtonAlignLeading aligns the icon and the text with the leading edge.
	ButtonAlignLeading
	// ButtonAlignTrailing aligns the icon and the text with the trailing edge.
	ButtonAlignTrailing
)

type ButtonIconPlacement 

type ButtonIconPlacement int

ButtonIconPlacement represents the ordering of icon & text within a button. 

const (
	// ButtonIconLeadingText aligns the icon on the leading edge of the text.
	ButtonIconLeadingText ButtonIconPlacement = iota
	// ButtonIconTrailingText aligns the icon on the trailing edge of the text.
	ButtonIconTrailingText
)

type ButtonImportance deprecated 

type ButtonImportance = Importance

ButtonImportance represents how prominent the button should appear

Since: 1.4

Deprecated: Use widget.Importance instead

type ButtonStyle 

type ButtonStyle int

ButtonStyle determines the behaviour and rendering of a button.

type Calendar added in v2.6.0 

type Calendar struct {
	BaseWidget

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

Calendar creates a new date time picker which returns a time object

Since: 2.6

func NewCalendar added in v2.6.0 

func NewCalendar(cT time.Time, changed func(time.Time)) *Calendar

NewCalendar creates a calendar instance

Since: 2.6

func (*Calendar) CreateRenderer added in v2.6.0 

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

CreateRenderer returns a new WidgetRenderer for this widget. This should not be called by regular code, it is used internally to render a widget.

type Card 

type Card struct {
	BaseWidget
	Title, Subtitle string
	Image           *canvas.Image
	Content         fyne.CanvasObject
}

Card widget groups title, subtitle with content and a header image

Since: 1.4

func NewCard 

func NewCard(title, subtitle string, content fyne.CanvasObject) *Card

NewCard creates a new card widget with the specified title, subtitle and content (all optional).

Since: 1.4

func (*Card) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Card) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Card) SetContent 

func (c *Card) SetContent(obj fyne.CanvasObject)

SetContent changes the body of this card to have the specified content.

func (*Card) SetImage 

func (c *Card) SetImage(img *canvas.Image)

SetImage changes the image displayed above the title for this card.

func (*Card) SetSubTitle 

func (c *Card) SetSubTitle(text string)

SetSubTitle updates the secondary title for this card.

func (*Card) SetTitle 

func (c *Card) SetTitle(text string)

SetTitle updates the main title for this card.

type Check 

type Check struct {
	DisableableWidget
	Text    string
	Checked bool

	// Partial check is when there is an indeterminate state (usually meaning that child items are some-what checked).
	// Turning this on will override the checked state and show a dash icon (neither checked nor unchecked).
	// The user interaction cannot turn this on, tapping a partial check state will set `Checked` to true.
	//
	// Since: 2.6
	Partial 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 NewCheckWithData 

func NewCheckWithData(label string, data binding.Bool) *Check

NewCheckWithData returns a check widget connected with the specified data source.

Since: 2.0

func (*Check) Bind 

func (c *Check) Bind(data binding.Bool)

Bind connects the specified data source to this Check. The current value will be displayed and any changes in the data will cause the widget to update. User interactions with this Check will set the value into the data source.

Since: 2.0

func (*Check) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Check) FocusGained 

func (c *Check) FocusGained()

FocusGained is called when the Check has been given focus.

func (*Check) FocusLost 

func (c *Check) FocusLost()

FocusLost is called when the Check has had focus removed.

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 size that this widget should not shrink below

func (*Check) MouseIn 

func (c *Check) MouseIn(me *desktop.MouseEvent)

MouseIn is called when a desktop pointer enters the widget

func (*Check) MouseMoved 

func (c *Check) MouseMoved(me *desktop.MouseEvent)

MouseMoved is called when a desktop pointer hovers over the widget

func (*Check) MouseOut 

func (c *Check) MouseOut()

MouseOut is called when a desktop pointer exits the widget

func (*Check) SetChecked 

func (c *Check) SetChecked(checked bool)

SetChecked sets the checked state and refreshes widget If the `Partial` state is set this will be turned off to respect the `checked` bool passed in here.

func (*Check) SetText added in v2.4.0 

func (c *Check) SetText(text string)

SetText sets the text of the Check

Since: 2.4

func (*Check) Tapped 

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

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

func (*Check) TypedKey 

func (c *Check) TypedKey(key *fyne.KeyEvent)

TypedKey receives key input events when the Check is focused.

func (*Check) TypedRune 

func (c *Check) TypedRune(r rune)

TypedRune receives text input events when the Check is focused.

func (*Check) Unbind 

func (c *Check) Unbind()

Unbind disconnects any configured data source from this Check. The current value will remain at the last value of the data source.

Since: 2.0

type CheckGroup added in v2.1.0 

type CheckGroup struct {
	DisableableWidget
	Horizontal bool
	Required   bool
	OnChanged  func([]string) `json:"-"`
	Options    []string
	Selected   []string
	// contains filtered or unexported fields
}

CheckGroup widget has a list of text labels and checkbox icons next to each. Changing the selection (any number can be selected) will trigger the changed func.

Since: 2.1

func NewCheckGroup added in v2.1.0 

func NewCheckGroup(options []string, changed func([]string)) *CheckGroup

NewCheckGroup creates a new check group widget with the set options and change handler

Since: 2.1

func (*CheckGroup) Append added in v2.1.0 

func (r *CheckGroup) Append(option string)

Append adds a new option to the end of a CheckGroup widget.

func (*CheckGroup) CreateRenderer added in v2.1.0 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*CheckGroup) MinSize added in v2.1.0 

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

MinSize returns the size that this widget should not shrink below

func (*CheckGroup) Refresh added in v2.1.0 

func (r *CheckGroup) Refresh()

Refresh causes this widget to be redrawn in it's current state.

func (*CheckGroup) Remove added in v2.3.0 

func (r *CheckGroup) Remove(option string) bool

Remove removes the first occurrence of the specified option found from a CheckGroup widget. Return true if an option was removed.

Since: 2.3

func (*CheckGroup) SetSelected added in v2.1.0 

func (r *CheckGroup) SetSelected(options []string)

SetSelected sets the checked options, it can be used to set a default option.

type CustomTextGridStyle 

type CustomTextGridStyle struct {
	// Since: 2.5
	TextStyle        fyne.TextStyle
	FGColor, BGColor color.Color
}

CustomTextGridStyle is a utility type for those not wanting to define their own style types.

func (*CustomTextGridStyle) BackgroundColor 

func (c *CustomTextGridStyle) BackgroundColor() color.Color

BackgroundColor is the color a cell should use for the background.

func (*CustomTextGridStyle) Style added in v2.5.0 

func (c *CustomTextGridStyle) Style() fyne.TextStyle

Style is the text style a cell should use.

func (*CustomTextGridStyle) TextColor 

func (c *CustomTextGridStyle) TextColor() color.Color

TextColor is the color a cell should use for the text.

type DateEntry added in v2.6.0 

type DateEntry struct {
	Entry
	Date      *time.Time
	OnChanged func(*time.Time) `json:"-"`
	// contains filtered or unexported fields
}

DateEntry is an input field which supports selecting from a fixed set of options.

Since: 2.6

func NewDateEntry added in v2.6.0 

func NewDateEntry() *DateEntry

NewDateEntry creates a date input where the date can be selected or typed.

Since: 2.6

func (*DateEntry) CreateRenderer added in v2.6.0 

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

CreateRenderer returns a new renderer for this select entry.

func (*DateEntry) Disable added in v2.6.0 

func (e *DateEntry) Disable()

Disable this widget so that it cannot be interacted with, updating any style appropriately.

func (*DateEntry) Enable added in v2.6.0 

func (e *DateEntry) Enable()

Enable this widget, updating any style or features appropriately.

func (*DateEntry) MinSize added in v2.6.0 

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

MinSize returns the minimal size of the select entry.

func (*DateEntry) Move added in v2.6.0 

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

Move changes the relative position of the date entry.

func (*DateEntry) Resize added in v2.6.0 

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

Resize changes the size of the date entry.

func (*DateEntry) SetDate added in v2.6.0 

func (e *DateEntry) SetDate(d *time.Time)

SetDate will update the widget to a specific date. You can pass nil to unselect a date.

type DisableableWidget 

type DisableableWidget struct {
	BaseWidget
	// contains filtered or unexported fields
}

DisableableWidget describes an extension to BaseWidget which can be disabled. Disabled widgets should have a visually distinct style when disabled, normally using theme.DisabledButtonColor.

func (*DisableableWidget) Disable 

func (w *DisableableWidget) Disable()

Disable this widget so that it cannot be interacted with, updating any style appropriately.

func (*DisableableWidget) Disabled 

func (w *DisableableWidget) Disabled() bool

Disabled returns true if this widget is currently disabled or false if it can currently be interacted with.

func (*DisableableWidget) Enable 

func (w *DisableableWidget) Enable()

Enable this widget, updating any style or features appropriately.

type Entry 

type Entry struct {
	DisableableWidget

	Text string
	// Since: 2.0
	TextStyle   fyne.TextStyle
	PlaceHolder string
	OnChanged   func(string) `json:"-"`
	// Since: 2.0
	OnSubmitted func(string) `json:"-"`
	Password    bool
	MultiLine   bool
	Wrapping    fyne.TextWrap

	// Scroll can be used to turn off the scrolling of our entry when Wrapping is WrapNone.
	//
	// Since: 2.4
	Scroll fyne.ScrollDirection

	// Set a validator that this entry will check against
	// Since: 1.4
	Validator fyne.StringValidator `json:"-"`

	// If true, the Validator runs automatically on render without user interaction.
	// It will reflect any validation errors found or those explicitly set via SetValidationError().
	// Since: 2.7
	AlwaysShowValidationError bool

	CursorRow, CursorColumn int
	OnCursorChanged         func() `json:"-"`

	// Icon is displayed at the outer left of the entry.
	// It is not clickable, but can be used to indicate the purpose of the entry.
	// Since: 2.7
	Icon fyne.Resource `json:"-"`

	// ActionItem is a small item which is displayed at the outer right of the entry (like a password revealer)
	ActionItem fyne.CanvasObject `json:"-"`
	// 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 NewEntryWithData 

func NewEntryWithData(data binding.String) *Entry

NewEntryWithData returns an Entry widget connected to the specified data source.

Since: 2.0

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) AcceptsTab added in v2.1.0 

func (e *Entry) AcceptsTab() bool

AcceptsTab returns if Entry accepts the Tab key or not.

Since: 2.1

func (*Entry) Append added in v2.4.0 

func (e *Entry) Append(text string)

Append appends the text to the end of the entry.

Since: 2.4

func (*Entry) Bind 

func (e *Entry) Bind(data binding.String)

Bind connects the specified data source to this Entry. The current value will be displayed and any changes in the data will cause the widget to update. User interactions with this Entry will set the value into the data source.

Since: 2.0

func (*Entry) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Entry) Cursor 

func (e *Entry) Cursor() desktop.Cursor

Cursor returns the cursor type of this widget

func (*Entry) CursorPosition added in v2.7.0 

func (e *Entry) CursorPosition() fyne.Position

CursorPosition returns the relative position of this Entry widget's cursor.

Since: 2.7

func (*Entry) CursorTextOffset added in v2.7.0 

func (e *Entry) CursorTextOffset() (pos int)

CursorTextOffset returns how many runes into the source text the cursor is positioned at.

Since: 2.7

func (*Entry) DoubleTapped 

func (e *Entry) DoubleTapped(_ *fyne.PointEvent)

DoubleTapped is called when this entry has been double tapped so we should select text below the pointer

func (*Entry) DragEnd 

func (e *Entry) DragEnd()

DragEnd is called at end of a drag event.

func (*Entry) Dragged 

func (e *Entry) Dragged(d *fyne.DragEvent)

Dragged is called when the pointer moves while a button is held down. It updates the selection accordingly.

func (*Entry) ExtendBaseWidget 

func (e *Entry) ExtendBaseWidget(wid fyne.Widget)

ExtendBaseWidget is used by an extending widget to make use of BaseWidget functionality.

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) Hide 

func (e *Entry) Hide()

Hide hides the entry.

func (*Entry) KeyDown 

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

KeyDown handler for keypress events - used to store shift modifier state for text selection

func (*Entry) KeyUp 

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

KeyUp handler for key release events - used to reset shift modifier state for text selection

func (*Entry) Keyboard 

func (e *Entry) Keyboard() mobile.KeyboardType

Keyboard implements the Keyboardable interface

func (*Entry) MinSize 

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

MinSize returns the size that this widget should not shrink below.

func (*Entry) MouseDown 

func (e *Entry) MouseDown(m *desktop.MouseEvent)

MouseDown called on mouse click, this triggers a mouse click which can move the cursor, update the existing selection (if shift is held), or start a selection dragging operation.

func (*Entry) MouseUp 

func (e *Entry) MouseUp(m *desktop.MouseEvent)

MouseUp called on mouse release If a mouse drag event has completed then check to see if it has resulted in an empty selection, if so, and if a text select key isn't held, then disable selecting

func (*Entry) Redo added in v2.5.0 

func (e *Entry) Redo()

Redo un-does the last undo action.

Since: 2.5

func (*Entry) Refresh added in v2.4.4 

func (e *Entry) Refresh()

func (*Entry) SelectedText 

func (e *Entry) SelectedText() string

SelectedText returns the text currently selected in this Entry. If there is no selection it will return the empty string.

func (*Entry) SetIcon added in v2.7.0 

func (e *Entry) SetIcon(res fyne.Resource)

SetIcon sets the leading icon resource for the entry. The icon will be displayed at the outer left of the entry, but is not clickable. This can be used to indicate the purpose of the entry, such as an email or password field.

Since: 2.7

func (*Entry) SetMinRowsVisible added in v2.2.0 

func (e *Entry) SetMinRowsVisible(count int)

SetMinRowsVisible forces a multi-line entry to show `count` number of rows without scrolling. This is not a validation or requirement, it just impacts the minimum visible size. Use this carefully as Fyne apps can run on small screens so you may wish to add a scroll container if this number is high. Default is 3.

Since: 2.2

func (*Entry) SetOnValidationChanged 

func (e *Entry) SetOnValidationChanged(callback func(error))

SetOnValidationChanged is intended for parent widgets or containers to hook into the validation. The function might be overwritten by a parent that cares about child validation (e.g. widget.Form).

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) SetText 

func (e *Entry) SetText(text string)

SetText manually sets the text of the Entry to the given text value. Calling SetText resets all undo history.

func (*Entry) SetValidationError 

func (e *Entry) SetValidationError(err error)

SetValidationError manually updates the validation status until the next input change.

func (*Entry) Tapped 

func (e *Entry) Tapped(ev *fyne.PointEvent)

Tapped is called when this entry has been tapped. We update the cursor position in device-specific callbacks (MouseDown() and TouchDown()).

func (*Entry) TappedSecondary 

func (e *Entry) TappedSecondary(pe *fyne.PointEvent)

TappedSecondary is called when right or alternative tap is invoked.

Opens the PopUpMenu with `Paste` item to paste text from the clipboard.

func (*Entry) TouchCancel added in v2.1.0 

func (e *Entry) TouchCancel(*mobile.TouchEvent)

TouchCancel is called when this entry gets a touch cancel event on mobile device (app was removed from focus).

Since: 2.1

func (*Entry) TouchDown added in v2.1.0 

func (e *Entry) TouchDown(ev *mobile.TouchEvent)

TouchDown is called when this entry gets a touch down event on mobile device, we ensure we have focus.

Since: 2.1

func (*Entry) TouchUp added in v2.1.0 

func (e *Entry) TouchUp(*mobile.TouchEvent)

TouchUp is called when this entry gets a touch up event on mobile device.

Since: 2.1

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)

TypedShortcut implements the Shortcutable interface

func (*Entry) Unbind 

func (e *Entry) Unbind()

Unbind disconnects any configured data source from this Entry. The current value will remain at the last value of the data source.

Since: 2.0

func (*Entry) Undo added in v2.5.0 

func (e *Entry) Undo()

Undo un-does the last modifying user-action.

Since: 2.5

func (*Entry) Validate 

func (e *Entry) Validate() error

Validate validates the current text in the widget.

type FileIcon 

type FileIcon struct {
	BaseWidget

	// Deprecated: Selection is now handled externally.
	Selected bool
	URI      fyne.URI
	// contains filtered or unexported fields
}

FileIcon is an adaption of widget.Icon for showing files and folders

Since: 1.4

func NewFileIcon 

func NewFileIcon(uri fyne.URI) *FileIcon

NewFileIcon takes a filepath and creates an icon with an overlaid label using the detected mimetype and extension

Since: 1.4

func (*FileIcon) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*FileIcon) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*FileIcon) SetSelected deprecated 

func (i *FileIcon) SetSelected(selected bool)

SetSelected makes the file look like it is selected.

Deprecated: Selection is now handled externally.

func (*FileIcon) SetURI 

func (i *FileIcon) SetURI(uri fyne.URI)

SetURI changes the URI and makes the icon reflect a different file

type Form 

type Form struct {
	BaseWidget

	Items      []*FormItem
	OnSubmit   func() `json:"-"`
	OnCancel   func() `json:"-"`
	SubmitText string
	CancelText string

	// Orientation allows a form to be vertical (a single column), horizontal (default, label then input)
	// or to adapt according to the orientation of the mobile device (adaptive).
	//
	// Since: 2.5
	Orientation Orientation
	// 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. If you change OnSubmit/OnCancel after the form is created and rendered, you need to call Refresh() to update the form with the correct buttons. Setting OnSubmit/OnCancel to nil will remove the buttons.

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 its renderer

func (*Form) Disable added in v2.1.0 

func (f *Form) Disable()

Disable disables submitting this form.

Since: 2.1

func (*Form) Disabled added in v2.1.0 

func (f *Form) Disabled() bool

Disabled returns whether submitting the form is disabled. Note that, if the form fails validation, the submit button may be disabled even if this method returns true.

Since: 2.1

func (*Form) Enable added in v2.1.0 

func (f *Form) Enable()

Enable enables submitting this form.

Since: 2.1

func (*Form) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Form) Refresh 

func (f *Form) Refresh()

Refresh updates the widget state when requested.

func (*Form) SetOnValidationChanged added in v2.2.0 

func (f *Form) SetOnValidationChanged(callback func(error))

SetOnValidationChanged is intended for parent widgets or containers to hook into the validation. The function might be overwritten by a parent that cares about child validation (e.g. widget.Form)

func (*Form) Validate added in v2.2.0 

func (f *Form) Validate() error

Validate validates the entire form and returns the first error that is encountered.

type FormItem 

type FormItem struct {
	Text   string
	Widget fyne.CanvasObject

	// Since: 2.0
	HintText string
	// contains filtered or unexported fields
}

FormItem provides the details for a row in a form

func NewFormItem 

func NewFormItem(text string, widget fyne.CanvasObject) *FormItem

NewFormItem creates a new form item with the specified label text and input widget

type GridWrap added in v2.4.0 

type GridWrap struct {
	BaseWidget

	// Length is a callback for returning the number of items in the GridWrap.
	Length func() int `json:"-"`

	// CreateItem is a callback invoked to create a new widget to render
	// an item in the GridWrap.
	CreateItem func() fyne.CanvasObject `json:"-"`

	// UpdateItem is a callback invoked to update a GridWrap item widget
	// to display a new item in the list. The UpdateItem callback should
	// only update the given item, it should not invoke APIs that would
	// change other properties of the GridWrap itself.
	UpdateItem func(id GridWrapItemID, item fyne.CanvasObject) `json:"-"`

	// OnSelected is a callback to be notified when a given item
	// in the GridWrap has been selected.
	OnSelected func(id GridWrapItemID) `json:"-"`

	// OnSelected is a callback to be notified when a given item
	// in the GridWrap has been unselected.
	OnUnselected func(id GridWrapItemID) `json:"-"`
	// contains filtered or unexported fields
}

GridWrap is a widget with an API very similar to widget.List, that lays out items in a scrollable wrapping grid similar to container.NewGridWrap. It caches and reuses widgets for performance.

Since: 2.4

func NewGridWrap added in v2.4.0 

func NewGridWrap(length func() int, createItem func() fyne.CanvasObject, updateItem func(GridWrapItemID, fyne.CanvasObject)) *GridWrap

NewGridWrap creates and returns a GridWrap widget for displaying items in a wrapping grid layout with scrolling and caching for performance.

Since: 2.4

func NewGridWrapWithData added in v2.4.0 

func NewGridWrapWithData(data binding.DataList, createItem func() fyne.CanvasObject, updateItem func(binding.DataItem, fyne.CanvasObject)) *GridWrap

NewGridWrapWithData creates a new GridWrap widget that will display the contents of the provided data.

Since: 2.4

func (*GridWrap) ColumnCount added in v2.5.0 

func (l *GridWrap) ColumnCount() int

ColumnCount returns the number of columns that are/will be shown in this GridWrap, based on the widget's current width.

Since: 2.5

func (*GridWrap) CreateRenderer added in v2.4.0 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer.

func (*GridWrap) FocusGained added in v2.4.0 

func (l *GridWrap) FocusGained()

FocusGained is called after this GridWrap has gained focus.

func (*GridWrap) FocusLost added in v2.4.0 

func (l *GridWrap) FocusLost()

FocusLost is called after this GridWrap has lost focus.

func (*GridWrap) GetScrollOffset added in v2.4.0 

func (l *GridWrap) GetScrollOffset() float32

GetScrollOffset returns the current scroll offset position

func (*GridWrap) MinSize added in v2.4.0 

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

MinSize returns the size that this widget should not shrink below.

func (*GridWrap) RefreshItem added in v2.4.0 

func (l *GridWrap) RefreshItem(id GridWrapItemID)

RefreshItem refreshes a single item, specified by the item ID passed in.

Since: 2.4

func (*GridWrap) Resize added in v2.4.0 

func (l *GridWrap) Resize(s fyne.Size)

Resize is called when this GridWrap should change size. We refresh to ensure invisible items are drawn.

func (*GridWrap) ScrollTo added in v2.4.0 

func (l *GridWrap) ScrollTo(id GridWrapItemID)

ScrollTo scrolls to the item represented by id

func (*GridWrap) ScrollToBottom added in v2.4.0 

func (l *GridWrap) ScrollToBottom()

ScrollToBottom scrolls to the end of the list

func (*GridWrap) ScrollToOffset added in v2.4.0 

func (l *GridWrap) ScrollToOffset(offset float32)

ScrollToOffset scrolls the list to the given offset position

func (*GridWrap) ScrollToTop added in v2.4.0 

func (l *GridWrap) ScrollToTop()

ScrollToTop scrolls to the start of the list

func (*GridWrap) Select added in v2.4.0 

func (l *GridWrap) Select(id GridWrapItemID)

Select adds the item identified by the given ID to the selection.

func (*GridWrap) TypedKey added in v2.4.0 

func (l *GridWrap) TypedKey(event *fyne.KeyEvent)

TypedKey is called if a key event happens while this GridWrap is focused.

func (*GridWrap) TypedRune added in v2.4.0 

func (l *GridWrap) TypedRune(_ rune)

TypedRune is called if a text event happens while this GridWrap is focused.

func (*GridWrap) Unselect added in v2.4.0 

func (l *GridWrap) Unselect(id GridWrapItemID)

Unselect removes the item identified by the given ID from the selection.

func (*GridWrap) UnselectAll added in v2.4.0 

func (l *GridWrap) UnselectAll()

UnselectAll removes all items from the selection.

type GridWrapItemID added in v2.4.0 

type GridWrapItemID = int

GridWrapItemID is the ID of an individual item in the GridWrap widget.

Since: 2.4 

type Hyperlink struct {
	BaseWidget
	Text      string
	URL       *url.URL
	Alignment fyne.TextAlign // The alignment of the Text
	Wrapping  fyne.TextWrap  // The wrapping of the Text
	TextStyle fyne.TextStyle // The style of the hyperlink text

	// The truncation mode of the hyperlink
	//
	// Since: 2.5
	Truncation fyne.TextTruncation

	// The theme size name for the text size of the hyperlink
	//
	// Since: 2.5
	SizeName fyne.ThemeSizeName

	// OnTapped overrides the default `fyne.OpenURL` call when the link is tapped
	//
	// Since: 2.2
	OnTapped func() `json:"-"`
	// 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 its renderer

func (*Hyperlink) Cursor 

func (hl *Hyperlink) Cursor() desktop.Cursor

Cursor returns the cursor type of this widget

func (*Hyperlink) FocusGained added in v2.1.0 

func (hl *Hyperlink) FocusGained()

FocusGained is a hook called by the focus handling logic after this object gained the focus.

func (*Hyperlink) FocusLost added in v2.1.0 

func (hl *Hyperlink) FocusLost()

FocusLost is a hook called by the focus handling logic after this object lost the focus.

func (*Hyperlink) MinSize 

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

MinSize returns the smallest size this widget can shrink to

func (*Hyperlink) MouseIn added in v2.1.0 

func (hl *Hyperlink) MouseIn(e *desktop.MouseEvent)

MouseIn is a hook that is called if the mouse pointer enters the element.

func (*Hyperlink) MouseMoved added in v2.1.0 

func (hl *Hyperlink) MouseMoved(e *desktop.MouseEvent)

MouseMoved is a hook that is called if the mouse pointer moved over the element.

func (*Hyperlink) MouseOut added in v2.1.0 

func (hl *Hyperlink) MouseOut()

MouseOut is a hook that is called if the mouse pointer leaves the element.

func (*Hyperlink) Refresh added in v2.1.0 

func (hl *Hyperlink) Refresh()

Refresh triggers a redraw of the hyperlink.

func (*Hyperlink) Resize 

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

Resize sets a new size for the hyperlink. 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) Tapped 

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

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

func (*Hyperlink) TypedKey added in v2.1.0 

func (hl *Hyperlink) TypedKey(ev *fyne.KeyEvent)

TypedKey is a hook called by the input handling logic on key events if this object is focused.

func (*Hyperlink) TypedRune added in v2.1.0 

func (hl *Hyperlink) TypedRune(rune)

TypedRune is a hook called by the input handling logic on text input events if this object is focused.

type HyperlinkSegment added in v2.1.0 

type HyperlinkSegment struct {
	Alignment fyne.TextAlign
	Text      string
	URL       *url.URL

	// OnTapped overrides the default `fyne.OpenURL` call when the link is tapped
	//
	// Since: 2.4
	OnTapped func() `json:"-"`
}

HyperlinkSegment represents a hyperlink within a rich text widget.

Since: 2.1

func (*HyperlinkSegment) Inline added in v2.1.0 

func (h *HyperlinkSegment) Inline() bool

Inline returns true as hyperlinks are inside other elements.

func (*HyperlinkSegment) Select added in v2.1.0 

func (h *HyperlinkSegment) Select(begin, end fyne.Position)

Select tells the segment that the user is selecting the content between the two positions.

func (*HyperlinkSegment) SelectedText added in v2.1.0 

func (h *HyperlinkSegment) SelectedText() string

SelectedText should return the text representation of any content currently selected through the Select call.

func (*HyperlinkSegment) Textual added in v2.1.0 

func (h *HyperlinkSegment) Textual() string

Textual returns the content of this segment rendered to plain text.

func (*HyperlinkSegment) Unselect added in v2.1.0 

func (h *HyperlinkSegment) Unselect()

Unselect tells the segment that the user is has cancelled the previous selection.

func (*HyperlinkSegment) Update added in v2.1.0 

func (h *HyperlinkSegment) Update(o fyne.CanvasObject)

Update applies the current state of this hyperlink segment to an existing visual.

func (*HyperlinkSegment) Visual added in v2.1.0 

func (h *HyperlinkSegment) Visual() fyne.CanvasObject

Visual returns a new instance of a hyperlink widget required to render this segment.

type Icon 

type Icon struct {
	BaseWidget

	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 its renderer

func (*Icon) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Icon) SetResource 

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

SetResource updates the resource rendered in this icon widget

type ImageSegment added in v2.3.0 

type ImageSegment struct {
	Source fyne.URI
	Title  string

	// Alignment specifies the horizontal alignment of this image segment
	// Since: 2.4
	Alignment fyne.TextAlign
}

ImageSegment represents an image within a rich text widget.

Since: 2.3

func (*ImageSegment) Inline added in v2.3.0 

func (i *ImageSegment) Inline() bool

Inline returns false as images in rich text are blocks.

func (*ImageSegment) Select added in v2.3.0 

func (i *ImageSegment) Select(begin, end fyne.Position)

Select tells the segment that the user is selecting the content between the two positions.

func (*ImageSegment) SelectedText added in v2.3.0 

func (i *ImageSegment) SelectedText() string

SelectedText should return the text representation of any content currently selected through the Select call.

func (*ImageSegment) Textual added in v2.3.0 

func (i *ImageSegment) Textual() string

Textual returns the content of this segment rendered to plain text.

func (*ImageSegment) Unselect added in v2.3.0 

func (i *ImageSegment) Unselect()

Unselect tells the segment that the user is has cancelled the previous selection.

func (*ImageSegment) Update added in v2.3.0 

func (i *ImageSegment) Update(o fyne.CanvasObject)

Update applies the current state of this image segment to an existing visual.

func (*ImageSegment) Visual added in v2.3.0 

func (i *ImageSegment) Visual() fyne.CanvasObject

Visual returns a new instance of an image widget required to render this segment.

type Importance added in v2.4.0 

type Importance int

Importance represents how prominent the widget should appear

Since: 2.4 

const (
	// MediumImportance applies a standard appearance.
	MediumImportance Importance = iota
	// HighImportance applies a prominent appearance.
	HighImportance
	// LowImportance applies a subtle appearance.
	LowImportance

	// DangerImportance applies an error theme to the widget.
	//
	// Since: 2.3
	DangerImportance
	// WarningImportance applies a warning theme to the widget.
	//
	// Since: 2.3
	WarningImportance

	// SuccessImportance applies a success theme to the widget.
	//
	// Since: 2.4
	SuccessImportance
)

type Label 

type Label struct {
	BaseWidget
	Text      string
	Alignment fyne.TextAlign // The alignment of the text
	Wrapping  fyne.TextWrap  // The wrapping of the text
	TextStyle fyne.TextStyle // The style of the label text

	// The truncation mode of the text
	//
	// Since: 2.4
	Truncation fyne.TextTruncation
	// Importance informs how the label should be styled, i.e. warning or disabled
	//
	// Since: 2.4
	Importance Importance

	// The theme size name for the text size of the label
	//
	// Since: 2.6
	SizeName fyne.ThemeSizeName

	// If set to true, Selectable indicates that this label should support select interaction
	// to allow the text to be copied.
	//
	//Since: 2.6
	Selectable bool
	// 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 NewLabelWithData 

func NewLabelWithData(data binding.String) *Label

NewLabelWithData returns a Label widget connected to the specified data source.

Since: 2.0

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) Bind 

func (l *Label) Bind(data binding.String)

Bind connects the specified data source to this Label. The current value will be displayed and any changes in the data will cause the widget to update.

Since: 2.0

func (*Label) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Label) MinSize 

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

MinSize returns the size that this label should not shrink below.

func (*Label) Refresh 

func (l *Label) Refresh()

Refresh triggers a redraw of the label.

func (*Label) SelectedText added in v2.6.0 

func (l *Label) SelectedText() string

SelectedText returns the text currently selected in this Label. If the label is not Selectable it will return an empty string. If there is no selection it will return the empty string.

Since: 2.6

func (*Label) SetText 

func (l *Label) SetText(text string)

SetText sets the text of the label

func (*Label) Unbind 

func (l *Label) Unbind()

Unbind disconnects any configured data source from this Label. The current value will remain at the last value of the data source.

Since: 2.0

type List 

type List struct {
	BaseWidget

	// Length is a callback for returning the number of items in the list.
	Length func() int `json:"-"`

	// CreateItem is a callback invoked to create a new widget to render
	// a row in the list.
	CreateItem func() fyne.CanvasObject `json:"-"`

	// UpdateItem is a callback invoked to update a list row widget
	// to display a new row in the list. The UpdateItem callback should
	// only update the given item, it should not invoke APIs that would
	// change other properties of the list itself.
	UpdateItem func(id ListItemID, item fyne.CanvasObject) `json:"-"`

	// OnSelected is a callback to be notified when a given item
	// in the list has been selected.
	OnSelected func(id ListItemID) `json:"-"`

	// OnSelected is a callback to be notified when a given item
	// in the list has been unselected.
	OnUnselected func(id ListItemID) `json:"-"`

	// HideSeparators hides the separators between list rows
	//
	// Since: 2.5
	HideSeparators bool
	// contains filtered or unexported fields
}

List is a widget that pools list items for performance and lays the items out in a vertical direction inside of a scroller. By default, List requires that all items are the same size, but specific rows can have their heights set with SetItemHeight.

Since: 1.4

func NewList 

func NewList(length func() int, createItem func() fyne.CanvasObject, updateItem func(ListItemID, fyne.CanvasObject)) *List

NewList creates and returns a list widget for displaying items in a vertical layout with scrolling and caching for performance.

Since: 1.4

func NewListWithData 

func NewListWithData(data binding.DataList, createItem func() fyne.CanvasObject, updateItem func(binding.DataItem, fyne.CanvasObject)) *List

NewListWithData creates a new list widget that will display the contents of the provided data.

Since: 2.0

func (*List) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer.

func (*List) FocusGained added in v2.4.0 

func (l *List) FocusGained()

FocusGained is called after this List has gained focus.

func (*List) FocusLost added in v2.4.0 

func (l *List) FocusLost()

FocusLost is called after this List has lost focus.

func (*List) GetScrollOffset added in v2.5.0 

func (l *List) GetScrollOffset() float32

GetScrollOffset returns the current scroll offset position

Since: 2.5

func (*List) MinSize 

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

MinSize returns the size that this widget should not shrink below.

func (*List) RefreshItem added in v2.4.0 

func (l *List) RefreshItem(id ListItemID)

RefreshItem refreshes a single item, specified by the item ID passed in.

Since: 2.4

func (*List) Resize added in v2.1.0 

func (l *List) Resize(s fyne.Size)

Resize is called when this list should change size. We refresh to ensure invisible items are drawn.

func (*List) ScrollTo added in v2.1.0 

func (l *List) ScrollTo(id ListItemID)

ScrollTo scrolls to the item represented by id

Since: 2.1

func (*List) ScrollToBottom added in v2.1.0 

func (l *List) ScrollToBottom()

ScrollToBottom scrolls to the end of the list

Since: 2.1

func (*List) ScrollToOffset added in v2.5.0 

func (l *List) ScrollToOffset(offset float32)

ScrollToOffset scrolls the list to the given offset position.

Since: 2.5

func (*List) ScrollToTop added in v2.1.0 

func (l *List) ScrollToTop()

ScrollToTop scrolls to the start of the list

Since: 2.1

func (*List) Select 

func (l *List) Select(id ListItemID)

Select add the item identified by the given ID to the selection.

func (*List) SetItemHeight added in v2.3.0 

func (l *List) SetItemHeight(id ListItemID, height float32)

SetItemHeight supports changing the height of the specified list item. Items normally take the height of the template returned from the CreateItem callback. The height parameter uses the same units as a fyne.Size type and refers to the internal content height not including the divider size.

Since: 2.3

func (*List) TypedKey added in v2.4.0 

func (l *List) TypedKey(event *fyne.KeyEvent)

TypedKey is called if a key event happens while this List is focused.

func (*List) TypedRune added in v2.4.0 

func (l *List) TypedRune(_ rune)

TypedRune is called if a text event happens while this List is focused.

func (*List) Unselect 

func (l *List) Unselect(id ListItemID)

Unselect removes the item identified by the given ID from the selection.

func (*List) UnselectAll added in v2.1.0 

func (l *List) UnselectAll()

UnselectAll removes all items from the selection.

Since: 2.1

type ListItemID 

type ListItemID = int

ListItemID uniquely identifies an item within a list.

type ListSegment added in v2.1.0 

type ListSegment struct {
	Items   []RichTextSegment
	Ordered bool
	// contains filtered or unexported fields
}

ListSegment includes an itemised list with the content set using the Items field.

Since: 2.1

func (*ListSegment) Inline added in v2.1.0 

func (l *ListSegment) Inline() bool

Inline returns false as a list should be in a block.

func (*ListSegment) Segments added in v2.1.0 

func (l *ListSegment) Segments() []RichTextSegment

Segments returns the segments required to draw bullets before each item

func (*ListSegment) Select added in v2.1.0 

func (l *ListSegment) Select(_, _ fyne.Position)

Select does nothing for a list container.

func (*ListSegment) SelectedText added in v2.1.0 

func (l *ListSegment) SelectedText() string

SelectedText returns the empty string for this list.

func (*ListSegment) SetStartNumber added in v2.7.0 

func (l *ListSegment) SetStartNumber(s int)

SetStartNumber sets the starting number for an ordered list. Unordered lists are not affected.

Since: 2.7

func (*ListSegment) StartNumber added in v2.7.0 

func (l *ListSegment) StartNumber() int

StartNumber return the starting number for an ordered list.

Since: 2.7

func (*ListSegment) Textual added in v2.1.0 

func (l *ListSegment) Textual() string

Textual returns no content for a list as the content is in sub-segments.

func (*ListSegment) Unselect added in v2.1.0 

func (l *ListSegment) Unselect()

Unselect does nothing for a list container.

func (*ListSegment) Update added in v2.1.0 

func (l *ListSegment) Update(fyne.CanvasObject)

Update doesn't need to change a list visual.

func (*ListSegment) Visual added in v2.1.0 

func (l *ListSegment) Visual() fyne.CanvasObject

Visual returns no additional elements for this segment. 

type Menu struct {
	BaseWidget

	Items     []fyne.CanvasObject
	OnDismiss func() `json:"-"`
	// contains filtered or unexported fields
}

Menu is a widget for displaying a fyne.Menu.

func NewMenu 

func NewMenu(menu *fyne.Menu) *Menu

NewMenu creates a new Menu. 

func (m *Menu) ActivateLastSubmenu() bool

ActivateLastSubmenu finds the last active menu item traversing through the open submenus and activates its submenu if any. It returns `true` if there was a submenu and it was activated and `false` elsewhere. Activating a submenu does show it and activate its first item. 

func (m *Menu) ActivateNext()

ActivateNext activates the menu item following the currently active menu item. If there is no menu item active, it activates the first menu item. If there is no menu item after the current active one, it does nothing. If a submenu is open, it delegates the activation to this submenu. 

func (m *Menu) ActivatePrevious()

ActivatePrevious activates the menu item preceding the currently active menu item. If there is no menu item active, it activates the last menu item. If there is no menu item before the current active one, it does nothing. If a submenu is open, it delegates the activation to this submenu. 

func (m *Menu) CreateRenderer() fyne.WidgetRenderer

CreateRenderer returns a new renderer for the menu. 

func (m *Menu) DeactivateChild()

DeactivateChild deactivates the active menu item and hides its submenu if any. 

func (m *Menu) DeactivateLastSubmenu() bool

DeactivateLastSubmenu finds the last open submenu traversing through the open submenus, deactivates its active item and hides it. This also deactivates any submenus of the deactivated submenu. It returns `true` if there was a submenu open and closed and `false` elsewhere. 

func (m *Menu) Dismiss()

Dismiss dismisses the menu by dismissing and hiding the active child and performing OnDismiss. 

func (m *Menu) MinSize() fyne.Size

MinSize returns the minimal size of the menu. 

func (m *Menu) Refresh()

Refresh updates the menu to reflect changes in the data. 

func (m *Menu) Tapped(*fyne.PointEvent)

Tapped catches taps on separators and the menu background. It doesn't perform any action. 

func (m *Menu) TriggerLast()

TriggerLast finds the last active menu item traversing through the open submenus and triggers it.

type Orientation 

type Orientation int

Orientation controls the horizontal/vertical layout of a widget 

const (
	Horizontal Orientation = 0
	Vertical   Orientation = 1

	// Adaptive will switch between horizontal and vertical layouts according to device orientation.
	// This orientation is not always supported and interpretation can vary per-widget.
	//
	// Since: 2.5
	Adaptive Orientation = 2
)

Orientation constants to control widget layout

type ParagraphSegment added in v2.1.0 

type ParagraphSegment struct {
	Texts []RichTextSegment
}

ParagraphSegment wraps a number of text elements in a paragraph. It is similar to using a list of text elements when the final style is RichTextStyleParagraph.

Since: 2.1

func (*ParagraphSegment) Inline added in v2.1.0 

func (p *ParagraphSegment) Inline() bool

Inline returns false as a paragraph should be in a block.

func (*ParagraphSegment) Segments added in v2.1.0 

func (p *ParagraphSegment) Segments() []RichTextSegment

Segments returns the list of text elements in this paragraph.

func (*ParagraphSegment) Select added in v2.1.0 

func (p *ParagraphSegment) Select(_, _ fyne.Position)

Select does nothing for a paragraph container.

func (*ParagraphSegment) SelectedText added in v2.1.0 

func (p *ParagraphSegment) SelectedText() string

SelectedText returns the empty string for this paragraph container.

func (*ParagraphSegment) Textual added in v2.1.0 

func (p *ParagraphSegment) Textual() string

Textual returns no content for a paragraph container.

func (*ParagraphSegment) Unselect added in v2.1.0 

func (p *ParagraphSegment) Unselect()

Unselect does nothing for a paragraph container.

func (*ParagraphSegment) Update added in v2.1.0 

func (p *ParagraphSegment) Update(fyne.CanvasObject)

Update doesn't need to change a paragraph container.

func (*ParagraphSegment) Visual added in v2.1.0 

func (p *ParagraphSegment) Visual() fyne.CanvasObject

Visual returns the no extra elements. 

type PopUp struct {
	BaseWidget

	Content fyne.CanvasObject
	Canvas  fyne.Canvas
	// contains filtered or unexported fields
}

PopUp is a widget that can float above the user interface. It wraps any standard elements with padding and a shadow. If it is modal then the shadow will cover the entire canvas it hovers over and block interactions.

func NewModalPopUp 

func NewModalPopUp(content fyne.CanvasObject, canvas fyne.Canvas) *PopUp

NewModalPopUp creates a new popUp for the specified content and displays it on the passed canvas. A modal PopUp blocks interactions with underlying elements, covered with a semi-transparent overlay.

func NewPopUp 

func NewPopUp(content fyne.CanvasObject, canvas fyne.Canvas) *PopUp

NewPopUp creates a new popUp for the specified content and displays it on the passed canvas.

func (*PopUp) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*PopUp) Hide 

func (p *PopUp) Hide()

Hide this widget, if it was previously visible

func (*PopUp) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*PopUp) Move 

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

Move the widget to a new position. A PopUp position is absolute to the top, left of its canvas. For PopUp this actually moves the content so checking Position() will not return the same value as is set here.

func (*PopUp) Resize 

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

Resize changes the size of the PopUp's content. PopUps always have the size of their canvas, but this call updates the size of the content portion.

func (*PopUp) Show 

func (p *PopUp) Show()

Show this pop-up as overlay if not already shown.

func (*PopUp) ShowAtPosition 

func (p *PopUp) ShowAtPosition(pos fyne.Position)

ShowAtPosition shows this pop-up at the given position.

func (*PopUp) ShowAtRelativePosition added in v2.4.0 

func (p *PopUp) ShowAtRelativePosition(rel fyne.Position, to fyne.CanvasObject)

ShowAtRelativePosition shows this pop-up at the given position relative to stated object.

Since 2.4

func (*PopUp) Tapped 

func (p *PopUp) Tapped(e *fyne.PointEvent)

Tapped is called when the user taps the popUp. If not modal and the tap is outside the content area, then dismiss this widget

func (*PopUp) TappedSecondary 

func (p *PopUp) TappedSecondary(e *fyne.PointEvent)

TappedSecondary is called when the user right/alt taps the popUp. If not modal and the tap is outside the content area, then dismiss this widget

type PopUpMenu 

type PopUpMenu struct {
	*Menu
	// contains filtered or unexported fields
}

PopUpMenu is a Menu which displays itself in an OverlayContainer.

func NewPopUpMenu 

func NewPopUpMenu(menu *fyne.Menu, c fyne.Canvas) *PopUpMenu

NewPopUpMenu creates a new, reusable popup menu. You can show it using ShowAtPosition.

Since: 2.0

func (*PopUpMenu) FocusGained added in v2.1.0 

func (p *PopUpMenu) FocusGained()

FocusGained is triggered when the object gained focus. For the pop-up menu it does nothing.

func (*PopUpMenu) FocusLost added in v2.1.0 

func (p *PopUpMenu) FocusLost()

FocusLost is triggered when the object lost focus. For the pop-up menu it does nothing.

func (*PopUpMenu) Hide 

func (p *PopUpMenu) Hide()

Hide hides the pop-up menu.

func (*PopUpMenu) Move 

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

Move moves the pop-up menu. The position is absolute because pop-up menus are shown in an overlay which covers the whole canvas.

func (*PopUpMenu) Resize 

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

Resize changes the size of the pop-up menu.

func (*PopUpMenu) Show 

func (p *PopUpMenu) Show()

Show makes the pop-up menu visible.

func (*PopUpMenu) ShowAtPosition 

func (p *PopUpMenu) ShowAtPosition(pos fyne.Position)

ShowAtPosition shows the pop-up menu at the specified position.

func (*PopUpMenu) ShowAtRelativePosition added in v2.4.0 

func (p *PopUpMenu) ShowAtRelativePosition(rel fyne.Position, to fyne.CanvasObject)

ShowAtRelativePosition shows the pop-up menu at the position relative to given object.

Since 2.4

func (*PopUpMenu) TypedKey added in v2.1.0 

func (p *PopUpMenu) TypedKey(e *fyne.KeyEvent)

TypedKey handles key events. It allows keyboard control of the pop-up menu.

func (*PopUpMenu) TypedRune added in v2.1.0 

func (p *PopUpMenu) TypedRune(rune)

TypedRune handles text events. For pop-up menus this does nothing.

type ProgressBar 

type ProgressBar struct {
	BaseWidget

	Min, Max, Value float64

	// TextFormatter can be used to have a custom format of progress text.
	// If set, it overrides the percentage readout and runs each time the value updates.
	//
	// Since: 1.4
	TextFormatter func() string `json:"-"`
	// 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 NewProgressBarWithData 

func NewProgressBarWithData(data binding.Float) *ProgressBar

NewProgressBarWithData returns a progress bar connected with the specified data source.

Since: 2.0

func (*ProgressBar) Bind 

func (p *ProgressBar) Bind(data binding.Float)

Bind connects the specified data source to this ProgressBar. The current value will be displayed and any changes in the data will cause the widget to update.

Since: 2.0

func (*ProgressBar) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*ProgressBar) MinSize 

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

MinSize returns the size that this widget should not shrink below

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) Unbind 

func (p *ProgressBar) Unbind()

Unbind disconnects any configured data source from this ProgressBar. The current value will remain at the last value of the data source.

Since: 2.0

type ProgressBarInfinite 

type ProgressBarInfinite struct {
	BaseWidget
	// 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 its 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 size that this widget should not shrink below

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) Start 

func (p *ProgressBarInfinite) Start()

Start the infinite progress bar animation

func (*ProgressBarInfinite) Stop 

func (p *ProgressBarInfinite) Stop()

Stop the infinite progress bar animation

type RadioGroup 

type RadioGroup struct {
	DisableableWidget
	Horizontal bool
	Required   bool
	OnChanged  func(string) `json:"-"`
	Options    []string
	Selected   string
	// contains filtered or unexported fields
}

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

Since: 1.4

func NewRadioGroup 

func NewRadioGroup(options []string, changed func(string)) *RadioGroup

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

Since: 1.4

func (*RadioGroup) Append 

func (r *RadioGroup) Append(option string)

Append adds a new option to the end of a RadioGroup widget.

func (*RadioGroup) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*RadioGroup) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*RadioGroup) Refresh 

func (r *RadioGroup) Refresh()

func (*RadioGroup) SetSelected 

func (r *RadioGroup) SetSelected(option string)

SetSelected sets the radio option, it can be used to set a default option.

type RichText added in v2.1.0 

type RichText struct {
	BaseWidget
	Segments []RichTextSegment
	Wrapping fyne.TextWrap
	Scroll   fyne.ScrollDirection

	// The truncation mode of the text
	//
	// Since: 2.4
	Truncation fyne.TextTruncation
	// contains filtered or unexported fields
}

RichText represents the base element for a rich text-based widget.

Since: 2.1

func NewRichText added in v2.1.0 

func NewRichText(segments ...RichTextSegment) *RichText

NewRichText returns a new RichText widget that renders the given text and segments. If no segments are specified it will be converted to a single segment using the default text settings.

Since: 2.1

func NewRichTextFromMarkdown added in v2.1.0 

func NewRichTextFromMarkdown(content string) *RichText

NewRichTextFromMarkdown configures a RichText widget by parsing the provided markdown content.

Since: 2.1

func NewRichTextWithText added in v2.1.0 

func NewRichTextWithText(text string) *RichText

NewRichTextWithText returns a new RichText widget that renders the given text. The string will be converted to a single text segment using the default text settings.

Since: 2.1

func (*RichText) AppendMarkdown added in v2.5.0 

func (t *RichText) AppendMarkdown(content string)

AppendMarkdown parses the given markdown string and appends the content to the widget, with the appropriate formatting. This API is intended for appending complete markdown documents or standalone fragments, and should not be used to parse a single markdown document piecewise.

Since: 2.5

func (*RichText) CreateRenderer added in v2.1.0 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*RichText) MinSize added in v2.1.0 

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

MinSize calculates the minimum size of a rich text widget. This is based on the contained text with a standard amount of padding added.

func (*RichText) ParseMarkdown added in v2.1.0 

func (t *RichText) ParseMarkdown(content string)

ParseMarkdown allows setting the content of this RichText widget from a markdown string. It will replace the content of this widget similarly to SetText, but with the appropriate formatting.

func (*RichText) Refresh added in v2.1.0 

func (t *RichText) Refresh()

Refresh triggers a redraw of the rich text.

func (*RichText) Resize added in v2.1.0 

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

Resize sets a new size for the rich text. This should only be called if it is not in a container with a layout manager.

func (*RichText) String added in v2.1.0 

func (t *RichText) String() string

String returns the text widget buffer as string

type RichTextBlock added in v2.1.0 

type RichTextBlock interface {
	Segments() []RichTextSegment
}

RichTextBlock is an extension of a text segment that contains other segments

Since: 2.1

type RichTextSegment added in v2.1.0 

type RichTextSegment interface {
	Inline() bool
	Textual() string
	Update(fyne.CanvasObject)
	Visual() fyne.CanvasObject

	Select(pos1, pos2 fyne.Position)
	SelectedText() string
	Unselect()
}

RichTextSegment describes any element that can be rendered in a RichText widget.

Since: 2.1

type RichTextStyle added in v2.1.0 

type RichTextStyle struct {
	Alignment fyne.TextAlign
	ColorName fyne.ThemeColorName
	Inline    bool
	SizeName  fyne.ThemeSizeName // The theme name of the text size to use, if blank will be the standard text size
	TextStyle fyne.TextStyle
	// contains filtered or unexported fields
}

RichTextStyle describes the details of a text object inside a RichText widget.

Since: 2.1

type Select 

type Select struct {
	DisableableWidget

	// Alignment sets the text alignment of the select and its list of options.
	//
	// Since: 2.1
	Alignment   fyne.TextAlign
	Selected    string
	Options     []string
	PlaceHolder string
	OnChanged   func(string) `json:"-"`
	// contains filtered or unexported fields
}

Select widget has a list of options, with the current one shown, and triggers an event func when clicked

func NewSelect 

func NewSelect(options []string, changed func(string)) *Select

NewSelect creates a new select widget with the set list of options and changes handler

func NewSelectWithData added in v2.6.0 

func NewSelectWithData(options []string, data binding.String) *Select

NewSelectWithData returns a new select widget connected to the specified data source.

Since: 2.6

func (*Select) Bind added in v2.6.0 

func (s *Select) Bind(data binding.String)

Bind connects the specified data source to this select. The current value will be displayed and any changes in the data will cause the widget to update.

Since: 2.6

func (*Select) ClearSelected 

func (s *Select) ClearSelected()

ClearSelected clears the current option of the select widget. After clearing the current option, the Select widget's PlaceHolder will be displayed.

func (*Select) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Select) FocusGained 

func (s *Select) FocusGained()

FocusGained is called after this Select has gained focus.

func (*Select) FocusLost 

func (s *Select) FocusLost()

FocusLost is called after this Select has lost focus.

func (*Select) Hide 

func (s *Select) Hide()

Hide hides the select.

func (*Select) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Select) MouseIn 

func (s *Select) MouseIn(*desktop.MouseEvent)

MouseIn is called when a desktop pointer enters the widget

func (*Select) MouseMoved 

func (s *Select) MouseMoved(*desktop.MouseEvent)

MouseMoved is called when a desktop pointer hovers over the widget

func (*Select) MouseOut 

func (s *Select) MouseOut()

MouseOut is called when a desktop pointer exits the widget

func (*Select) Move 

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

Move changes the relative position of the select.

func (*Select) Resize 

func (s *Select) 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 (*Select) SelectedIndex 

func (s *Select) SelectedIndex() int

SelectedIndex returns the index value of the currently selected item in Options list. It will return -1 if there is no selection.

func (*Select) SetOptions added in v2.4.0 

func (s *Select) SetOptions(options []string)

SetOptions updates the list of options available and refreshes the widget

Since: 2.4

func (*Select) SetSelected 

func (s *Select) SetSelected(text string)

SetSelected sets the current option of the select widget

func (*Select) SetSelectedIndex 

func (s *Select) SetSelectedIndex(index int)

SetSelectedIndex will set the Selected option from the value in Options list at index position.

func (*Select) Tapped 

func (s *Select) Tapped(*fyne.PointEvent)

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

func (*Select) TypedKey 

func (s *Select) TypedKey(event *fyne.KeyEvent)

TypedKey is called if a key event happens while this Select is focused.

func (*Select) TypedRune 

func (s *Select) TypedRune(_ rune)

TypedRune is called if a text event happens while this Select is focused.

func (*Select) Unbind added in v2.6.0 

func (s *Select) Unbind()

Unbind disconnects any configured data source from this Select. The current value will remain at the last value of the data source.

Since: 2.6

type SelectEntry 

type SelectEntry struct {
	Entry
	// contains filtered or unexported fields
}

SelectEntry is an input field which supports selecting from a fixed set of options.

func NewSelectEntry 

func NewSelectEntry(options []string) *SelectEntry

NewSelectEntry creates a SelectEntry.

func (*SelectEntry) CreateRenderer 

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

CreateRenderer returns a new renderer for this select entry.

func (*SelectEntry) Disable 

func (e *SelectEntry) Disable()

Disable this widget so that it cannot be interacted with, updating any style appropriately.

func (*SelectEntry) Enable 

func (e *SelectEntry) Enable()

Enable this widget, updating any style or features appropriately.

func (*SelectEntry) MinSize 

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

MinSize returns the minimal size of the select entry.

func (*SelectEntry) Move added in v2.0.3 

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

Move changes the relative position of the select entry.

func (*SelectEntry) Resize 

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

Resize changes the size of the select entry.

func (*SelectEntry) SetOptions 

func (e *SelectEntry) SetOptions(options []string)

SetOptions sets the options the user might select from.

type Separator 

type Separator struct {
	BaseWidget
	// contains filtered or unexported fields
}

Separator is a widget for displaying a separator with themeable color.

Since: 1.4

func NewSeparator 

func NewSeparator() *Separator

NewSeparator creates a new separator.

Since: 1.4

func (*Separator) CreateRenderer 

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

CreateRenderer returns a new renderer for the separator.

func (*Separator) MinSize 

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

MinSize returns the minimal size of the separator.

type SeparatorSegment added in v2.1.0 

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

SeparatorSegment includes a horizontal separator in a rich text widget.

Since: 2.1

func (*SeparatorSegment) Inline added in v2.1.0 

func (s *SeparatorSegment) Inline() bool

Inline returns false as a separator should be full width.

func (*SeparatorSegment) Select added in v2.1.0 

func (s *SeparatorSegment) Select(_, _ fyne.Position)

Select does nothing for a separator.

func (*SeparatorSegment) SelectedText added in v2.1.0 

func (s *SeparatorSegment) SelectedText() string

SelectedText returns the empty string for this separator.

func (*SeparatorSegment) Textual added in v2.1.0 

func (s *SeparatorSegment) Textual() string

Textual returns no content for a separator element.

func (*SeparatorSegment) Unselect added in v2.1.0 

func (s *SeparatorSegment) Unselect()

Unselect does nothing for a separator.

func (*SeparatorSegment) Update added in v2.1.0 

func (s *SeparatorSegment) Update(fyne.CanvasObject)

Update doesn't need to change a separator visual.

func (*SeparatorSegment) Visual added in v2.1.0 

func (s *SeparatorSegment) Visual() fyne.CanvasObject

Visual returns a new instance of a separator widget for this segment.

type Slider 

type Slider struct {
	BaseWidget

	Value float64
	Min   float64
	Max   float64
	Step  float64

	Orientation Orientation
	OnChanged   func(float64) `json:"-"`

	// Since: 2.4
	OnChangeEnded func(float64) `json:"-"`
	// contains filtered or unexported fields
}

Slider is a widget that can slide between two fixed values.

func NewSlider 

func NewSlider(min, max float64) *Slider

NewSlider returns a basic slider.

func NewSliderWithData 

func NewSliderWithData(min, max float64, data binding.Float) *Slider

NewSliderWithData returns a slider connected with the specified data source.

Since: 2.0

func (*Slider) Bind 

func (s *Slider) Bind(data binding.Float)

Bind connects the specified data source to this Slider. The current value will be displayed and any changes in the data will cause the widget to update. User interactions with this Slider will set the value into the data source.

Since: 2.0

func (*Slider) CreateRenderer 

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

CreateRenderer links this widget to its renderer.

func (*Slider) Disable added in v2.5.0 

func (s *Slider) Disable()

Disable disables the slider

Since: 2.5

func (*Slider) Disabled added in v2.5.0 

func (s *Slider) Disabled() bool

Disabled returns true if the slider is currently disabled

Since: 2.5

func (*Slider) DragEnd 

func (s *Slider) DragEnd()

DragEnd is called when the drag ends.

func (*Slider) Dragged 

func (s *Slider) Dragged(e *fyne.DragEvent)

Dragged is called when a drag event occurs.

func (*Slider) Enable added in v2.5.0 

func (s *Slider) Enable()

Enable enables the slider

Since: 2.5

func (*Slider) FocusGained added in v2.4.0 

func (s *Slider) FocusGained()

FocusGained is called when this item gained the focus.

Since: 2.4

func (*Slider) FocusLost added in v2.4.0 

func (s *Slider) FocusLost()

FocusLost is called when this item lost the focus.

Since: 2.4

func (*Slider) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Slider) MouseIn added in v2.4.0 

func (s *Slider) MouseIn(_ *desktop.MouseEvent)

MouseIn is called when a desktop pointer enters the widget.

Since: 2.4

func (*Slider) MouseMoved added in v2.4.0 

func (s *Slider) MouseMoved(_ *desktop.MouseEvent)

MouseMoved is called when a desktop pointer hovers over the widget.

Since: 2.4

func (*Slider) MouseOut added in v2.4.0 

func (s *Slider) MouseOut()

MouseOut is called when a desktop pointer exits the widget

Since: 2.4

func (*Slider) SetValue 

func (s *Slider) SetValue(value float64)

SetValue updates the value of the slider and clamps the value to be within the range.

func (*Slider) Tapped added in v2.4.0 

func (s *Slider) Tapped(e *fyne.PointEvent)

Tapped is called when a pointer tapped event is captured.

Since: 2.4

func (*Slider) TypedKey added in v2.4.0 

func (s *Slider) TypedKey(key *fyne.KeyEvent)

TypedKey is called when this item receives a key event.

Since: 2.4

func (*Slider) TypedRune added in v2.4.0 

func (s *Slider) TypedRune(_ rune)

TypedRune is called when this item receives a char event.

Since: 2.4

func (*Slider) Unbind 

func (s *Slider) Unbind()

Unbind disconnects any configured data source from this Slider. The current value will remain at the last value of the data source.

Since: 2.0

type Table 

type Table struct {
	BaseWidget

	Length       func() (rows int, cols int)                      `json:"-"`
	CreateCell   func() fyne.CanvasObject                         `json:"-"`
	UpdateCell   func(id TableCellID, template fyne.CanvasObject) `json:"-"`
	OnSelected   func(id TableCellID)                             `json:"-"`
	OnUnselected func(id TableCellID)                             `json:"-"`

	// ShowHeaderRow specifies that a row should be added to the table with header content.
	// This will default to an A-Z style content, unless overridden with `CreateHeader` and `UpdateHeader` calls.
	//
	// Since: 2.4
	ShowHeaderRow bool

	// ShowHeaderColumn specifies that a column should be added to the table with header content.
	// This will default to an 1-10 style numeric content, unless overridden with `CreateHeader` and `UpdateHeader` calls.
	//
	// Since: 2.4
	ShowHeaderColumn bool

	// CreateHeader is an optional function that allows overriding of the default header widget.
	// Developers must also override `UpdateHeader`.
	//
	// Since: 2.4
	CreateHeader func() fyne.CanvasObject `json:"-"`

	// UpdateHeader is used with `CreateHeader` to support custom header content.
	// The `id` parameter will have `-1` value to indicate a header, and `> 0` where the column or row refer to data.
	//
	// Since: 2.4
	UpdateHeader func(id TableCellID, template fyne.CanvasObject) `json:"-"`

	// StickyRowCount specifies how many data rows should not scroll when the content moves.
	// If `ShowHeaderRow` us `true` then the stuck row will appear immediately underneath.
	//
	// Since: 2.4
	StickyRowCount int

	// StickyColumnCount specifies how many data columns should not scroll when the content moves.
	// If `ShowHeaderColumn` us `true` then the stuck column will appear immediately next to the header.
	//
	// Since: 2.4
	StickyColumnCount int

	// HideSeparators hides the separator lines between the table cells
	//
	// Since: 2.5
	HideSeparators bool
	// contains filtered or unexported fields
}

Table widget is a grid of items that can be scrolled and a cell selected. Its performance is provided by caching cell templates created with CreateCell and re-using them with UpdateCell. The size of the content rows/columns is returned by the Length callback.

Since: 1.4

func NewTable 

func NewTable(length func() (rows int, cols int), create func() fyne.CanvasObject, update func(TableCellID, fyne.CanvasObject)) *Table

NewTable returns a new performant table widget defined by the passed functions. The first returns the data size in rows and columns, second parameter is a function that returns cell template objects that can be cached and the third is used to apply data at specified data location to the passed template CanvasObject.

Since: 1.4

func NewTableWithHeaders added in v2.4.0 

func NewTableWithHeaders(length func() (rows int, cols int), create func() fyne.CanvasObject, update func(TableCellID, fyne.CanvasObject)) *Table

NewTableWithHeaders returns a new performant table widget defined by the passed functions including sticky headers. The first returns the data size in rows and columns, second parameter is a function that returns cell template objects that can be cached and the third is used to apply data at specified data location to the passed template CanvasObject. The row and column headers will stick to the leading and top edges of the table and contain "1-10" and "A-Z" formatted labels.

Since: 2.4

func (*Table) CreateRenderer 

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

CreateRenderer returns a new renderer for the table.

func (*Table) Cursor added in v2.4.0 

func (t *Table) Cursor() desktop.Cursor

func (*Table) DragEnd added in v2.4.0 

func (t *Table) DragEnd()

func (*Table) Dragged added in v2.4.0 

func (t *Table) Dragged(e *fyne.DragEvent)

func (*Table) FocusGained added in v2.4.0 

func (t *Table) FocusGained()

FocusGained is called after this table has gained focus.

func (*Table) FocusLost added in v2.4.0 

func (t *Table) FocusLost()

FocusLost is called after this Table has lost focus.

func (*Table) MouseDown added in v2.4.0 

func (t *Table) MouseDown(e *desktop.MouseEvent)

MouseDown response to desktop mouse event

func (*Table) MouseIn added in v2.4.0 

func (t *Table) MouseIn(ev *desktop.MouseEvent)

func (*Table) MouseMoved added in v2.4.0 

func (t *Table) MouseMoved(ev *desktop.MouseEvent)

func (*Table) MouseOut added in v2.4.0 

func (t *Table) MouseOut()

func (*Table) MouseUp added in v2.4.0 

func (t *Table) MouseUp(*desktop.MouseEvent)

MouseUp response to desktop mouse event

func (*Table) RefreshItem added in v2.4.0 

func (t *Table) RefreshItem(id TableCellID)

RefreshItem refreshes a single item, specified by the item ID passed in.

Since: 2.4

func (*Table) ScrollTo added in v2.1.0 

func (t *Table) ScrollTo(id TableCellID)

ScrollTo will scroll to the given cell without changing the selection. Attempting to scroll beyond the limits of the table will scroll to the edge of the table instead.

Since: 2.1

func (*Table) ScrollToBottom added in v2.1.0 

func (t *Table) ScrollToBottom()

ScrollToBottom scrolls to the last row in the table

Since: 2.1

func (*Table) ScrollToLeading added in v2.1.0 

func (t *Table) ScrollToLeading()

ScrollToLeading scrolls horizontally to the leading edge of the table

Since: 2.1

func (*Table) ScrollToOffset added in v2.6.0 

func (t *Table) ScrollToOffset(off fyne.Position)

ScrollToOffset scrolls the table to a specific position

Since: 2.6

func (*Table) ScrollToTop added in v2.1.0 

func (t *Table) ScrollToTop()

ScrollToTop scrolls to the first row in the table

Since: 2.1

func (*Table) ScrollToTrailing added in v2.1.0 

func (t *Table) ScrollToTrailing()

ScrollToTrailing scrolls horizontally to the trailing edge of the table

Since: 2.1

func (*Table) Select 

func (t *Table) Select(id TableCellID)

Select will mark the specified cell as selected.

func (*Table) SetColumnWidth 

func (t *Table) SetColumnWidth(id int, width float32)

SetColumnWidth supports changing the width of the specified column. Columns normally take the width of the template cell returned from the CreateCell callback. The width parameter uses the same units as a fyne.Size type and refers to the internal content width not including the divider size.

Since: 1.4.1

func (*Table) SetRowHeight added in v2.3.0 

func (t *Table) SetRowHeight(id int, height float32)

SetRowHeight supports changing the height of the specified row. Rows normally take the height of the template cell returned from the CreateCell callback. The height parameter uses the same units as a fyne.Size type and refers to the internal content height not including the divider size.

Since: 2.3

func (*Table) Tapped added in v2.4.0 

func (t *Table) Tapped(e *fyne.PointEvent)

func (*Table) TouchCancel added in v2.4.0 

func (t *Table) TouchCancel(*mobile.TouchEvent)

TouchCancel response to mobile touch event

func (*Table) TouchDown added in v2.4.0 

func (t *Table) TouchDown(e *mobile.TouchEvent)

TouchDown response to mobile touch event

func (*Table) TouchUp added in v2.4.0 

func (t *Table) TouchUp(*mobile.TouchEvent)

TouchUp response to mobile touch event

func (*Table) TypedKey added in v2.4.0 

func (t *Table) TypedKey(event *fyne.KeyEvent)

TypedKey is called if a key event happens while this Table is focused.

func (*Table) TypedRune added in v2.4.0 

func (t *Table) TypedRune(_ rune)

TypedRune is called if a text event happens while this Table is focused.

func (*Table) Unselect 

func (t *Table) Unselect(id TableCellID)

Unselect will mark the cell provided by id as unselected.

func (*Table) UnselectAll added in v2.1.0 

func (t *Table) UnselectAll()

UnselectAll will mark all cells as unselected.

Since: 2.1

type TableCellID 

type TableCellID struct {
	Row int
	Col int
}

TableCellID is a type that represents a cell's position in a table based on its row and column location.

type TextGrid 

type TextGrid struct {
	BaseWidget
	Rows []TextGridRow

	ShowLineNumbers bool
	ShowWhitespace  bool
	TabWidth        int // If set to 0 the fyne.DefaultTabWidth is used

	// Scroll can be used to turn off the scrolling of our TextGrid.
	//
	// Since: 2.6
	Scroll fyne.ScrollDirection
	// contains filtered or unexported fields
}

TextGrid is a monospaced grid of characters. This is designed to be used by a text editor, code preview or terminal emulator.

func NewTextGrid 

func NewTextGrid() *TextGrid

NewTextGrid creates a new empty TextGrid widget.

func NewTextGridFromString 

func NewTextGridFromString(content string) *TextGrid

NewTextGridFromString creates a new TextGrid widget with the specified string content.

func (*TextGrid) Append added in v2.6.0 

func (t *TextGrid) Append(text string)

Append will add new lines to the end of this TextGrid. The first character will be at the beginning of a new line and any newline characters will split the text further.

Since: 2.6

func (*TextGrid) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*TextGrid) CursorLocationForPosition added in v2.6.0 

func (t *TextGrid) CursorLocationForPosition(p fyne.Position) (row, col int)

CursorLocationForPosition returns the location where a cursor would be if it was located in the cell under the requested position. If the grid is scrolled the position will refer to the visible offset and not the distance from the top left of the overall document.

Since: 2.6

func (*TextGrid) MinSize 

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

MinSize returns the smallest size this widget can shrink to

func (*TextGrid) PositionForCursorLocation added in v2.6.0 

func (t *TextGrid) PositionForCursorLocation(row, col int) fyne.Position

PositionForCursorLocation returns the relative position in this TextGrid for the cell at position row, col. If the grid has been scrolled this will be taken into account so that the position compared to top left will refer to the requested location.

Since: 2.6

func (*TextGrid) Resize 

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

Resize is called when this widget changes size. We should make sure that we refresh cells.

func (*TextGrid) Row 

func (t *TextGrid) Row(row int) TextGridRow

Row returns a copy of the content in a specified row as a TextGridRow. If the index is out of bounds it returns an empty row object.

func (*TextGrid) RowText 

func (t *TextGrid) RowText(row int) string

RowText returns a string representation of the content at the row specified. If the index is out of bounds it returns an empty string.

func (*TextGrid) ScrollToBottom added in v2.7.0 

func (t *TextGrid) ScrollToBottom()

ScrollToBottom will scroll content to container bottom - to show latest info which end user just added

Since: 2.7

func (*TextGrid) ScrollToTop added in v2.7.0 

func (t *TextGrid) ScrollToTop()

ScrollToTop will scroll content to container top

Since: 2.7

func (*TextGrid) SetCell 

func (t *TextGrid) SetCell(row, col int, cell TextGridCell)

SetCell sets a grid data to the cell at named row and column.

func (*TextGrid) SetRow 

func (t *TextGrid) SetRow(row int, content TextGridRow)

SetRow updates the specified row of the grid's contents using the specified content and style and then refreshes. If the row is beyond the end of the current buffer it will be expanded. Tab characters are not padded with spaces.

func (*TextGrid) SetRowStyle 

func (t *TextGrid) SetRowStyle(row int, style TextGridStyle)

SetRowStyle sets a grid style to all the cells cell at the specified row. Any cells in this row with their own style will override this value when displayed.

func (*TextGrid) SetRune 

func (t *TextGrid) SetRune(row, col int, r rune)

SetRune sets a character to the cell at named row and column.

func (*TextGrid) SetStyle 

func (t *TextGrid) SetStyle(row, col int, style TextGridStyle)

SetStyle sets a grid style to the cell at named row and column.

func (*TextGrid) SetStyleRange 

func (t *TextGrid) SetStyleRange(startRow, startCol, endRow, endCol int, style TextGridStyle)

SetStyleRange sets a grid style to all the cells between the start row and column through to the end row and column.

func (*TextGrid) SetText 

func (t *TextGrid) SetText(text string)

SetText updates the buffer of this textgrid to contain the specified text. New lines and columns will be added as required. Lines are separated by '\n'. The grid will use default text style and any previous content and style will be removed. Tab characters are padded with spaces to the next tab stop.

func (*TextGrid) Text 

func (t *TextGrid) Text() string

Text returns the contents of the buffer as a single string (with no style information). It reconstructs the lines by joining with a `\n` character. Tab characters have padded spaces removed.

type TextGridCell 

type TextGridCell struct {
	Rune  rune
	Style TextGridStyle
}

TextGridCell represents a single cell in a text grid. It has a rune for the text content and a style associated with it.

type TextGridRow 

type TextGridRow struct {
	Cells []TextGridCell
	Style TextGridStyle
}

TextGridRow represents a row of cells cell in a text grid. It contains the cells for the row and an optional style.

type TextGridStyle 

type TextGridStyle interface {
	Style() fyne.TextStyle
	TextColor() color.Color
	BackgroundColor() color.Color
}

TextGridStyle defines a style that can be applied to a TextGrid cell. 

var (
	// TextGridStyleDefault is a default style for test grid cells
	TextGridStyleDefault TextGridStyle
	// TextGridStyleWhitespace is the style used for whitespace characters, if enabled
	TextGridStyleWhitespace TextGridStyle
)

type TextSegment added in v2.1.0 

type TextSegment struct {
	Style RichTextStyle
	Text  string
	// contains filtered or unexported fields
}

TextSegment represents the styling for a segment of rich text.

Since: 2.1

func (*TextSegment) Inline added in v2.1.0 

func (t *TextSegment) Inline() bool

Inline should return true if this text can be included within other elements, or false if it creates a new block.

func (*TextSegment) Select added in v2.1.0 

func (t *TextSegment) Select(begin, end fyne.Position)

Select tells the segment that the user is selecting the content between the two positions.

func (*TextSegment) SelectedText added in v2.1.0 

func (t *TextSegment) SelectedText() string

SelectedText should return the text representation of any content currently selected through the Select call.

func (*TextSegment) Textual added in v2.1.0 

func (t *TextSegment) Textual() string

Textual returns the content of this segment rendered to plain text.

func (*TextSegment) Unselect added in v2.1.0 

func (t *TextSegment) Unselect()

Unselect tells the segment that the user is has cancelled the previous selection.

func (*TextSegment) Update added in v2.1.0 

func (t *TextSegment) Update(o fyne.CanvasObject)

Update applies the current state of this text segment to an existing visual.

func (*TextSegment) Visual added in v2.1.0 

func (t *TextSegment) Visual() fyne.CanvasObject

Visual returns a new instance of a graphical element required to render this segment.

type Toolbar 

type Toolbar struct {
	BaseWidget
	Items []ToolbarItem
}

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) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer

func (*Toolbar) MinSize 

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

MinSize returns the size that this widget should not shrink below

func (*Toolbar) Prepend 

func (t *Toolbar) Prepend(item ToolbarItem)

Prepend a new ToolbarItem to the start of this Toolbar

type ToolbarAction 

type ToolbarAction struct {
	Icon        fyne.Resource
	OnActivated func() `json:"-"`
	// contains filtered or unexported fields
}

ToolbarAction is push button style of ToolbarItem

func NewToolbarAction 

func NewToolbarAction(icon fyne.Resource, onActivated func()) *ToolbarAction

NewToolbarAction returns a new push button style ToolbarItem

func (*ToolbarAction) Disable added in v2.5.0 

func (t *ToolbarAction) Disable()

Disable this ToolbarAction so that it cannot be interacted with, updating any style appropriately.

Since: 2.5

func (*ToolbarAction) Disabled added in v2.5.0 

func (t *ToolbarAction) Disabled() bool

Disabled returns true if this ToolbarAction is currently disabled or false if it can currently be interacted with.

Since: 2.5

func (*ToolbarAction) Enable added in v2.5.0 

func (t *ToolbarAction) Enable()

Enable this ToolbarAction, updating any style or features appropriately.

Since: 2.5

func (*ToolbarAction) SetIcon added in v2.2.0 

func (t *ToolbarAction) SetIcon(icon fyne.Resource)

SetIcon updates the icon on a ToolbarItem

Since: 2.2

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

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 NewToolbarSeparator 

func NewToolbarSeparator() *ToolbarSeparator

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

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 NewToolbarSpacer 

func NewToolbarSpacer() *ToolbarSpacer

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

func (*ToolbarSpacer) ToolbarObject 

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

ToolbarObject gets the actual spacer object for this ToolbarSpacer

type Tree 

type Tree struct {
	BaseWidget
	Root TreeNodeID

	// HideSeparators hides the separators between tree nodes
	//
	// Since: 2.5
	HideSeparators bool

	ChildUIDs      func(uid TreeNodeID) (c []TreeNodeID)                     `json:"-"` // Return a sorted slice of Children TreeNodeIDs for the given Node TreeNodeID
	CreateNode     func(branch bool) (o fyne.CanvasObject)                   `json:"-"` // Return a CanvasObject that can represent a Branch (if branch is true), or a Leaf (if branch is false)
	IsBranch       func(uid TreeNodeID) (ok bool)                            `json:"-"` // Return true if the given TreeNodeID represents a Branch
	OnBranchClosed func(uid TreeNodeID)                                      `json:"-"` // Called when a Branch is closed
	OnBranchOpened func(uid TreeNodeID)                                      `json:"-"` // Called when a Branch is opened
	OnSelected     func(uid TreeNodeID)                                      `json:"-"` // Called when the Node with the given TreeNodeID is selected.
	OnUnselected   func(uid TreeNodeID)                                      `json:"-"` // Called when the Node with the given TreeNodeID is unselected.
	UpdateNode     func(uid TreeNodeID, branch bool, node fyne.CanvasObject) `json:"-"` // Called to update the given CanvasObject to represent the data at the given TreeNodeID
	// contains filtered or unexported fields
}

Tree widget displays hierarchical data. Each node of the tree must be identified by a Unique TreeNodeID.

Since: 1.4

func NewTree 

func NewTree(childUIDs func(TreeNodeID) []TreeNodeID, isBranch func(TreeNodeID) bool, create func(bool) fyne.CanvasObject, update func(TreeNodeID, bool, fyne.CanvasObject)) *Tree

NewTree returns a new performant tree widget defined by the passed functions. childUIDs returns the child TreeNodeIDs of the given node. isBranch returns true if the given node is a branch, false if it is a leaf. create returns a new template object that can be cached. update is used to apply data at specified data location to the passed template CanvasObject.

Since: 1.4

func NewTreeWithData added in v2.4.0 

func NewTreeWithData(data binding.DataTree, createItem func(bool) fyne.CanvasObject, updateItem func(binding.DataItem, bool, fyne.CanvasObject)) *Tree

NewTreeWithData creates a new tree widget that will display the contents of the provided data.

Since: 2.4

func NewTreeWithStrings 

func NewTreeWithStrings(data map[string][]string) (t *Tree)

NewTreeWithStrings creates a new tree with the given string map. Data must contain a mapping for the root, which defaults to empty string ("").

Since: 1.4

func (*Tree) CloseAllBranches 

func (t *Tree) CloseAllBranches()

CloseAllBranches closes all branches in the tree.

func (*Tree) CloseBranch 

func (t *Tree) CloseBranch(uid TreeNodeID)

CloseBranch closes the branch with the given TreeNodeID.

func (*Tree) CreateRenderer 

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

CreateRenderer is a private method to Fyne which links this widget to its renderer.

func (*Tree) FocusGained added in v2.4.0 

func (t *Tree) FocusGained()

FocusGained is called after this Tree has gained focus.

func (*Tree) FocusLost added in v2.4.0 

func (t *Tree) FocusLost()

FocusLost is called after this Tree has lost focus.

func (*Tree) IsBranchOpen 

func (t *Tree) IsBranchOpen(uid TreeNodeID) bool

IsBranchOpen returns true if the branch with the given TreeNodeID is expanded.

func (*Tree) MinSize 

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

MinSize returns the size that this widget should not shrink below.

func (*Tree) OpenAllBranches 

func (t *Tree) OpenAllBranches()

OpenAllBranches opens all branches in the tree.

func (*Tree) OpenBranch 

func (t *Tree) OpenBranch(uid TreeNodeID)

OpenBranch opens the branch with the given TreeNodeID.

func (*Tree) RefreshItem added in v2.4.0 

func (t *Tree) RefreshItem(id TreeNodeID)

RefreshItem refreshes a single item, specified by the item ID passed in.

Since: 2.4

func (*Tree) Resize 

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

Resize sets a new size for a widget.

func (*Tree) ScrollTo added in v2.1.0 

func (t *Tree) ScrollTo(uid TreeNodeID)

ScrollTo scrolls to the node with the given id.

Since 2.1

func (*Tree) ScrollToBottom added in v2.1.0 

func (t *Tree) ScrollToBottom()

ScrollToBottom scrolls to the bottom of the tree.

Since 2.1

func (*Tree) ScrollToOffset added in v2.6.0 

func (t *Tree) ScrollToOffset(offset float32)

ScrollToOffset scrolls the tree to the given offset position.

Since: 2.6

func (*Tree) ScrollToTop added in v2.1.0 

func (t *Tree) ScrollToTop()

ScrollToTop scrolls to the top of the tree.

Since 2.1

func (*Tree) Select 

func (t *Tree) Select(uid TreeNodeID)

Select marks the specified node to be selected.

func (*Tree) ToggleBranch 

func (t *Tree) ToggleBranch(uid string)

ToggleBranch flips the state of the branch with the given TreeNodeID.

func (*Tree) TypedKey added in v2.4.0 

func (t *Tree) TypedKey(event *fyne.KeyEvent)

TypedKey is called if a key event happens while this Tree is focused.

func (*Tree) TypedRune added in v2.4.0 

func (t *Tree) TypedRune(_ rune)

TypedRune is called if a text event happens while this Tree is focused.

func (*Tree) Unselect 

func (t *Tree) Unselect(uid TreeNodeID)

Unselect marks the specified node to be not selected.

func (*Tree) UnselectAll added in v2.1.0 

func (t *Tree) UnselectAll()

UnselectAll sets all nodes to be not selected.

Since: 2.1

type TreeNodeID 

type TreeNodeID = string

TreeNodeID represents the unique id of a tree node.

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.