test

Documentation

Overview

Package test provides utility drivers for running UI tests without rendering

Index

• func Canvas() fyne.Canvas
• func NewApp() fyne.App
• func NewClipboard() fyne.Clipboard
• func NewDriver() fyne.Driver
• func NewDriverWithPainter(painter SoftwarePainter) fyne.Driver
• func NewWindow(content fyne.CanvasObject) fyne.Window
• func Tap(obj fyne.Tappable)
• func TapAt(obj fyne.Tappable, pos fyne.Position)
• func TapSecondary(obj fyne.Tappable)
• func TapSecondaryAt(obj fyne.Tappable, pos fyne.Position)
• func Type(obj fyne.Focusable, chars string)
• func TypeOnCanvas(c fyne.Canvas, chars string)
• type SoftwarePainter
• type WindowlessCanvas
  • func NewCanvas() WindowlessCanvas
  • func NewCanvasWithPainter(painter SoftwarePainter) WindowlessCanvas

Functions

func Canvas

func Canvas() fyne.Canvas

Canvas returns a reusable in-memory canvas used for testing

func NewApp

func NewApp() fyne.App

NewApp returns a new dummy app used for testing. It loads a test driver which creates a virtual window in memory for testing.

func NewClipboard

func NewClipboard() fyne.Clipboard

NewClipboard returns a single use in-memory clipboard used for testing

func NewDriver

func NewDriver() fyne.Driver

NewDriver sets up and registers a new dummy driver for test purpose

func NewDriverWithPainter

func NewDriverWithPainter(painter SoftwarePainter) fyne.Driver

NewDriverWithPainter creates a new dummy driver that will pass the given painter to all canvases created

func NewWindow

func NewWindow(content fyne.CanvasObject) fyne.Window

NewWindow creates and registers a new window for test purposes

func Tap

func Tap(obj fyne.Tappable)

Tap simulates a left mouse click on the specified object.

func TapAt

func TapAt(obj fyne.Tappable, pos fyne.Position)

TapAt simulates a left mouse click on the passed object at a specified place within it.

func TapSecondary

func TapSecondary(obj fyne.Tappable)

TapSecondary simulates a right mouse click on the specified object.

func TapSecondaryAt

func TapSecondaryAt(obj fyne.Tappable, pos fyne.Position)

TapSecondaryAt simulates a right mouse click on the passed object at a specified place within it.

func Type

func Type(obj fyne.Focusable, chars string)

Type performs a series of key events to simulate typing of a value into the specified object. The focusable object will be focused before typing begins. The chars parameter will be input one rune at a time to the focused object.

func TypeOnCanvas

func TypeOnCanvas(c fyne.Canvas, chars string)

TypeOnCanvas is like the Type function but it passes the key events to the canvas object rather than a focusable widget.

Types

type SoftwarePainter

type SoftwarePainter interface {
	Paint(fyne.Canvas) image.Image
}

SoftwarePainter describes a simple type that can render canvases

type WindowlessCanvas

type WindowlessCanvas interface {
	fyne.Canvas

	Resize(fyne.Size)

	Padded() bool
	SetPadded(bool)
}

WindowlessCanvas provides functionality for a canvas to operate without a window

func NewCanvas

func NewCanvas() WindowlessCanvas

NewCanvas returns a single use in-memory canvas used for testing

func NewCanvasWithPainter

func NewCanvasWithPainter(painter SoftwarePainter) WindowlessCanvas

NewCanvasWithPainter allows creation of an in-memory canvas with a specific painter. The painter will be used to render in the Capture() call.