ui

Documentation

Index

• type Paragraph
  • func NewParagraph() *Paragraph
  • func (para *Paragraph) Draw(buf *ui.Buffer)
  • func (para *Paragraph) ScrollAmount(a int)
  • func (para *Paragraph) ScrollDown()
  • func (para *Paragraph) ScrollUp()
  • func (para *Paragraph) SetPara(text string, scrollPosition int)

Types

type Paragraph

type Paragraph struct {
	ui.Block
	TextStyle      ui.Style
	WrapText       bool
	ScrollPosition int
	Rows           [][]ui.Cell
	RowsL          int
}

Paragraph struct for creating paragraphs

func NewParagraph

func NewParagraph() *Paragraph

NewParagraph returns pointer to a Paragraph

func (*Paragraph) Draw

func (para *Paragraph) Draw(buf *ui.Buffer)

Draw renders the Paragraph

func (*Paragraph) ScrollAmount

func (para *Paragraph) ScrollAmount(a int)

ScrollAmount charge scroll position relative to the given amount

func (*Paragraph) ScrollDown

func (para *Paragraph) ScrollDown()

ScrollDown will scroll down the paragraph

func (*Paragraph) ScrollUp

func (para *Paragraph) ScrollUp()

ScrollUp will scroll up the paragraph

func (*Paragraph) SetPara

func (para *Paragraph) SetPara(text string, scrollPosition int)

SetPara sets initial variable for the paragraph