primitive

Documentation

Index

• type Modal
  • func NewModal() *Modal
  • func (m *Modal) Draw(screen tcell.Screen)
  • func (m *Modal) Focus(delegate func(p tview.Primitive))
  • func (m *Modal) HasFocus() bool
  • func (m *Modal) SetBackgroundColor(color tcell.Color) *Modal
  • func (m *Modal) SetBorder(show bool) *Modal
  • func (m *Modal) SetBorderColor(color tcell.Color) *Modal
  • func (m *Modal) SetText(text string) *Modal
  • func (m *Modal) SetTextColor(color tcell.Color) *Modal

Types

type Modal

type Modal struct {
	*tview.Box
	// contains filtered or unexported fields
}

Modal is a centered message window used to inform the user.

This primitive is based on https://github.com/rivo/tview/wiki/Modal. To see what we extended, search through for EXTENDED comments.

func NewModal

func NewModal() *Modal

NewModal returns a new modal message window.

func (*Modal) Draw

func (m *Modal) Draw(screen tcell.Screen)

Draw draws this primitive onto the screen.

func (*Modal) Focus

func (m *Modal) Focus(delegate func(p tview.Primitive))

Focus is called when this primitive receives focus.

func (*Modal) HasFocus

func (m *Modal) HasFocus() bool

HasFocus returns whether or not this primitive has focus.

func (*Modal) SetBackgroundColor

func (m *Modal) SetBackgroundColor(color tcell.Color) *Modal

SetBackgroundColor sets the color of the modal frame background.

func (*Modal) SetBorder

func (m *Modal) SetBorder(show bool) *Modal

SetBorder sets the flag indicating whether or not the frame should have a border.

func (*Modal) SetBorderColor

func (m *Modal) SetBorderColor(color tcell.Color) *Modal

SetBorderColor sets the frame's border color. EXTENDED.

func (*Modal) SetText

func (m *Modal) SetText(text string) *Modal

SetText sets the message text of the window. The text may contain line breaks. Note that words are wrapped, too, based on the final size of the window.

func (*Modal) SetTextColor

func (m *Modal) SetTextColor(color tcell.Color) *Modal

SetTextColor sets the color of the message text.