screen

Documentation

Overview

Package screen represents screen

Index

• func NewScreen(config *config.Config) (tcell.Screen, error)
• type Client
• type Event
• type EventCancel
• type EventDelete
• type EventEnter
• type EventKeyDown
• type EventKeyUp
• type EventRune
• type EventScreenResize
• type IClient
  • func NewClient(s tcell.Screen) *IClient
  • func (c *IClient) Clear()
  • func (c *IClient) Finish()
  • func (c *IClient) GetEventChan() chan Event
  • func (c *IClient) GetScreen() tcell.Screen
  • func (c *IClient) ScreenSize() (int, int)
  • func (c *IClient) StartPollEvent(ctx context.Context)
  • func (c *IClient) StopPollEvent()

Functions

func NewScreen

func NewScreen(config *config.Config) (tcell.Screen, error)

NewScreen initilize screen.

Types

type Client

type Client interface {
	GetScreen() tcell.Screen
	ScreenSize() (int, int)

	Clear()
	Finish()

	StartPollEvent(ctx context.Context)
	StopPollEvent()

	GetEventChan() chan Event
}

Client include related screen.

type Event

type Event interface{}

Event screen event.

type EventCancel

type EventCancel struct{}

EventCancel cancel event.

type EventDelete

type EventDelete struct{}

EventDelete delete event.

type EventEnter

type EventEnter struct{}

EventEnter press Enter event.

type EventKeyDown

type EventKeyDown struct{}

EventKeyDown press keydown event.

type EventKeyUp

type EventKeyUp struct{}

EventKeyUp press keyup event.

type EventRune

type EventRune rune

EventRune press rune.

type EventScreenResize

type EventScreenResize struct{}

EventScreenResize resize screen Event.

type IClient

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

IClient implements Client interface.

func NewClient

func NewClient(s tcell.Screen) *IClient

NewClient initilize Client.

func (*IClient) Clear

func (c *IClient) Clear()

Clear clears screen.

func (*IClient) Finish

func (c *IClient) Finish()

Finish finishes screen.

func (*IClient) GetEventChan

func (c *IClient) GetEventChan() chan Event

GetEventChan gets an event connection.

func (*IClient) GetScreen

func (c *IClient) GetScreen() tcell.Screen

GetScreen gets screen.

func (*IClient) ScreenSize

func (c *IClient) ScreenSize() (int, int)

ScreenSize gets screen size.

func (*IClient) StartPollEvent

func (c *IClient) StartPollEvent(ctx context.Context)

StartPollEvent starts polling event on goroutine.

func (*IClient) StopPollEvent

func (c *IClient) StopPollEvent()

StopPollEvent stops polling event of screen.