systray: github.com/getlantern/systray Index | Files | Directories

package systray

import "github.com/getlantern/systray"

Package systray is a cross platfrom Go library to place an icon and menu in the notification area. Supports Windows, Mac OSX and Linux currently. Methods can be called from any goroutine except Run(), which should be called at the very beginning of main() to lock at main thread.

Index

Package Files

systray.go systray_nonwindows.go

func AddSeparator Uses

func AddSeparator()

AddSeparator adds a separator bar to the menu

func Quit Uses

func Quit()

Quit the systray

func Run Uses

func Run(onReady func(), onExit func())

Run initializes GUI and starts the event loop, then invokes the onReady callback. It blocks until systray.Quit() is called. Should be called at the very beginning of main() to lock at main thread.

func SetIcon Uses

func SetIcon(iconBytes []byte)

SetIcon sets the systray icon. iconBytes should be the content of .ico for windows and .ico/.jpg/.png for other platforms.

func SetTitle Uses

func SetTitle(title string)

SetTitle sets the systray title, only available on Mac.

func SetTooltip Uses

func SetTooltip(tooltip string)

SetTooltip sets the systray tooltip to display on mouse hover of the tray icon, only available on Mac and Windows.

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 Uses

func AddMenuItem(title string, tooltip string) *MenuItem

AddMenuItem adds menu item with designated title and tooltip, returning a channel that notifies whenever that menu item is clicked.

It can be safely invoked from different goroutines.

func (item *MenuItem) Check()

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

func (item *MenuItem) Checked() bool

Checked returns if the menu item has a check mark

func (item *MenuItem) Disable()

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

func (item *MenuItem) Disabled() bool

Disabled checkes if the menu item is disabled

func (item *MenuItem) Enable()

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

func (item *MenuItem) Hide()

Hide hides a menu item

func (item *MenuItem) SetIcon(iconBytes []byte)

SetIcon sets the icon of a menu item. Only available on Mac. iconBytes should be the content of .ico/.jpg/.png

func (item *MenuItem) SetTitle(title string)

SetTitle set the text to display on a menu item

func (item *MenuItem) SetTooltip(tooltip string)

SetTooltip set the tooltip to show when mouse hover

func (item *MenuItem) Show()

Show shows a previously hidden menu item

func (item *MenuItem) Uncheck()

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

Directories

PathSynopsis
example
example/icon

Package systray imports 6 packages (graph) and is imported by 28 packages. Updated 2019-01-31. Refresh now. Tools for package owners.