Document

Documentation

Index

• Constants
• type Document
  • func NewDocument() *Document
  • func (d *Document) AddPage(page *Page)
  • func (d *Document) FString(trav *ffs.Traversor) error
• type Page
  • func NewPage() *Page
  • func (p *Page) AddSection(section fss.Sectioner) *Page
  • func (p *Page) FString(trav *ffs.Traversor) error
  • func (p *Page) View() ([]*RenderedPage, error)
• type RenderedPage
  • func NewRenderedPage(render *fss.Render, pageNumber, subPageNumber int) *RenderedPage

Constants

const (
	// DefaultPageWidth is the default width of a page.
	DefaultPageWidth int = 80

	// DefaultPageHeight is the default height of a page.
	DefaultPageHeight int = 24
)

Types

type Document

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

func NewDocument

func NewDocument() *Document

func (*Document) AddPage

func (d *Document) AddPage(page *Page)

func (*Document) FString

func (d *Document) FString(trav *ffs.Traversor) error

type Page

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

Page is a type that represents a page of a document.

func NewPage

func NewPage() *Page

func (*Page) AddSection

func (p *Page) AddSection(section fss.Sectioner) *Page

func (*Page) FString

func (p *Page) FString(trav *ffs.Traversor) error

FString implements the FStringer interface.

func (*Page) View

func (p *Page) View() ([]*RenderedPage, error)

type RenderedPage

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

RenderedPage is a type that represents a page of a document.

func NewRenderedPage

func NewRenderedPage(render *fss.Render, pageNumber, subPageNumber int) *RenderedPage