internal

Documentation

Index

• func HintsEnabled() bool
• func LogHint(reason string)
• func ScaleInt(c fyne.Canvas, v float32) int
• func UnscaleInt(c fyne.Canvas, v int) float32
• type ClipItem
  • func (i *ClipItem) Intersect(p fyne.Position, s fyne.Size) *ClipItem
  • func (i *ClipItem) Rect() (fyne.Position, fyne.Size)
• type ClipStack
  • func (c *ClipStack) Length() int
  • func (c *ClipStack) Pop() *ClipItem
  • func (c *ClipStack) Push(p fyne.Position, s fyne.Size) *ClipItem
  • func (c *ClipStack) Top() *ClipItem
• type InMemoryPreferences
  • func NewInMemoryPreferences() *InMemoryPreferences
  • func (p *InMemoryPreferences) AddChangeListener(listener func())
  • func (p *InMemoryPreferences) Bool(key string) bool
  • func (p *InMemoryPreferences) BoolWithFallback(key string, fallback bool) bool
  • func (p *InMemoryPreferences) Float(key string) float64
  • func (p *InMemoryPreferences) FloatWithFallback(key string, fallback float64) float64
  • func (p *InMemoryPreferences) Int(key string) int
  • func (p *InMemoryPreferences) IntWithFallback(key string, fallback int) int
  • func (p *InMemoryPreferences) ReadValues(fn func(map[string]interface{}))
  • func (p *InMemoryPreferences) RemoveValue(key string)
  • func (p *InMemoryPreferences) SetBool(key string, value bool)
  • func (p *InMemoryPreferences) SetFloat(key string, value float64)
  • func (p *InMemoryPreferences) SetInt(key string, value int)
  • func (p *InMemoryPreferences) SetString(key string, value string)
  • func (p *InMemoryPreferences) String(key string) string
  • func (p *InMemoryPreferences) StringWithFallback(key, fallback string) string
  • func (p *InMemoryPreferences) WriteValues(fn func(map[string]interface{}))
• type OverlayStack
  • func (s *OverlayStack) Add(overlay fyne.CanvasObject)
  • func (s *OverlayStack) List() []fyne.CanvasObject
  • func (s *OverlayStack) ListFocusManagers() []*app.FocusManager
  • func (s *OverlayStack) Remove(overlay fyne.CanvasObject)
  • func (s *OverlayStack) Top() fyne.CanvasObject
  • func (s *OverlayStack) TopFocusManager() *app.FocusManager

Functions

func HintsEnabled

func HintsEnabled() bool

HintsEnabled returns false to indicate that hints are not currently switched on. To enable please rebuild with "-tags hints" parameters.

func LogHint

func LogHint(reason string)

LogHint reports a developer hint that should be followed to improve their app. This does nothing unless the "hints" build flag is used.

func ScaleInt

func ScaleInt(c fyne.Canvas, v float32) int

ScaleInt converts a fyne coordinate in the given canvas to a screen coordinate

func UnscaleInt

func UnscaleInt(c fyne.Canvas, v int) float32

UnscaleInt converts a screen coordinate for a given canvas to a fyne coordinate

Types

type ClipItem

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

ClipItem represents a single clip in a clip stack, denoted by a size and position.

func (*ClipItem) Intersect

func (i *ClipItem) Intersect(p fyne.Position, s fyne.Size) *ClipItem

Intersect returns a new clip item that is the intersection of the requested parameters and this clip.

func (*ClipItem) Rect

func (i *ClipItem) Rect() (fyne.Position, fyne.Size)

Rect returns the position and size parameters of the clip.

type ClipStack

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

ClipStack keeps track of the areas that should be clipped when drawing a canvas. If no clips are present then adding one will be added as-is. Subsequent items pushed will be completely within the previous clip.

func (*ClipStack) Length

func (c *ClipStack) Length() int

Length returns the number of items in this clip stack. 0 means no clip.

func (*ClipStack) Pop

func (c *ClipStack) Pop() *ClipItem

Pop removes the current top clip and returns it.

func (*ClipStack) Push

func (c *ClipStack) Push(p fyne.Position, s fyne.Size) *ClipItem

Push a new clip onto this stack at position and size specified. The returned clip item is the result of calculating the intersection of the requested clip and it's parent.

func (*ClipStack) Top

func (c *ClipStack) Top() *ClipItem

Top returns the current clip item - it will always be within the bounds of any parent clips.

type InMemoryPreferences

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

InMemoryPreferences provides an implementation of the fyne.Preferences API that is stored in memory.

func NewInMemoryPreferences

func NewInMemoryPreferences() *InMemoryPreferences

NewInMemoryPreferences creates a new preferences implementation stored in memory

func (*InMemoryPreferences) AddChangeListener

func (p *InMemoryPreferences) AddChangeListener(listener func())

AddChangeListener allows code to be notified when some preferences change. This will fire on any update.

func (*InMemoryPreferences) Bool

func (p *InMemoryPreferences) Bool(key string) bool

Bool looks up a boolean value for the key

func (*InMemoryPreferences) BoolWithFallback

func (p *InMemoryPreferences) BoolWithFallback(key string, fallback bool) bool

BoolWithFallback looks up a boolean value and returns the given fallback if not found

func (*InMemoryPreferences) Float

func (p *InMemoryPreferences) Float(key string) float64

Float looks up a float64 value for the key

func (*InMemoryPreferences) FloatWithFallback

func (p *InMemoryPreferences) FloatWithFallback(key string, fallback float64) float64

FloatWithFallback looks up a float64 value and returns the given fallback if not found

func (*InMemoryPreferences) Int

func (p *InMemoryPreferences) Int(key string) int

Int looks up an integer value for the key

func (*InMemoryPreferences) IntWithFallback

func (p *InMemoryPreferences) IntWithFallback(key string, fallback int) int

IntWithFallback looks up an integer value and returns the given fallback if not found

func (*InMemoryPreferences) ReadValues

func (p *InMemoryPreferences) ReadValues(fn func(map[string]interface{}))

ReadValues provides read access to the underlying value map - for internal use only... You should not retain a reference to the map nor write to the values in the callback function

func (*InMemoryPreferences) RemoveValue

func (p *InMemoryPreferences) RemoveValue(key string)

RemoveValue deletes a value on the given key

func (*InMemoryPreferences) SetBool

func (p *InMemoryPreferences) SetBool(key string, value bool)

SetBool saves a boolean value for the given key

func (*InMemoryPreferences) SetFloat

func (p *InMemoryPreferences) SetFloat(key string, value float64)

SetFloat saves a float64 value for the given key

func (*InMemoryPreferences) SetInt

func (p *InMemoryPreferences) SetInt(key string, value int)

SetInt saves an integer value for the given key

func (*InMemoryPreferences) SetString

func (p *InMemoryPreferences) SetString(key string, value string)

SetString saves a string value for the given key

func (*InMemoryPreferences) String

func (p *InMemoryPreferences) String(key string) string

String looks up a string value for the key

func (*InMemoryPreferences) StringWithFallback

func (p *InMemoryPreferences) StringWithFallback(key, fallback string) string

StringWithFallback looks up a string value and returns the given fallback if not found

func (*InMemoryPreferences) WriteValues

func (p *InMemoryPreferences) WriteValues(fn func(map[string]interface{}))

WriteValues provides write access to the underlying value map - for internal use only... You should not retain a reference to the map passed to the callback function

type OverlayStack

type OverlayStack struct {
	OnChange func()
	Canvas   fyne.Canvas
	// contains filtered or unexported fields
}

OverlayStack implements fyne.OverlayStack

func (*OverlayStack) Add

func (s *OverlayStack) Add(overlay fyne.CanvasObject)

Add puts an overlay on the stack.

Implements: fyne.OverlayStack

func (*OverlayStack) List

func (s *OverlayStack) List() []fyne.CanvasObject

List returns all overlays on the stack from bottom to top.

Implements: fyne.OverlayStack

func (*OverlayStack) ListFocusManagers

func (s *OverlayStack) ListFocusManagers() []*app.FocusManager

ListFocusManagers returns all focus managers on the stack from bottom to top.

func (*OverlayStack) Remove

func (s *OverlayStack) Remove(overlay fyne.CanvasObject)

Remove deletes an overlay and all overlays above it from the stack.

Implements: fyne.OverlayStack

func (*OverlayStack) Top

func (s *OverlayStack) Top() fyne.CanvasObject

Top returns the top-most overlay of the stack.

Implements: fyne.OverlayStack

func (*OverlayStack) TopFocusManager

func (s *OverlayStack) TopFocusManager() *app.FocusManager

TopFocusManager returns the app.FocusManager assigned to the top-most overlay of the stack.