package systray

import "fyne.io/systray"

Package systray is a cross-platform Go library to place an icon and menu in the notification area.

Index ¶

• func AddSeparator()
• func Quit()
• func Register(onReady func(), onExit func())
• func ResetMenu()
• func Run(onReady, onExit func())
• func RunWithExternalLoop(onReady, onExit func()) (start, end func())
• type MenuItem
• func AddMenuItem(title string, tooltip string) *MenuItem
• func AddMenuItemCheckbox(title string, tooltip string, checked bool) *MenuItem
• func (item *MenuItem) AddSeparator()
• func (item *MenuItem) AddSubMenuItem(title string, tooltip string) *MenuItem
• func (item *MenuItem) AddSubMenuItemCheckbox(title string, tooltip string, checked bool) *MenuItem
• func (item *MenuItem) Check()
• func (item *MenuItem) Checked() bool
• func (item *MenuItem) Disable()
• func (item *MenuItem) Disabled() bool
• func (item *MenuItem) Enable()
• func (item *MenuItem) Hide()
• func (item *MenuItem) Remove()
• func (item *MenuItem) SetTitle(title string)
• func (item *MenuItem) SetTooltip(tooltip string)
• func (item *MenuItem) Show()
• func (item *MenuItem) String() string
• func (item *MenuItem) Uncheck()

Functions ¶

func AddSeparator ¶

func AddSeparator()

AddSeparator adds a separator bar to the menu

func Quit ¶

func Quit()

Quit the systray

func Register ¶

func Register(onReady func(), onExit func())

Register initializes GUI and registers the callbacks but relies on the caller to run the event loop somewhere else. It's useful if the program needs to show other UI elements, for example, webview. To overcome some OS weirdness, On macOS versions before Catalina, calling this does exactly the same as Run().

func ResetMenu ¶

func ResetMenu()

ResetMenu will remove all menu items

func Run ¶

func Run(onReady, onExit func())

Run initializes GUI and starts the event loop, then invokes the onReady callback. It blocks until systray.Quit() is called.

func RunWithExternalLoop ¶

func RunWithExternalLoop(onReady, onExit func()) (start, end func())

RunWithExternalLoop allows the systemtray module to operate with other tookits. The returned start and end functions should be called by the toolkit when the application has started and will end.

Types ¶

type MenuItem ¶

type MenuItem struct {
	// ClickedCh is the channel which will be notified when the menu item is clicked
	ClickedCh chan struct{}
	// contains filtered or unexported fields
}

MenuItem is used to keep track each menu item of systray. Don't create it directly, use the one systray.AddMenuItem() returned

func AddMenuItem ¶

func AddMenuItem(title string, tooltip string) *MenuItem

AddMenuItem adds a menu item with the designated title and tooltip. It can be safely invoked from different goroutines. Created menu items are checkable on Windows and OSX by default. For Linux you have to use AddMenuItemCheckbox

func AddMenuItemCheckbox ¶

func AddMenuItemCheckbox(title string, tooltip string, checked bool) *MenuItem

AddMenuItemCheckbox adds a menu item with the designated title and tooltip and a checkbox for Linux. On other platforms there will be a check indicated next to the item if `checked` is true. It can be safely invoked from different goroutines.

func (*MenuItem) AddSeparator ¶

func (item *MenuItem) AddSeparator()

AddSeparator adds a separator bar to the submenu

func (*MenuItem) AddSubMenuItem ¶

func (item *MenuItem) AddSubMenuItem(title string, tooltip string) *MenuItem

AddSubMenuItem adds a nested sub-menu item with the designated title and tooltip. It can be safely invoked from different goroutines. Created menu items are checkable on Windows and OSX by default. For Linux you have to use AddSubMenuItemCheckbox

func (*MenuItem) AddSubMenuItemCheckbox ¶

func (item *MenuItem) AddSubMenuItemCheckbox(title string, tooltip string, checked bool) *MenuItem

AddSubMenuItemCheckbox adds a nested sub-menu item with the designated title and tooltip and a checkbox for Linux. It can be safely invoked from different goroutines. On Windows and OSX this is the same as calling AddSubMenuItem

func (*MenuItem) Check ¶

func (item *MenuItem) Check()

Check a menu item regardless if it's previously checked or not

func (*MenuItem) Checked ¶

func (item *MenuItem) Checked() bool

Checked returns if the menu item has a check mark

func (*MenuItem) Disable ¶

func (item *MenuItem) Disable()

Disable a menu item regardless if it's previously disabled or not

func (*MenuItem) Disabled ¶

func (item *MenuItem) Disabled() bool

Disabled checks if the menu item is disabled

func (*MenuItem) Enable ¶

func (item *MenuItem) Enable()

Enable a menu item regardless if it's previously enabled or not

func (*MenuItem) Hide ¶

func (item *MenuItem) Hide()

Hide hides a menu item

func (*MenuItem) Remove ¶

func (item *MenuItem) Remove()

Remove removes a menu item

func (*MenuItem) SetTitle ¶

func (item *MenuItem) SetTitle(title string)

SetTitle set the text to display on a menu item

func (*MenuItem) SetTooltip ¶

func (item *MenuItem) SetTooltip(tooltip string)

SetTooltip set the tooltip to show when mouse hover

func (*MenuItem) Show ¶

func (item *MenuItem) Show()

Show shows a previously hidden menu item

func (*MenuItem) String ¶

func (item *MenuItem) String() string

func (*MenuItem) Uncheck ¶

func (item *MenuItem) Uncheck()

Uncheck a menu item regardless if it's previously unchecked or not

Source Files ¶

systray.go

Directories ¶