systray

README

Source code in the current directory are ported from https://github.com/getlantern/systray and make more changes.

Thanks the original authors.

Documentation

Index

• func AddMenuItem(parent, item *MenuItem)
• func AddMenuItemBefore(parent, item *MenuItem, next *MenuItem)
• func Events() <-chan *MenuItem
• func Quit()
• func Register(onReady func(), onExit func())
• func Run(onReady func(), onExit func())
• func SetIcon(iconBytes []byte)
• func SetTitle(title string)
• type Action
• type MenuItem
  • func NewMenuItem(title string) *MenuItem
  • func NewSeparator() *MenuItem
  • func (item *MenuItem) Action() Action
  • func (item *MenuItem) Children() []*MenuItem
  • func (item *MenuItem) RemoveAllItems()
  • func (item *MenuItem) SetAction(action Action)
  • func (item *MenuItem) SetChecked(checked bool)
  • func (item *MenuItem) SetDisabled(disabled bool)
  • func (item *MenuItem) SetHidden(hidden bool)
  • func (item *MenuItem) SetTitle(title string)
  • func (item *MenuItem) String() string

Functions

func AddMenuItem

func AddMenuItem(parent, item *MenuItem)

AddMenuItem appends the item to the parent menu list.

func AddMenuItemBefore

func AddMenuItemBefore(parent, item *MenuItem, next *MenuItem)

AddMenuItemBefore adds the item to the parent menu list before the specified next item.

func Events

func Events() <-chan *MenuItem

Events returns the events list.

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 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.

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 SetTitle

func SetTitle(title string)

SetTitle sets the systray title, only available on Mac and Linux.

Types

type Action

type Action func()

type MenuItem

type MenuItem 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 NewMenuItem

func NewMenuItem(title string) *MenuItem

NewMenuItem returns a MenuItem object with the specified title.

func NewSeparator

func NewSeparator() *MenuItem

NewSeparator returns a separator without title.

func (*MenuItem) Action

func (item *MenuItem) Action() Action

Action returns the event handler action.

func (*MenuItem) Children

func (item *MenuItem) Children() []*MenuItem

func (*MenuItem) RemoveAllItems

func (item *MenuItem) RemoveAllItems()

func (*MenuItem) SetAction

func (item *MenuItem) SetAction(action Action)

SetAction sets the event handler action.

func (*MenuItem) SetChecked

func (item *MenuItem) SetChecked(checked bool)

SetChecked sets the checked status of the current menu item.

func (*MenuItem) SetDisabled

func (item *MenuItem) SetDisabled(disabled bool)

SetDisabled sets enable status of the current menu item.

func (*MenuItem) SetHidden

func (item *MenuItem) SetHidden(hidden bool)

SetHidden sets the hidden status of the current menu item.

func (*MenuItem) SetTitle

func (item *MenuItem) SetTitle(title string)

SetTitle set the text to display on a menu item

func (*MenuItem) String

func (item *MenuItem) String() string

String implements the fmt.Stringer interface.