app

Documentation

Index

• Variables
• func ApplySettings(set fyne.Settings, app fyne.App)
• func ApplySettingsWithCallback(set fyne.Settings, app fyne.App, onEveryWindow func(w fyne.Window))
• func ApplyThemeTo(content fyne.CanvasObject, canv fyne.Canvas)
• func DefaultVariant() fyne.ThemeVariant
• func RootConfigDir() string
• type FocusManager
  • func NewFocusManager(c fyne.CanvasObject) *FocusManager
  • func (f *FocusManager) Focus(obj fyne.Focusable) bool
  • func (f *FocusManager) FocusGained()
  • func (f *FocusManager) FocusLost()
  • func (f *FocusManager) FocusNext()
  • func (f *FocusManager) FocusPrevious()
  • func (f *FocusManager) Focused() fyne.Focusable
• type Lifecycle
  • func (l *Lifecycle) DestroyEventQueue()
  • func (l *Lifecycle) InitEventQueue()
  • func (l *Lifecycle) OnEnteredForeground() func()
  • func (l *Lifecycle) OnExitedForeground() func()
  • func (l *Lifecycle) OnStarted() func()
  • func (l *Lifecycle) OnStopped() func()
  • func (l *Lifecycle) QueueEvent(fn func())
  • func (l *Lifecycle) RunEventQueue()
  • func (l *Lifecycle) SetOnEnteredForeground(f func())
  • func (l *Lifecycle) SetOnExitedForeground(f func())
  • func (l *Lifecycle) SetOnStarted(f func())
  • func (l *Lifecycle) SetOnStopped(f func())
  • func (l *Lifecycle) SetOnStoppedHookExecuted(f func())
  • func (l *Lifecycle) WaitForEvents()

Variables

var (
	MetaIcon    = "" // this will contain base64 encoded icon bytes
	MetaID      = "com.example"
	MetaName    = "Fyne App"
	MetaVersion = "1.0.0"
	MetaBuild   = "1"
)

these internal variables are set by the fyne build command so that the "FyneApp.toml" data is readable at runtime.

var CurrentVariant atomic.Uint64

CurrentVariant contains the system’s theme variant. It is intended for internal use, only!

Functions

func ApplySettings

func ApplySettings(set fyne.Settings, app fyne.App)

ApplySettings ensures that all widgets and themeable objects in an application will be updated for the current theme. It also checks that scale changes are reflected if required

func ApplySettingsWithCallback

func ApplySettingsWithCallback(set fyne.Settings, app fyne.App, onEveryWindow func(w fyne.Window))

ApplySettingsWithCallback ensures that all widgets and themeable objects in an application will be updated for the current theme. It also checks that scale changes are reflected if required. Also it will call `onEveryWindow` on every window interaction

func ApplyThemeTo

func ApplyThemeTo(content fyne.CanvasObject, canv fyne.Canvas)

ApplyThemeTo ensures that the specified canvasobject and all widgets and themeable objects will be updated for the current theme.

func DefaultVariant

func DefaultVariant() fyne.ThemeVariant

DefaultVariant returns the systems default fyne.ThemeVariant. Normally, you should not need this. It is extracted out of the root app package to give the settings app access to it.

func RootConfigDir

func RootConfigDir() string

Types

type FocusManager

type FocusManager struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

FocusManager represents a standard manager of input focus for a canvas

func NewFocusManager

func NewFocusManager(c fyne.CanvasObject) *FocusManager

NewFocusManager returns a new instance of the standard focus manager for a canvas.

func (*FocusManager) Focus

func (f *FocusManager) Focus(obj fyne.Focusable) bool

Focus focuses the given obj.

func (*FocusManager) FocusGained

func (f *FocusManager) FocusGained()

FocusGained signals to the manager that its content got focus (due to window/overlay switch for instance).

func (*FocusManager) FocusLost

func (f *FocusManager) FocusLost()

FocusLost signals to the manager that its content lost focus (due to window/overlay switch for instance).

func (*FocusManager) FocusNext

func (f *FocusManager) FocusNext()

FocusNext will find the item after the current that can be focused and focus it. If current is nil then the first focusable item in the canvas will be focused.

func (*FocusManager) FocusPrevious

func (f *FocusManager) FocusPrevious()

FocusPrevious will find the item before the current that can be focused and focus it. If current is nil then the last focusable item in the canvas will be focused.

func (*FocusManager) Focused

func (f *FocusManager) Focused() fyne.Focusable

Focused returns the currently focused object or nil if none.

type Lifecycle

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

Lifecycle represents the various phases that an app can transition through.

Since: 2.1

func (*Lifecycle) DestroyEventQueue

func (l *Lifecycle) DestroyEventQueue()

DestroyEventQueue destroys the event queue.

func (*Lifecycle) InitEventQueue

func (l *Lifecycle) InitEventQueue()

InitEventQueue initializes the event queue.

func (*Lifecycle) OnEnteredForeground

func (l *Lifecycle) OnEnteredForeground() func()

OnEnteredForeground returns the focus gained hook, if one is registered.

func (*Lifecycle) OnExitedForeground

func (l *Lifecycle) OnExitedForeground() func()

OnExitedForeground returns the focus lost hook, if one is registered.

func (*Lifecycle) OnStarted

func (l *Lifecycle) OnStarted() func()

OnStarted returns the started hook, if one is registered.

func (*Lifecycle) OnStopped

func (l *Lifecycle) OnStopped() func()

OnStopped returns the stopped hook, if one is registered.

func (*Lifecycle) QueueEvent

func (l *Lifecycle) QueueEvent(fn func())

QueueEvent uses this method to queue up a callback that handles an event. This ensures user interaction events for a given window are processed in order.

func (*Lifecycle) RunEventQueue

func (l *Lifecycle) RunEventQueue()

RunEventQueue runs the event queue. This should called inside a go routine. This function blocks.

func (*Lifecycle) SetOnEnteredForeground

func (l *Lifecycle) SetOnEnteredForeground(f func())

SetOnEnteredForeground hooks into the app becoming foreground.

func (*Lifecycle) SetOnExitedForeground

func (l *Lifecycle) SetOnExitedForeground(f func())

SetOnExitedForeground hooks into the app having moved to the background. Depending on the platform it may still be visible but will not receive keyboard events. On some systems hover or desktop mouse move events may still occur.

func (*Lifecycle) SetOnStarted

func (l *Lifecycle) SetOnStarted(f func())

SetOnStarted hooks into an event that says the app is now running.

func (*Lifecycle) SetOnStopped

func (l *Lifecycle) SetOnStopped(f func())

SetOnStopped hooks into an event that says the app is no longer running.

func (*Lifecycle) SetOnStoppedHookExecuted

func (l *Lifecycle) SetOnStoppedHookExecuted(f func())

SetOnStoppedHookExecuted is an internal function that lets Fyne schedule a clean-up after the user-provided stopped hook. It should only be called once during an application start-up.

func (*Lifecycle) WaitForEvents

func (l *Lifecycle) WaitForEvents()

WaitForEvents wait for all the events.