navigator

Documentation

Index

• type Caller
• type Commander
• type HeightSetter
• type Location
  • func (l Location) File() string
  • func (l Location) Position() token.Position
• type Locationer
• type Name
  • func (n *Name) AddChild(c gxui.Control) *gxui.Child
  • func (n *Name) Init(outer mixins.LinearLayoutOuter, driver gxui.Driver, theme gxui.Theme, ...)
  • func (n *Name) MissingChild() gxui.Control
• type Navigator
  • func New(driver gxui.Driver, theme gxui.Theme) *Navigator
  • func (n *Navigator) Add(pane Pane)
  • func (n *Navigator) Buttons() gxui.LinearLayout
  • func (n *Navigator) Elements() []interface{}
  • func (n *Navigator) HideNavPane()
  • func (n *Navigator) Resize(height int)
  • func (n *Navigator) ShowNavPane(frame gxui.Control)
  • func (n *Navigator) ToggleNavPane(frame gxui.Control)
• type Opener
• type Pane
• type ProjectChanger
• type ProjectTree
  • func NewProjectTree(cmdr Commander, driver gxui.Driver, window gxui.Window, theme *basic.Theme) *ProjectTree
  • func (p *ProjectTree) Button() gxui.Button
  • func (p *ProjectTree) Frame() gxui.Control
  • func (p *ProjectTree) Open(path string, pos token.Position)
  • func (p *ProjectTree) SetProject(project setting.Project)
  • func (p *ProjectTree) SetRoot(path string)
  • func (p *ProjectTree) SetTOC(toc *TOC)
  • func (p *ProjectTree) TOC() *TOC
• type Projects
  • func NewProjectsPane(cmdr Commander, driver gxui.Driver, theme gxui.Theme, projFrame gxui.Control) *Projects
  • func (p *Projects) Add(project setting.Project)
  • func (p *Projects) Button() gxui.Button
  • func (p *Projects) Frame() gxui.Control
  • func (p *Projects) Projects() []setting.Project
• type TOC
  • func NewTOC(cmdr Commander, driver gxui.Driver, theme gxui.Theme, dir string) *TOC
  • func (t *TOC) Reload()
• type Watcher

Types

type Caller

type Caller interface {
	Call(func()) bool
}

Caller is any type that can call a function on the UI goroutine

type Commander

type Commander interface {
	Bindable(name string) bind.Bindable
	Execute(bind.Bindable)
}

type HeightSetter

type HeightSetter interface {
	SetHeight(int)
}

HeightSetter is any type which needs its height set explicitly

type Location

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

func (Location) File

func (l Location) File() string

func (Location) Position

func (l Location) Position() token.Position

type Locationer

type Locationer interface {
	File() string
	Position() token.Position
}

type Name

type Name struct {
	Location
	// contains filtered or unexported fields
}

func (*Name) AddChild

func (n *Name) AddChild(c gxui.Control) *gxui.Child

func (*Name) Init

func (n *Name) Init(outer mixins.LinearLayoutOuter, driver gxui.Driver, theme gxui.Theme, name string, color gxui.Color)

func (*Name) MissingChild

func (n *Name) MissingChild() gxui.Control

type Navigator

type Navigator struct {
	mixins.LinearLayout
	// contains filtered or unexported fields
}

Navigator is a type implementing the navigation pane of vidar.

func New

func New(driver gxui.Driver, theme gxui.Theme) *Navigator

New creates and returns a new *Navigator.

func (*Navigator) Add

func (n *Navigator) Add(pane Pane)

func (*Navigator) Buttons

func (n *Navigator) Buttons() gxui.LinearLayout

func (*Navigator) Elements

func (n *Navigator) Elements() []interface{}

func (*Navigator) HideNavPane

func (n *Navigator) HideNavPane()

func (*Navigator) Resize

func (n *Navigator) Resize(height int)

func (*Navigator) ShowNavPane

func (n *Navigator) ShowNavPane(frame gxui.Control)

func (*Navigator) ToggleNavPane

func (n *Navigator) ToggleNavPane(frame gxui.Control)

type Opener

type Opener interface {
	For(...focus.Opt) bind.Bindable
}

type Pane

type Pane interface {
	// Button returns the button that is shown for displaying the
	// Pane's Frame.
	Button() gxui.Button

	// Frame returns the frame that is displayed when the Pane's
	// Button is clicked.
	Frame() gxui.Control
}

Pane is a type that has a button and a window frame.

type ProjectChanger

type ProjectChanger interface {
	For(...project.Opt) bind.Bindable
}

type ProjectTree

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

func NewProjectTree

func NewProjectTree(cmdr Commander, driver gxui.Driver, window gxui.Window, theme *basic.Theme) *ProjectTree

func (*ProjectTree) Button

func (p *ProjectTree) Button() gxui.Button

func (*ProjectTree) Frame

func (p *ProjectTree) Frame() gxui.Control

func (*ProjectTree) Open

func (p *ProjectTree) Open(path string, pos token.Position)

func (*ProjectTree) SetProject

func (p *ProjectTree) SetProject(project setting.Project)

func (*ProjectTree) SetRoot

func (p *ProjectTree) SetRoot(path string)

func (*ProjectTree) SetTOC

func (p *ProjectTree) SetTOC(toc *TOC)

func (*ProjectTree) TOC

func (p *ProjectTree) TOC() *TOC

type Projects

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

func NewProjectsPane

func NewProjectsPane(cmdr Commander, driver gxui.Driver, theme gxui.Theme, projFrame gxui.Control) *Projects

func (*Projects) Add

func (p *Projects) Add(project setting.Project)

func (*Projects) Button

func (p *Projects) Button() gxui.Button

func (*Projects) Frame

func (p *Projects) Frame() gxui.Control

func (*Projects) Projects

func (p *Projects) Projects() []setting.Project

type TOC

type TOC struct {
	mixins.LinearLayout
	// contains filtered or unexported fields
}

func NewTOC

func NewTOC(cmdr Commander, driver gxui.Driver, theme gxui.Theme, dir string) *TOC

func (*TOC) Reload

func (t *TOC) Reload()

type Watcher

type Watcher interface {
	Add(path string) error
	Remove(path string) error
}