Documentation
¶
Index ¶
- Constants
- Variables
- func HasFullscreenRenderer() bool
- func IsLightRendererSupported() bool
- func TtyIn() (*os.File, error)
- func TtyOut() (*os.File, error)
- type Attr
- type BorderCharacter
- type BorderShape
- type BorderStyle
- type Color
- type ColorAttr
- type ColorPair
- func (p ColorPair) Attr() Attr
- func (p ColorPair) Bg() Color
- func (p ColorPair) Fg() Color
- func (p ColorPair) HasBg() bool
- func (p ColorPair) Merge(other ColorPair) ColorPair
- func (p ColorPair) MergeAttr(other ColorPair) ColorPair
- func (p ColorPair) MergeNonDefault(other ColorPair) ColorPair
- func (p ColorPair) WithAttr(attr Attr) ColorPair
- type ColorTheme
- type Event
- type EventType
- type FillReturn
- type FullscreenRenderer
- func (r *FullscreenRenderer) Clear()
- func (r *FullscreenRenderer) Close()
- func (r *FullscreenRenderer) GetChar() Event
- func (r *FullscreenRenderer) Init() error
- func (r *FullscreenRenderer) MaxX() int
- func (r *FullscreenRenderer) MaxY() int
- func (r *FullscreenRenderer) NeedScrollbarRedraw() bool
- func (r *FullscreenRenderer) NewWindow(top int, left int, width int, height int, preview bool, ...) Window
- func (r *FullscreenRenderer) PassThrough(string)
- func (r *FullscreenRenderer) Pause(bool)
- func (r *FullscreenRenderer) Refresh()
- func (r *FullscreenRenderer) RefreshWindows(windows []Window)
- func (r *FullscreenRenderer) Resize(maxHeightFunc func(int) int)
- func (r *FullscreenRenderer) Resume(bool, bool)
- func (r *FullscreenRenderer) ShouldEmitResizeEvent() bool
- func (r *FullscreenRenderer) Size() TermSize
- func (r *FullscreenRenderer) Top() int
- type LightRenderer
- func (r *LightRenderer) Clear()
- func (r *LightRenderer) Close()
- func (r *LightRenderer) GetChar() Event
- func (r *LightRenderer) Init() error
- func (r *LightRenderer) MaxX() int
- func (r *LightRenderer) MaxY() int
- func (r *LightRenderer) NeedScrollbarRedraw() bool
- func (r *LightRenderer) NewWindow(top int, left int, width int, height int, preview bool, ...) Window
- func (r *LightRenderer) PassThrough(str string)
- func (r *LightRenderer) Pause(clear bool)
- func (r *LightRenderer) Refresh()
- func (r *LightRenderer) RefreshWindows(windows []Window)
- func (r *LightRenderer) Resize(maxHeightFunc func(int) int)
- func (r *LightRenderer) Resume(clear bool, sigcont bool)
- func (r *LightRenderer) ShouldEmitResizeEvent() bool
- func (r *LightRenderer) Size() TermSize
- func (r *LightRenderer) Top() int
- type LightWindow
- func (w *LightWindow) CFill(fg Color, bg Color, attr Attr, text string) FillReturn
- func (w *LightWindow) CPrint(pair ColorPair, text string)
- func (w *LightWindow) DrawBorder()
- func (w *LightWindow) DrawHBorder()
- func (w *LightWindow) Enclose(y int, x int) bool
- func (w *LightWindow) Erase()
- func (w *LightWindow) EraseMaybe() bool
- func (w *LightWindow) Fill(text string) FillReturn
- func (w *LightWindow) FinishFill()
- func (w *LightWindow) Height() int
- func (w *LightWindow) Left() int
- func (w *LightWindow) LinkBegin(uri string, params string)
- func (w *LightWindow) LinkEnd()
- func (w *LightWindow) Move(y int, x int)
- func (w *LightWindow) MoveAndClear(y int, x int)
- func (w *LightWindow) Print(text string)
- func (w *LightWindow) Refresh()
- func (w *LightWindow) Top() int
- func (w *LightWindow) Width() int
- func (w *LightWindow) X() int
- func (w *LightWindow) Y() int
- type MouseEvent
- type Renderer
- type TermSize
- type Window
Constants ¶
View Source
const ( AttrUndefined = Attr(0) AttrRegular = Attr(1 << 8) AttrClear = Attr(1 << 9) Bold = Attr(1) Dim = Attr(1 << 1) Italic = Attr(1 << 2) Underline = Attr(1 << 3) Blink = Attr(1 << 4) Blink2 = Attr(1 << 5) Reverse = Attr(1 << 6) StrikeThrough = Attr(1 << 7) )
View Source
const CR string = "\x1b[2m␍"
View Source
const LF string = "\x1b[2m␊"
Variables ¶
View Source
var ( Default16 *ColorTheme Dark256 *ColorTheme Light256 *ColorTheme ColPrompt ColorPair ColNormal ColorPair ColInput ColorPair ColDisabled ColorPair ColMatch ColorPair ColCursor ColorPair ColCursorEmpty ColorPair ColMarker ColorPair ColSelected ColorPair ColSelectedMatch ColorPair ColCurrent ColorPair ColCurrentMatch ColorPair ColCurrentCursor ColorPair ColCurrentCursorEmpty ColorPair ColCurrentMarker ColorPair ColCurrentSelectedEmpty ColorPair ColSpinner ColorPair ColInfo ColorPair ColHeader ColorPair ColSeparator ColorPair ColScrollbar ColorPair ColBorder ColorPair ColPreview ColorPair ColPreviewBorder ColorPair ColBorderLabel ColorPair ColPreviewLabel ColorPair ColPreviewScrollbar ColorPair ColPreviewSpinner ColorPair )
View Source
var DefaultBorderShape = BorderRounded
Functions ¶
func HasFullscreenRenderer ¶
func HasFullscreenRenderer() bool
func IsLightRendererSupported ¶
func IsLightRendererSupported() bool
Types ¶
type BorderCharacter ¶
type BorderCharacter int
type BorderShape ¶
type BorderShape int
const ( BorderUndefined BorderShape = iota BorderNone BorderRounded BorderSharp BorderBold BorderBlock BorderThinBlock BorderDouble BorderHorizontal BorderVertical BorderTop BorderBottom BorderLeft BorderRight )
func (BorderShape) HasBottom ¶ added in v0.57.0
func (s BorderShape) HasBottom() bool
func (BorderShape) HasLeft ¶
func (s BorderShape) HasLeft() bool
func (BorderShape) HasRight ¶
func (s BorderShape) HasRight() bool
func (BorderShape) HasTop ¶
func (s BorderShape) HasTop() bool
type BorderStyle ¶
type BorderStyle struct {
// contains filtered or unexported fields
}
func MakeBorderStyle ¶
func MakeBorderStyle(shape BorderShape, unicode bool) BorderStyle
type ColorAttr ¶
func NewColorAttr ¶
func NewColorAttr() ColorAttr
type ColorPair ¶
type ColorPair struct {
// contains filtered or unexported fields
}
func (ColorPair) MergeNonDefault ¶
type ColorTheme ¶
type ColorTheme struct {
Colored bool
Input ColorAttr
Disabled ColorAttr
Fg ColorAttr
Bg ColorAttr
SelectedFg ColorAttr
SelectedBg ColorAttr
SelectedMatch ColorAttr
PreviewFg ColorAttr
PreviewBg ColorAttr
DarkBg ColorAttr
Gutter ColorAttr
Prompt ColorAttr
Match ColorAttr
Current ColorAttr
CurrentMatch ColorAttr
Spinner ColorAttr
Info ColorAttr
Cursor ColorAttr
Marker ColorAttr
Header ColorAttr
Separator ColorAttr
Scrollbar ColorAttr
Border ColorAttr
PreviewBorder ColorAttr
PreviewScrollbar ColorAttr
BorderLabel ColorAttr
PreviewLabel ColorAttr
}
func EmptyTheme ¶
func EmptyTheme() *ColorTheme
func NoColorTheme ¶
func NoColorTheme() *ColorTheme
type Event ¶
type Event struct {
Type EventType
Char rune
MouseEvent *MouseEvent
}
func CtrlAltKey ¶
func (Event) Comparable ¶
type EventType ¶
type EventType int
Types of user action
const ( Rune EventType = iota CtrlA CtrlB CtrlC CtrlD CtrlE CtrlF CtrlG CtrlH Tab CtrlJ CtrlK CtrlL CtrlM CtrlN CtrlO CtrlP CtrlQ CtrlR CtrlS CtrlT CtrlU CtrlV CtrlW CtrlX CtrlY CtrlZ Esc CtrlSpace CtrlDelete // https://apple.stackexchange.com/questions/24261/how-do-i-send-c-that-is-control-slash-to-the-terminal CtrlBackSlash CtrlRightBracket CtrlCaret CtrlSlash ShiftTab Backspace Delete PageUp PageDown Up Down Left Right Home End Insert ShiftUp ShiftDown ShiftLeft ShiftRight ShiftDelete F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 AltBackspace AltUp AltDown AltLeft AltRight AltShiftUp AltShiftDown AltShiftLeft AltShiftRight Alt CtrlAlt Invalid Fatal Mouse DoubleClick LeftClick RightClick SLeftClick SRightClick ScrollUp ScrollDown SScrollUp SScrollDown PreviewScrollUp PreviewScrollDown // Events Resize Change BackwardEOF Start Load Focus One Zero Result Jump JumpCancel ClickHeader )
type FillReturn ¶
type FillReturn int
const ( FillContinue FillReturn = iota FillNextLine FillSuspend )
type FullscreenRenderer ¶
type FullscreenRenderer struct {
// contains filtered or unexported fields
}
func (*FullscreenRenderer) Clear ¶
func (r *FullscreenRenderer) Clear()
func (*FullscreenRenderer) Close ¶
func (r *FullscreenRenderer) Close()
func (*FullscreenRenderer) GetChar ¶
func (r *FullscreenRenderer) GetChar() Event
func (*FullscreenRenderer) Init ¶
func (r *FullscreenRenderer) Init() error
func (*FullscreenRenderer) MaxX ¶
func (r *FullscreenRenderer) MaxX() int
func (*FullscreenRenderer) MaxY ¶
func (r *FullscreenRenderer) MaxY() int
func (*FullscreenRenderer) NeedScrollbarRedraw ¶
func (r *FullscreenRenderer) NeedScrollbarRedraw() bool
func (*FullscreenRenderer) NewWindow ¶
func (r *FullscreenRenderer) NewWindow(top int, left int, width int, height int, preview bool, borderStyle BorderStyle) Window
func (*FullscreenRenderer) PassThrough ¶
func (r *FullscreenRenderer) PassThrough(string)
func (*FullscreenRenderer) Pause ¶
func (r *FullscreenRenderer) Pause(bool)
func (*FullscreenRenderer) Refresh ¶
func (r *FullscreenRenderer) Refresh()
func (*FullscreenRenderer) RefreshWindows ¶
func (r *FullscreenRenderer) RefreshWindows(windows []Window)
func (*FullscreenRenderer) Resize ¶
func (r *FullscreenRenderer) Resize(maxHeightFunc func(int) int)
func (*FullscreenRenderer) Resume ¶
func (r *FullscreenRenderer) Resume(bool, bool)
func (*FullscreenRenderer) ShouldEmitResizeEvent ¶
func (r *FullscreenRenderer) ShouldEmitResizeEvent() bool
func (*FullscreenRenderer) Size ¶
func (r *FullscreenRenderer) Size() TermSize
func (*FullscreenRenderer) Top ¶
func (r *FullscreenRenderer) Top() int
type LightRenderer ¶
type LightRenderer struct {
// contains filtered or unexported fields
}
Light renderer
func (*LightRenderer) Clear ¶
func (r *LightRenderer) Clear()
func (*LightRenderer) Close ¶
func (r *LightRenderer) Close()
func (*LightRenderer) GetChar ¶
func (r *LightRenderer) GetChar() Event
func (*LightRenderer) Init ¶
func (r *LightRenderer) Init() error
func (*LightRenderer) MaxX ¶
func (r *LightRenderer) MaxX() int
func (*LightRenderer) MaxY ¶
func (r *LightRenderer) MaxY() int
func (*LightRenderer) NeedScrollbarRedraw ¶
func (r *LightRenderer) NeedScrollbarRedraw() bool
func (*LightRenderer) NewWindow ¶
func (r *LightRenderer) NewWindow(top int, left int, width int, height int, preview bool, borderStyle BorderStyle) Window
func (*LightRenderer) PassThrough ¶
func (r *LightRenderer) PassThrough(str string)
func (*LightRenderer) Pause ¶
func (r *LightRenderer) Pause(clear bool)
func (*LightRenderer) Refresh ¶
func (r *LightRenderer) Refresh()
func (*LightRenderer) RefreshWindows ¶
func (r *LightRenderer) RefreshWindows(windows []Window)
func (*LightRenderer) Resize ¶
func (r *LightRenderer) Resize(maxHeightFunc func(int) int)
func (*LightRenderer) Resume ¶
func (r *LightRenderer) Resume(clear bool, sigcont bool)
func (*LightRenderer) ShouldEmitResizeEvent ¶
func (r *LightRenderer) ShouldEmitResizeEvent() bool
func (*LightRenderer) Size ¶
func (r *LightRenderer) Size() TermSize
func (*LightRenderer) Top ¶
func (r *LightRenderer) Top() int
type LightWindow ¶
type LightWindow struct {
// contains filtered or unexported fields
}
func (*LightWindow) CFill ¶
func (w *LightWindow) CFill(fg Color, bg Color, attr Attr, text string) FillReturn
func (*LightWindow) CPrint ¶
func (w *LightWindow) CPrint(pair ColorPair, text string)
func (*LightWindow) DrawBorder ¶
func (w *LightWindow) DrawBorder()
func (*LightWindow) DrawHBorder ¶
func (w *LightWindow) DrawHBorder()
func (*LightWindow) Erase ¶
func (w *LightWindow) Erase()
func (*LightWindow) EraseMaybe ¶
func (w *LightWindow) EraseMaybe() bool
func (*LightWindow) Fill ¶
func (w *LightWindow) Fill(text string) FillReturn
func (*LightWindow) FinishFill ¶
func (w *LightWindow) FinishFill()
func (*LightWindow) Height ¶
func (w *LightWindow) Height() int
func (*LightWindow) Left ¶
func (w *LightWindow) Left() int
func (*LightWindow) LinkBegin ¶ added in v0.55.0
func (w *LightWindow) LinkBegin(uri string, params string)
func (*LightWindow) LinkEnd ¶ added in v0.55.0
func (w *LightWindow) LinkEnd()
func (*LightWindow) Move ¶
func (w *LightWindow) Move(y int, x int)
func (*LightWindow) MoveAndClear ¶
func (w *LightWindow) MoveAndClear(y int, x int)
func (*LightWindow) Print ¶
func (w *LightWindow) Print(text string)
func (*LightWindow) Refresh ¶
func (w *LightWindow) Refresh()
func (*LightWindow) Top ¶
func (w *LightWindow) Top() int
func (*LightWindow) Width ¶
func (w *LightWindow) Width() int
func (*LightWindow) X ¶
func (w *LightWindow) X() int
func (*LightWindow) Y ¶
func (w *LightWindow) Y() int
type MouseEvent ¶
type Renderer ¶
type Renderer interface {
Init() error
Resize(maxHeightFunc func(int) int)
Pause(clear bool)
Resume(clear bool, sigcont bool)
Clear()
RefreshWindows(windows []Window)
Refresh()
Close()
PassThrough(string)
NeedScrollbarRedraw() bool
ShouldEmitResizeEvent() bool
GetChar() Event
Top() int
MaxX() int
MaxY() int
Size() TermSize
NewWindow(top int, left int, width int, height int, preview bool, borderStyle BorderStyle) Window
}
func NewFullscreenRenderer ¶
func NewFullscreenRenderer(theme *ColorTheme, forceBlack bool, mouse bool) Renderer
type Window ¶
type Window interface {
Top() int
Left() int
Width() int
Height() int
DrawBorder()
DrawHBorder()
Refresh()
FinishFill()
X() int
Y() int
Enclose(y int, x int) bool
Move(y int, x int)
MoveAndClear(y int, x int)
Print(text string)
CPrint(color ColorPair, text string)
Fill(text string) FillReturn
CFill(fg Color, bg Color, attr Attr, text string) FillReturn
LinkBegin(uri string, params string)
LinkEnd()
Erase()
EraseMaybe() bool
}
Click to show internal directories.
Click to hide internal directories.