minibuffer

Documentation

Overview

Package minibuffer todo

Index

• func Open(w *Widget, container gowid.ISettableComposite, width gowid.IWidgetDimension, ...)
• type IAction
• type IArg
• type Widget
  • func New() *Widget
  • func (w *Widget) Register(name string, action IAction)

Functions

func Open

func Open(w *Widget, container gowid.ISettableComposite, width gowid.IWidgetDimension, app gowid.IApp)

w is minibuffer container is main view

Types

type IAction

type IAction interface {
	Run(gowid.IApp, ...string) error // nil means success
	Arguments([]string, gowid.IApp) []IArg
	OfferCompletion() bool
}

IAction represents a command that can be run in the minibuffer e.g. "set". It can decide whether or not to show in the list of completions e.g. if the user types "s".

type IArg

type IArg interface {
	OfferCompletion() bool
	Completions() []string
}

IArg represents an argument to a minibuffer command e.g. "dark-mode" in the command "set dark-mode on".

type Widget

type Widget struct {
	*dialog.Widget
	// contains filtered or unexported fields
}

Widget represents a termshark-specific "minibuffer" widget, expected to be opened as a dialog near the bottom of the screen. It allows the user to type commands and supports tab completion and listing completions.

func New

func New() *Widget

func (*Widget) Register

func (w *Widget) Register(name string, action IAction)

Not thread-safe, manage via App perhaps