tui

package
v0.0.0-...-f6aa28c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 3, 2024 License: MIT, MIT Imports: 14 Imported by: 3

Documentation

Index

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
	ColSelected             ColorPair
	ColCurrent              ColorPair
	ColCurrentMatch         ColorPair
	ColCurrentCursor        ColorPair
	ColCurrentCursorEmpty   ColorPair
	ColCurrentSelected      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
)

Functions

func HasFullscreenRenderer

func HasFullscreenRenderer() bool

func IsLightRendererSupported

func IsLightRendererSupported() bool

func TtyIn

func TtyIn() *os.File

TtyIn returns terminal device to be used as STDIN, falls back to os.Stdin

Types

type Attr

type Attr int32

func (Attr) Merge

func (a Attr) Merge(b Attr) Attr

type BorderCharacter

type BorderCharacter int

type BorderShape

type BorderShape int
const (
	BorderNone BorderShape = iota
	BorderRounded
	BorderSharp
	BorderBold
	BorderBlock
	BorderThinBlock
	BorderDouble
	BorderHorizontal
	BorderVertical
	BorderTop
	BorderBottom
	BorderLeft
	BorderRight
)
var DefaultBorderShape BorderShape = BorderRounded

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

func MakeTransparentBorder

func MakeTransparentBorder() BorderStyle

type Color

type Color int32

func HexToColor

func HexToColor(rrggbb string) Color

func (Color) IsDefault

func (c Color) IsDefault() bool

type ColorAttr

type ColorAttr struct {
	Color Color
	Attr  Attr
}

func NewColorAttr

func NewColorAttr() ColorAttr

type ColorPair

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

func NewColorPair

func NewColorPair(fg Color, bg Color, attr Attr) ColorPair

func (ColorPair) Attr

func (p ColorPair) Attr() Attr

func (ColorPair) Bg

func (p ColorPair) Bg() Color

func (ColorPair) Fg

func (p ColorPair) Fg() Color

func (ColorPair) HasBg

func (p ColorPair) HasBg() bool

func (ColorPair) Merge

func (p ColorPair) Merge(other ColorPair) ColorPair

func (ColorPair) MergeAttr

func (p ColorPair) MergeAttr(other ColorPair) ColorPair

func (ColorPair) MergeNonDefault

func (p ColorPair) MergeNonDefault(other ColorPair) ColorPair

func (ColorPair) WithAttr

func (p ColorPair) WithAttr(attr Attr) ColorPair

type ColorTheme

type ColorTheme struct {
	Colored          bool
	Input            ColorAttr
	Disabled         ColorAttr
	Fg               ColorAttr
	Bg               ColorAttr
	PreviewFg        ColorAttr
	PreviewBg        ColorAttr
	DarkBg           ColorAttr
	Gutter           ColorAttr
	Prompt           ColorAttr
	Match            ColorAttr
	Current          ColorAttr
	CurrentMatch     ColorAttr
	Spinner          ColorAttr
	Info             ColorAttr
	Cursor           ColorAttr
	Selected         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 AltKey

func AltKey(r rune) Event

func CtrlAltKey

func CtrlAltKey(r rune) Event

func Key

func Key(r rune) Event

func (Event) Comparable

func (e Event) Comparable() Event

func (Event) Is

func (e Event) Is(types ...EventType) bool

func (Event) KeyName

func (e Event) KeyName() string

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

	Mouse
	DoubleClick
	LeftClick
	RightClick
	SLeftClick
	SRightClick
	ScrollUp
	ScrollDown
	SScrollUp
	SScrollDown
	PreviewScrollUp
	PreviewScrollDown

	// Events
	Resize
	Change
	BackwardEOF
	Start
	Load
	Focus
	One
	Zero
	Result
	Jump
	JumpCancel
)

func (EventType) AsEvent

func (t EventType) AsEvent() Event

func (EventType) Byte

func (t EventType) Byte() byte

func (EventType) Int

func (t EventType) Int() int

func (EventType) String

func (i EventType) String() string

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()

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()

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) Close

func (w *LightWindow) Close()

func (*LightWindow) DrawBorder

func (w *LightWindow) DrawBorder()

func (*LightWindow) DrawHBorder

func (w *LightWindow) DrawHBorder()

func (*LightWindow) Enclose

func (w *LightWindow) Enclose(y int, x int) bool

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) 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 MouseEvent struct {
	Y      int
	X      int
	S      int
	Left   bool
	Down   bool
	Double bool
	Mod    bool
}

type Renderer

type Renderer interface {
	Init()
	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

func NewLightRenderer

func NewLightRenderer(theme *ColorTheme, forceBlack bool, mouse bool, tabstop int, clearOnExit bool, fullscreen bool, maxHeightFunc func(int) int) Renderer

type TermSize

type TermSize struct {
	Lines    int
	Columns  int
	PxWidth  int
	PxHeight int
}

type Window

type Window interface {
	Top() int
	Left() int
	Width() int
	Height() int

	DrawBorder()
	DrawHBorder()
	Refresh()
	FinishFill()
	Close()

	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
	Erase()
	EraseMaybe() bool
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL