forked from Mirrors/bubbletea
78 lines
2.1 KiB
Go
78 lines
2.1 KiB
Go
package tea
|
|
|
|
type Renderer interface {
|
|
renderer
|
|
}
|
|
|
|
// renderer is the interface for Bubble Tea renderers.
|
|
type renderer interface {
|
|
// Start the renderer.
|
|
start()
|
|
|
|
// Stop the renderer, but render the final frame in the buffer, if any.
|
|
stop()
|
|
|
|
// Stop the renderer without doing any final rendering.
|
|
kill()
|
|
|
|
// Write a frame to the renderer. The renderer can write this data to
|
|
// output at its discretion.
|
|
write(string)
|
|
|
|
// Request a full re-render. Note that this will not trigger a render
|
|
// immediately. Rather, this method causes the next render to be a full
|
|
// repaint. Because of this, it's safe to call this method multiple times
|
|
// in succession.
|
|
repaint()
|
|
|
|
// Clears the terminal.
|
|
clearScreen()
|
|
|
|
// Whether or not the alternate screen buffer is enabled.
|
|
altScreen() bool
|
|
// Enable the alternate screen buffer.
|
|
enterAltScreen()
|
|
// Disable the alternate screen buffer.
|
|
exitAltScreen()
|
|
|
|
// Show the cursor.
|
|
showCursor()
|
|
// Hide the cursor.
|
|
hideCursor()
|
|
|
|
// enableMouseCellMotion enables mouse click, release, wheel and motion
|
|
// events if a mouse button is pressed (i.e., drag events).
|
|
enableMouseCellMotion()
|
|
|
|
// disableMouseCellMotion disables Mouse Cell Motion tracking.
|
|
disableMouseCellMotion()
|
|
|
|
// enableMouseAllMotion enables mouse click, release, wheel and motion
|
|
// events, regardless of whether a mouse button is pressed. Many modern
|
|
// terminals support this, but not all.
|
|
enableMouseAllMotion()
|
|
|
|
// disableMouseAllMotion disables All Motion mouse tracking.
|
|
disableMouseAllMotion()
|
|
|
|
// enableMouseSGRMode enables mouse extended mode (SGR).
|
|
enableMouseSGRMode()
|
|
|
|
// disableMouseSGRMode disables mouse extended mode (SGR).
|
|
disableMouseSGRMode()
|
|
|
|
// enableBracketedPaste enables bracketed paste, where characters
|
|
// inside the input are not interpreted when pasted as a whole.
|
|
enableBracketedPaste()
|
|
|
|
// disableBracketedPaste disables bracketed paste.
|
|
disableBracketedPaste()
|
|
|
|
// bracketedPasteActive reports whether bracketed paste mode is
|
|
// currently enabled.
|
|
bracketedPasteActive() bool
|
|
}
|
|
|
|
// repaintMsg forces a full repaint.
|
|
type repaintMsg struct{}
|