README
¶
keepguestalive
Documentation
¶
Overview ¶
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 ¶
- func AddSeparator()
- func Quit()
- func Run(onReady func(), onExit func())
- func SetIcon(iconBytes []byte)
- func SetTitle(title string)
- func SetTooltip(tooltip string)
- type 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) SetIcon(iconBytes []byte)
- func (item *MenuItem) SetTitle(title string)
- func (item *MenuItem) SetTooltip(tooltip string)
- func (item *MenuItem) Show()
- func (item *MenuItem) Uncheck()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Run ¶
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 ¶
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 SetTooltip ¶
func SetTooltip(tooltip string)
SetTooltip sets the systray tooltip to display on mouse hover of the tray icon, only available on Mac and Windows.
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 ¶
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 (*MenuItem) Check ¶
func (item *MenuItem) Check()
Check a menu item regardless if it's previously checked or not
func (*MenuItem) Disable ¶
func (item *MenuItem) Disable()
Disable a menu item regardless if it's previously disabled or not
func (*MenuItem) Enable ¶
func (item *MenuItem) Enable()
Enable a menu item regardless if it's previously enabled or not
func (*MenuItem) SetIcon ¶
SetIcon sets the icon of a menu item. Only available on Mac. iconBytes should be the content of .ico/.jpg/.png
func (*MenuItem) SetTooltip ¶
SetTooltip set the tooltip to show when mouse hover
Source Files
Directories