textfile

Documentation

Index

• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
• type Widget
  • func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget
  • func (widget *Widget) HelpText() string
  • func (widget *Widget) Refresh()

Types

type Settings

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

Settings defines the configuration properties for this module

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

NewSettingsFromYAML creates a new settings instance from a YAML config block

type Widget

type Widget struct {
	wtf.KeyboardWidget
	wtf.MultiSourceWidget
	wtf.TextWidget
	// contains filtered or unexported fields
}

func NewWidget

func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget

NewWidget creates a new instance of a widget

func (*Widget) HelpText

func (widget *Widget) HelpText() string

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh is only called once on start-up. Its job is to display the text files that first time. After that, the watcher takes over