fyneadvancedlist

Documentation

Index

• type List
  • func NewList(length func() int, createItem func() fyne.CanvasObject, ...) *List
  • func NewListWithData(data binding.DataList, createItem func() fyne.CanvasObject, ...) *List
  • func (l *List) CreateRenderer() fyne.WidgetRenderer
  • func (l *List) FocusGained()
  • func (l *List) FocusLost()
  • func (l *List) GetScrollOffset() float32
  • func (l *List) ItemForID(id ListItemID) fyne.CanvasObject
  • func (l *List) MinSize() fyne.Size
  • func (l *List) RefreshItem(id ListItemID)
  • func (l *List) Resize(s fyne.Size)
  • func (l *List) ScrollTo(id ListItemID)
  • func (l *List) ScrollToBottom()
  • func (l *List) ScrollToOffset(offset float32)
  • func (l *List) ScrollToTop()
  • func (l *List) Select(id ListItemID)
  • func (l *List) SetItemHeight(id ListItemID, height float32)
  • func (l *List) TypedKey(event *fyne.KeyEvent)
  • func (l *List) TypedRune(_ rune)
  • func (l *List) Unselect(id ListItemID)
  • func (l *List) UnselectAll()
• type ListItemID

Types

type List

type List struct {
	widget.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

	// Enable drag-and-drop of rows within the list
	EnableDragging bool

	// OnDragEnd is the callback that is invoked when a row is dragged and dropped.
	// The `draggedTo` value is the ListItemID where the dragged row
	// would be inserted, with a value of  0 meaning before the first item
	// and a value of list.Length() meaning after the last item in the list.
	OnDragEnd func(draggedFrom, draggedTo ListItemID) `json:"-"`

	// OnDragBegin is the callback invoked when a row begins dragging.
	OnDragBegin func(id ListItemID) `json:"-"`
	// 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

func (l *List) FocusGained()

FocusGained is called after this List has gained focus.

Implements: fyne.Focusable

func (*List) FocusLost

func (l *List) FocusLost()

FocusLost is called after this List has lost focus.

Implements: fyne.Focusable

func (*List) GetScrollOffset

func (l *List) GetScrollOffset() float32

GetScrollOffset returns the current scroll offset position

Since: 2.5

func (*List) ItemForID

func (l *List) ItemForID(id ListItemID) fyne.CanvasObject

Returns the item that is currently bound to the given ID, or none of the ID is currently out of the visible range of the list.

Since: Not a core Fyne list API

func (*List) MinSize

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

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

func (*List) RefreshItem

func (l *List) RefreshItem(id ListItemID)

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

Since: 2.4

func (*List) Resize

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

func (l *List) ScrollTo(id ListItemID)

ScrollTo scrolls to the item represented by id

Since: 2.1

func (*List) ScrollToBottom

func (l *List) ScrollToBottom()

ScrollToBottom scrolls to the end of the list

Since: 2.1

func (*List) ScrollToOffset

func (l *List) ScrollToOffset(offset float32)

ScrollToOffset scrolls the list to the given offset position.

Since: 2.5

func (*List) ScrollToTop

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

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

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

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

Implements: fyne.Focusable

func (*List) TypedRune

func (l *List) TypedRune(_ rune)

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

Implements: fyne.Focusable

func (*List) Unselect

func (l *List) Unselect(id ListItemID)

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

func (*List) UnselectAll

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.