nav

package

v1.0.1 Latest Latest Go to latest Published: Feb 7, 2025 License: MIT Imports: 2 Imported by: 3

Details

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

Repository

github.com/taylorskalyo/goreader

Links

Open Source Insights

Documentation ¶

Index ¶

type PageNavigator
type Pager

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PageNavigator ¶

type PageNavigator interface {
	Draw()
	MaxScrollX() int
	MaxScrollY() int
	PageDown() bool
	PageUp() bool
	Pages() int
	ScrollDown()
	ScrollLeft()
	ScrollRight()
	ScrollUp()
	SetDoc(parse.Cellbuf)
	SetScreen(tcell.Screen)
	Size() (int, int)
	ToBottom()
	ToTop()
}

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

func (p *Pager) Draw()

Draw displays a pager's cell buffer in the terminal.

func (p *Pager) MaxScrollX() int

maxScrollX represents the pager's maximum horizontal scroll distance.

func (p *Pager) MaxScrollY() int

maxScrollY represents the pager's maximum vertical scroll distance.

func (p *Pager) PageDown() bool

pageDown pans the pager's viewport down by a full page, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) PageUp() bool

pageUp pans the pager's viewport up by a full page, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) Pages() int

pages returns the number of times the pager's underlying cell buffer document can be split into viewport sized pages.

func (p *Pager) ScrollDown()

scrollDown pans the pager's viewport down, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) ScrollLeft()

scrollLeft pans the pager's viewport left, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) ScrollRight()

scrollRight pans the pager's viewport right, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) ScrollUp()

scrollUp pans the pager's viewport up, without exceeding the underlying cell buffer document's boundaries.

func (p *Pager) SetDoc(doc parse.Cellbuf)

setDoc sets the pager's cell buffer

func (p *Pager) SetScreen(screen tcell.Screen)

setScreen sets the pager's screen

func (p *Pager) Size() (int, int)

size returns the width and height of the pager's underlying cell buffer document.

func (p *Pager) ToBottom()

toBottom set's the pager's horizontal panning distance back to zero and vertical panning distance to the last viewport page.

func (p *Pager) ToTop()

toTop set's the pager's horizontal and vertical panning distance back to zero.

Source Files ¶

View all Source files

pager.go

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

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type PageNavigator ¶

type Pager ¶

func (*Pager) Draw ¶

func (*Pager) MaxScrollX ¶

func (*Pager) MaxScrollY ¶

func (*Pager) PageDown ¶

func (*Pager) PageUp ¶

func (*Pager) Pages ¶

func (*Pager) ScrollDown ¶

func (*Pager) ScrollLeft ¶

func (*Pager) ScrollRight ¶

func (*Pager) ScrollUp ¶

func (*Pager) SetDoc ¶

func (*Pager) SetScreen ¶ added in v1.0.1

func (*Pager) Size ¶

func (*Pager) ToBottom ¶

func (*Pager) ToTop ¶

Source Files ¶