todo

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()
  • func (widget *Widget) SelectedItem() *checklist.ChecklistItem
  • func (widget *Widget) SetList(list checklist.Checklist)

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 {
	view.KeyboardWidget
	view.ScrollableWidget
	// contains filtered or unexported fields
}

A Widget represents a Todo widget

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

HelpText returns the help text for this widget

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh updates the data for this widget and displays it onscreen

func (*Widget) SelectedItem

func (widget *Widget) SelectedItem() *checklist.ChecklistItem

SelectedItem returns the currently-selected checklist item or nil if no item is selected

func (*Widget) SetList

func (widget *Widget) SetList(list checklist.Checklist)