internal

package
v2.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 28, 2023 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const HintsEnabled = false

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

Variables

This section is empty.

Functions

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.

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

type Docs struct {
	RootDocURI fyne.URI
}

Docs is an internal implementation of the document features of the Storage interface. It is based on top of the current `file` repository and is rooted at RootDocURI.

func (*Docs) Create added in v2.1.0

func (d *Docs) Create(name string) (fyne.URIWriteCloser, error)

Create will create a new document ready for writing, you must write something and close the returned writer for the create process to complete. If the document for this app with that name already exists a storage.ErrAlreadyExists error will be returned.

func (*Docs) List added in v2.1.0

func (d *Docs) List() []string

List returns all documents that have been saved by the current application. Remember to use `app.NewWithID` so that your storage is unique.

func (*Docs) Open added in v2.1.0

func (d *Docs) Open(name string) (fyne.URIReadCloser, error)

Open will grant access to the contents of the named file. If an error occurs it is returned instead.

func (*Docs) Remove added in v2.1.0

func (d *Docs) Remove(name string) error

Remove will delete the document with the specified name, if it exists

func (*Docs) Save added in v2.1.0

func (d *Docs) Save(name string) (fyne.URIWriteCloser, error)

Save will open a document ready for writing, you close the returned writer for the save to complete. If the document for this app with that name does not exist a storage.ErrNotExists error will be returned.

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. The passed 'listener' should not try to write values.

func (*InMemoryPreferences) Bool

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

Bool looks up a boolean value for the key

func (*InMemoryPreferences) BoolList added in v2.4.0

func (p *InMemoryPreferences) BoolList(key string) []bool

func (*InMemoryPreferences) BoolListWithFallback added in v2.4.0

func (p *InMemoryPreferences) BoolListWithFallback(key string, fallback []bool) []bool

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) ChangeListeners added in v2.3.0

func (p *InMemoryPreferences) ChangeListeners() []func()

ChangeListeners returns the list of listeners registered for this set of preferences.

func (*InMemoryPreferences) Float

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

Float looks up a float64 value for the key

func (*InMemoryPreferences) FloatList added in v2.4.0

func (p *InMemoryPreferences) FloatList(key string) []float64

func (*InMemoryPreferences) FloatListWithFallback added in v2.4.0

func (p *InMemoryPreferences) FloatListWithFallback(key string, fallback []float64) []float64

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) IntList added in v2.4.0

func (p *InMemoryPreferences) IntList(key string) []int

func (*InMemoryPreferences) IntListWithFallback added in v2.4.0

func (p *InMemoryPreferences) IntListWithFallback(key string, fallback []int) []int

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) SetBoolList added in v2.4.0

func (p *InMemoryPreferences) SetBoolList(key string, value []bool)

func (*InMemoryPreferences) SetFloat

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

SetFloat saves a float64 value for the given key

func (*InMemoryPreferences) SetFloatList added in v2.4.0

func (p *InMemoryPreferences) SetFloatList(key string, value []float64)

func (*InMemoryPreferences) SetInt

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

SetInt saves an integer value for the given key

func (*InMemoryPreferences) SetIntList added in v2.4.0

func (p *InMemoryPreferences) SetIntList(key string, value []int)

func (*InMemoryPreferences) SetString

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

SetString saves a string value for the given key

func (*InMemoryPreferences) SetStringList added in v2.4.0

func (p *InMemoryPreferences) SetStringList(key string, value []string)

func (*InMemoryPreferences) String

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

String looks up a string value for the key

func (*InMemoryPreferences) StringList added in v2.4.0

func (p *InMemoryPreferences) StringList(key string) []string

func (*InMemoryPreferences) StringListWithFallback added in v2.4.0

func (p *InMemoryPreferences) StringListWithFallback(key string, fallback []string) []string

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.

Directories

Path Synopsis
Package async provides unbounded channel and queue structures that are designed for caching unlimited number of a concrete type.
Package async provides unbounded channel and queue structures that are designed for caching unlimited number of a concrete type.
glfw
Package glfw provides a full Fyne desktop driver that uses the system OpenGL libraries.
Package glfw provides a full Fyne desktop driver that uses the system OpenGL libraries.
mobile/app
Package app lets you write portable all-Go apps for Android and iOS.
Package app lets you write portable all-Go apps for Android and iOS.
mobile/event/key
Package key defines an event for physical keyboard keys.
Package key defines an event for physical keyboard keys.
mobile/event/lifecycle
Package lifecycle defines an event for an app's lifecycle.
Package lifecycle defines an event for an app's lifecycle.
mobile/event/paint
Package paint defines an event for the app being ready to paint.
Package paint defines an event for the app being ready to paint.
mobile/event/size
Package size defines an event for the dimensions, physical resolution and orientation of the app's window.
Package size defines an event for the dimensions, physical resolution and orientation of the app's window.
mobile/event/touch
Package touch defines an event for touch input.
Package touch defines an event for touch input.
mobile/gl
Package gl implements Go bindings for OpenGL ES 2.0 and ES 3.0.
Package gl implements Go bindings for OpenGL ES 2.0 and ES 3.0.
mobile/mobileinit
Package mobileinit contains common initialization logic for mobile platforms that is relevant to both all-Go apps and gobind-based apps.
Package mobileinit contains common initialization logic for mobile platforms that is relevant to both all-Go apps and gobind-based apps.
gl
Package gl provides a full Fyne render implementation using system OpenGL libraries.
Package gl provides a full Fyne render implementation using system OpenGL libraries.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL