ui

Documentation

Index

• Constants
• func NewDesktop(app fyne.App, wm fynedesk.WindowManager, icons fynedesk.ApplicationProvider, ...) fynedesk.Desktop
• func NewEmbeddedDesktop(app fyne.App, icons fynedesk.ApplicationProvider) fynedesk.Desktop
• func ShowAppLauncher()
• type Switcher
  • func ShowAppSwitcher(wins []fynedesk.Window, prov fynedesk.ApplicationProvider) *Switcher
  • func ShowAppSwitcherReverse(wins []fynedesk.Window, prov fynedesk.ApplicationProvider) *Switcher
  • func (s *Switcher) HideApply()
  • func (s *Switcher) HideCancel()
  • func (s *Switcher) Next()
  • func (s *Switcher) Previous()

Constants

const (
	// RootWindowName is the base string that all root windows will have in their title and is used to identify root windows.
	RootWindowName = "Fyne Desktop"
	// SkipTaskbarHint should be added to the title of normal windows that should be skipped like the X11 SkipTaskbar hint.
	SkipTaskbarHint = "FyneDesk:skip"
)

Functions

func NewDesktop

func NewDesktop(app fyne.App, wm fynedesk.WindowManager, icons fynedesk.ApplicationProvider, screenProvider fynedesk.ScreenList) fynedesk.Desktop

NewDesktop creates a new desktop in fullscreen for main usage. The WindowManager passed in will be used to manage the screen it is loaded on. An ApplicationProvider is used to lookup application icons from the operating system.

func NewEmbeddedDesktop

func NewEmbeddedDesktop(app fyne.App, icons fynedesk.ApplicationProvider) fynedesk.Desktop

NewEmbeddedDesktop creates a new windowed desktop for test purposes. An ApplicationProvider is used to lookup application icons from the operating system. If run during CI for testing it will return an in-memory window using the fyne/test package.

func ShowAppLauncher

func ShowAppLauncher()

ShowAppLauncher opens a new application launcher, closing an old one if it existed.

Types

type Switcher

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

Switcher is an instance of a visible app switcher that can request a change in window stacking order

func ShowAppSwitcher

func ShowAppSwitcher(wins []fynedesk.Window, prov fynedesk.ApplicationProvider) *Switcher

ShowAppSwitcher shows the application Switcher to change windows. The most recently used not-top window will be selected by default. If the Switcher was already visible then it will select the next window in order.

func ShowAppSwitcherReverse

func ShowAppSwitcherReverse(wins []fynedesk.Window, prov fynedesk.ApplicationProvider) *Switcher

ShowAppSwitcherReverse shows the application Switcher to change windows. The least recently used window will be selected by default. If the Switcher was already visible then it will select the last window in order.

func (*Switcher) HideApply

func (s *Switcher) HideApply()

HideApply dismisses the application Switcher and raises whichever window was selected.

func (*Switcher) HideCancel

func (s *Switcher) HideCancel()

HideCancel dismisses the application Switcher without changing window order.

func (*Switcher) Next

func (s *Switcher) Next()

Next selects the next logical lower window in the stack. If the bottom most window is selected then it will wrap to the topmost. This will be raised if the change is applied by calling HideApply.

func (*Switcher) Previous

func (s *Switcher) Previous()

Previous selects the next logical higher window in the stack. If the top most window was selected it wraps to the lowest. This will be raised if the change is applied by calling HideApply.