gui

Documentation

Index

• func AddHead()
• func Headless() bool
• func Heartbeat() time.Time
• func UpdateHeartbeat() time.Time
• type Gui
  • func New(apiAddr string) *Gui
  • func (gui *Gui) AddSessionId() string
  • func (gui *Gui) CachedPage(cachedPage string, sessionId string) bool
  • func (gui *Gui) Close() error
  • func (gui *Gui) CollapseMenu(sessionId string) bool
  • func (gui *Gui) ExpandMenu(sessionId string) bool
  • func (gui *Gui) GetCachedPage(sessionId string) string
  • func (gui *Gui) GetTxHistoryPage(sessionId string) int
  • func (gui *Gui) MenuIsCollapsed(sessionId string) bool
  • func (gui *Gui) SessionIdExists(sessionId string) bool
  • func (gui *Gui) SetStatus(status string)
  • func (gui *Gui) SetTxHistoryPage(txHistoryPage int, sessionId string) bool
  • func (gui *Gui) Status() string
• type Session

Functions

func AddHead

func AddHead()

AddHead adds a head to the GUI.

func Headless

func Headless() bool

Headless returns true when the GUI is headless.

func Heartbeat

func Heartbeat() time.Time

Heartbeat returns the heartbeat time.

func UpdateHeartbeat

func UpdateHeartbeat() time.Time

UpdateHeartbeat updates and returns the heartbeat time.

Types

type Gui

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

Gui is a struct that tracks global settings

func New

func New(apiAddr string) *Gui

New creates a new Gui.

func (*Gui) AddSessionId

func (gui *Gui) AddSessionId() string

AddSessionId adds a new session ID to memory.

func (*Gui) CachedPage

func (gui *Gui) CachedPage(cachedPage string, sessionId string) bool

CachedPage caches the page without the menu and returns true.

func (*Gui) Close

func (gui *Gui) Close() error

Close will shut down the GUI, giving the module enough time to run any required closing routines.

func (*Gui) CollapseMenu

func (gui *Gui) CollapseMenu(sessionId string) bool

CollapseMenu sets the menu state to collapsed and returns true

func (*Gui) ExpandMenu

func (gui *Gui) ExpandMenu(sessionId string) bool

ExpandMenu sets the menu state to expanded and returns true

func (*Gui) GetCachedPage

func (gui *Gui) GetCachedPage(sessionId string) string

GetCachedPage returns the session's cached page.

func (*Gui) GetTxHistoryPage

func (gui *Gui) GetTxHistoryPage(sessionId string) int

GetTxHistoryPage returns the session's transaction history page or -1 when no session is found.

func (*Gui) MenuIsCollapsed

func (gui *Gui) MenuIsCollapsed(sessionId string) bool

MenuIsCollapsed returns true when the menu state is collapsed

func (*Gui) SessionIdExists

func (gui *Gui) SessionIdExists(sessionId string) bool

SessionIdExists returns true when the supplied session ID exists in memory.

func (*Gui) SetStatus

func (gui *Gui) SetStatus(status string)

SetStatus sets the GUI's status.

func (*Gui) SetTxHistoryPage

func (gui *Gui) SetTxHistoryPage(txHistoryPage int, sessionId string) bool

SetTxHistoryPage sets the session's transaction history page and returns true.

func (*Gui) Status

func (gui *Gui) Status() string

Status returns the GUI's status.

type Session

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

Session is a struct that tracks session settings