fieldview

Documentation

Index

• type FieldView
  • func New(fielder FocusFielder, font *impress.Font, foreground fn.Color) *FieldView
  • func (v *FieldView) Draw(w *impress.Window, rect image.Rectangle)
  • func (v *FieldView) LineHeight(lineHeight int) *FieldView
  • func (v *FieldView) MaxRows(maxRows int) *FieldView
  • func (v *FieldView) Size(size image.Point) image.Point
  • func (v *FieldView) WithCursor(cursor view.Viewer) *FieldView
• type FieldWithFocused
  • func WithFocused(field Fielder, isFocused fn.Bool) *FieldWithFocused
  • func (m *FieldWithFocused) Focused() bool
• type Fielder
• type FocusFielder

Types

type FieldView

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

FieldView is a text element. FieldView is used to draw the field's value inside any rectangle

func New

func New(fielder FocusFielder, font *impress.Font, foreground fn.Color) *FieldView

New creates a FieldView

func (*FieldView) Draw

func (v *FieldView) Draw(w *impress.Window, rect image.Rectangle)

Draw draws a view element. Width of rect parameter is used to split a text into sublines

func (*FieldView) LineHeight

func (v *FieldView) LineHeight(lineHeight int) *FieldView

LineHeight sets a custom line height

func (*FieldView) MaxRows

func (v *FieldView) MaxRows(maxRows int) *FieldView

MaxRows sets a maximum row height

func (*FieldView) Size

func (v *FieldView) Size(size image.Point) image.Point

Size returns size of a view element. Width of size parameter is used to split a text into sublines

func (*FieldView) WithCursor

func (v *FieldView) WithCursor(cursor view.Viewer) *FieldView

WithCursor adds a cursor Viewer to draw in cursor position

type FieldWithFocused

type FieldWithFocused struct {
	Fielder
	// contains filtered or unexported fields
}

FieldWithFocused contains a field with focused state func

func WithFocused

func WithFocused(field Fielder, isFocused fn.Bool) *FieldWithFocused

WithFocused returns a FieldWithFocused

func (*FieldWithFocused) Focused

func (m *FieldWithFocused) Focused() bool

Focused returns a focused flag

type Fielder

type Fielder interface {
	Strings() []string
	Cursor() int
}

Fielder is an interface of a field model

type FocusFielder

type FocusFielder interface {
	Fielder
	Focused() bool
}

FocusFielder is an interface of a field model with a focused flag