screen

package

v0.0.19 Latest Latest Go to latest Published: Jan 4, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crgimenes/compterm

Links

Open Source Insights

Documentation ¶

Index ¶

type AttachedClient
type Manager
- func NewManager() *Manager
type Screen
- func New(rows, columns int) *Screen

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AttachedClient ¶ added in v0.0.19

type AttachedClient struct {
	WritePermission bool
	CurrentScreen   *Screen
	Client          *client.Client
}

type Manager ¶

type Manager struct {
	Screens []*Screen
}

func NewManager ¶

func NewManager() *Manager

func (*Manager) AttachClient ¶

func (m *Manager) AttachClient(c *client.Client, screen *Screen, writePermission bool) error

attach a client to a screen

func (*Manager) ChangeScreen ¶ added in v0.0.19

func (m *Manager) ChangeScreen(c *client.Client, screen *Screen) error

change current screen

func (*Manager) DetachClient ¶

func (m *Manager) DetachClient(c *client.Client, screen *Screen) error

detach a client from a screen

func (*Manager) DetachClientFromAllScreens ¶ added in v0.0.19

func (m *Manager) DetachClientFromAllScreens(c *client.Client)

detach a client from all screens

func (*Manager) GetDefaultScreen ¶ added in v0.0.19

func (m *Manager) GetDefaultScreen() *Screen

get default screen

func (*Manager) GetScreenByID ¶

func (m *Manager) GetScreenByID(id int) (bool, *Screen)

get screen by id

func (*Manager) GetScreenByTitle ¶

func (m *Manager) GetScreenByTitle(title string) (bool, *Screen)

get screen by Title

func (*Manager) KillScreen ¶ added in v0.0.19

func (m *Manager) KillScreen(id int) error

remove screen and kill clients

func (*Manager) RemoveScreen ¶ added in v0.0.19

func (m *Manager) RemoveScreen(id int) error

remove a screen

type Screen ¶

type Screen struct {
	Title   string
	Columns int
	Rows    int
	Clients []*AttachedClient
	Stream  *stream.Stream
	// contains filtered or unexported fields
}

func New ¶

func New(rows, columns int) *Screen

func (*Screen) CursorPos ¶

func (s *Screen) CursorPos() (rows, columns int)

CursorPos() returns the cursor position

func (*Screen) GetScreenAsANSI ¶

func (s *Screen) GetScreenAsANSI() []byte

GetScreenAsANSI returns the screen as ANSI

func (*Screen) Read ¶ added in v0.0.19

func (s *Screen) Read(p []byte) (n int, err error)

func (*Screen) Resize ¶

func (s *Screen) Resize(rows, columns int)

Resize screen

func (*Screen) Size ¶ added in v0.0.17

func (s *Screen) Size() (rows, columns int)

Get screen size

func (*Screen) Write ¶

func (s *Screen) Write(p []byte) (n int, err error)

Writer interface

Source Files ¶

View all Source files

screen.go

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