modulepackage
0.0.0-20210801162502-2f2f57835ab3
Repository: https://github.com/gord-project/gview.git
Documentation: pkg.go.dev
# README
GVIEW
A home for the modified tview used by Gord.
Original readme from the gord repo
Fork of rivo/tview
Hey, if you come along my repository, I recommend you do not use it, as I do not guarantee a stable interface or proper support. The changes I make to this fork may be incomplete or breaking. Please use the official repository over at rivo/tview. Any bugs I find or fix, I'll move over to the official repository.
# Packages
No description provided by the author
# Functions
ANSIWriter returns an io.Writer which translates any ANSI escape codes written to it into tview color tags.
Escape escapes the given text such that color and/or region tags are not recognized and substituted by the print functions of this package.
NewApplication creates and returns a new application.
NewBox returns a Box without a border.
NewButton returns a new input field.
NewCheckbox returns a new input field.
NewDropDown returns a new drop-down.
NewFlex returns a new flexbox layout container with no primitives and its direction set to FlexColumn.
NewForm returns a new form.
NewFrame returns a new frame around the given primitive.
NewGrid returns a new grid-based layout container with no initial primitives.
NewInputField returns a new input field.
NewList returns a new form.
NewModal returns a new modal message window.
NewPages returns a new Pages object.
NewTable returns a new table.
NewTableCell returns a new table cell with sensible defaults.
NewTextView returns a new text view.
NewTreeNode returns a new tree node.
NewTreeView returns a new tree view.
Print prints text onto the screen into the given box at (x,y,maxWidth,1), not exceeding that box.
PrintJoinedSemigraphics prints a semigraphics rune into the screen at the given position with the given color, joining it with any existing semigraphics rune.
PrintSimple prints white text to the screen at the given position.goland:noinspection GoUnusedExportedFunction.
TaggedStringWidth returns the width of the given string needed to print it on screen.
TranslateANSI replaces ANSI escape sequences found in the provided string with tview's color tags and returns the resulting string.goland:noinspection GoUnusedExportedFunction.
WordWrap splits a text such that each resulting line does not exceed the given screen width.
# Constants
Text alignment within a box.
Text alignment within a box.
Text alignment within a box.
╦.
╗.
╔.
═.
╩.
╝.
╚.
║.
╬.
╣.
╠.
╥.
╖.
╓.
┟.
┰.
┒.
┧.
┎.
╁.
┑.
┍.
┡.
┯.
┨.
╇.
╤.
╕.
╒.
╍.
╏.
╻.
┳.
┓.
┏.
━.
╸.
╾.
┉.
┋.
╺.
┅.
┇.
╹.
┻.
┛.
╿.
┗.
┃.
╋.
┫.
┣.
╅.
┭.
┵.
┽.
┲.
┺.
╊.
╃.
╮.
╭.
╯.
╰.
╳.
╲.
╱.
╌.
╎.
╷.
┬.
┐.
┌.
─.
╴.
╼.
┈.
┊.
╶.
┄.
┆.
╵.
╽.
┴.
┘.
└.
│.
┼.
┤.
├.
╆.
┮.
┶.
┾.
┱.
┹.
╉.
╄.
╜.
╨.
╙.
╀.
┸.
┦.
┚.
┞.
┖.
╈.
┷.
┪.
┙.
┢.
┕.
╧.
╛.
╘.
╫.
╢.
╟.
╂.
┨.
┠.
┿.
┥.
┝.
╪.
╡.
╞.
goland:noinspection GoUnusedConst.
Configuration values.
Configuration values.
goland:noinspection GoUnusedConst.
goland:noinspection GoUnusedConst.
….
goland:noinspection GoUnusedConst.
# Variables
Borders defines various borders used when primitives are drawn.
DefaultFormFieldWidth is the default field screen width of form elements whose field width is flexible (0).
InputFieldFloat accepts floating-point numbers.
InputFieldInteger accepts integers.
InputFieldMaxLength returns an input field accept handler which accepts input strings up to a given length.
IsVtxxx indicates whether the TERM environment variable matches that of a VTxxx terminal, for example VT320.
SemigraphicJoints is a map for joining semigraphic (or otherwise) runes.
Styles defines the theme for applications.
TabSize is the number of spaces with which a tab character will be replaced.
# Structs
Application represents the top node of an application.
Box implements Primitive with a background and optional elements such as a border and a title.
Button is labeled box that triggers an action when selected.
Checkbox implements a simple box for boolean values which can be checked and unchecked.
DropDown implements a selection widget whose options become visible in a drop-down list when activated.
Flex is a basic implementation of the Flexbox layout.
Form allows you to combine multiple one-line form elements into a vertical or horizontal layout.
Frame is a wrapper which adds a border around another primitive.
Grid is an implementation of a grid-based layout.
InputField is a one-line box (three lines if there is a title) where the user can enter text.
List displays rows of items, each of which can be selected.
Modal is a centered message window used to inform the user or prompt them for an immediate decision.
Pages is a container for other primitives often used as the application's root primitive.
Table visualizes two-dimensional data consisting of rows and columns.
TableCell represents one cell inside a Table.
TextView is a box which displays text.
Theme defines the colors used when primitives are initialized.
TreeNode represents one node in a tree view.
TreeView displays tree structures.
# Interfaces
Focusable provides a method which determines if a primitive has focus.
FormItem is the interface all form items must implement to be able to be included in a form.
MouseSupport defines wether a component supports accepting mouse events.
Primitive is the top-most interface for all graphical primitives.
# Type aliases
FocusDirection decides in what direction the focus should travel relative to the currently focused component.
No description provided by the author