cterm

package

v0.0.0-...-59848b6 Latest Latest Go to latest Published: Feb 28, 2022 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jf-tech/console

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Close()
func Flush() error
func Init() error
func Interrupt()
func SetCell(x, y int, ch rune, fg, bg Attribute)
func SetProvider(p Provider)
func Size() (int, int)
func Sync() error
type Attribute
type Event
- func PollEvent() Event
type EventType
type Key
type Modifier
type Provider
- func (p Provider) String() string

Constants ¶

View Source

const (
	KeyArrowUp = Key(iota + 1000)
	KeyArrowDown
	KeyArrowRight
	KeyArrowLeft
	KeyEnter
	KeyEsc
	KeyBackspace2
	KeyCtrlA
	KeyCtrlC
	KeyCtrlD
	KeyCtrlE
	KeyCtrlK
	KeyCtrlV
	KeyF3
	KeyF7
	KeyF8
	KeyF9
	KeyF10
)

Keys codes.

Variables ¶

This section is empty.

Functions ¶

func Close ¶

func Close()

func Flush ¶

func Flush() error

func Init ¶

func Init() error

func Interrupt ¶

func Interrupt()

Interrupt posts an interrupt event.

func SetCell ¶

func SetCell(x, y int, ch rune, fg, bg Attribute)

SetCell sets the character cell at a given location to the given content (rune) and attributes.

func SetProvider ¶

func SetProvider(p Provider)

func Size ¶

func Size() (int, int)

func Sync ¶

func Sync() error

Types ¶

type Attribute ¶

type Attribute uint64

Attribute affects the presentation of characters, such as color, boldness, and so forth.

const (
	ColorDefault Attribute = iota
	ColorBlack
	ColorRed
	ColorGreen
	ColorYellow
	ColorBlue
	ColorMagenta
	ColorCyan
	ColorWhite
	ColorDarkGray
	ColorLightRed
	ColorLightGreen
	ColorLightYellow
	ColorLightBlue
	ColorLightMagenta
	ColorLightCyan
	ColorLightGray
)

Colors first. The order here is significant.

type Event ¶

type Event struct {
	Type EventType
	Key  Key
	Ch   rune
}

Event represents an event like a key press, mouse action, or window resize.

func PollEvent ¶

func PollEvent() Event

PollEvent blocks until an event is ready, and then returns it.

type EventType ¶

type EventType uint8

EventType represents the type of event.

const (
	EventNone EventType = iota
	EventKey
)

Event types.

type Key ¶

type Key int16

Key is a key press.

type Modifier ¶

type Modifier int16

Modifier represents the possible modifier keys.

type Provider ¶

type Provider int

const (
	TermBox Provider = iota
	TCell
)

func (Provider) String ¶

func (p Provider) String() string

Source Files ¶

View all Source files

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