aboutsummaryrefslogtreecommitdiff
path: root/vendor/maunium.net/go/tview/doc.go
diff options
context:
space:
mode:
authorTulir Asokan <tulir@maunium.net>2018-11-14 00:00:35 +0200
committerTulir Asokan <tulir@maunium.net>2018-11-14 00:00:35 +0200
commitba387764ca1590625d349e74eb8a8a64d1849b67 (patch)
treebc8f02156a63eac99dcddaed38e45b7c312b40c0 /vendor/maunium.net/go/tview/doc.go
parentcfb2cc057c32330be0ca0a68cfbd245cb2b8e31b (diff)
Fix things
Diffstat (limited to 'vendor/maunium.net/go/tview/doc.go')
-rw-r--r--vendor/maunium.net/go/tview/doc.go31
1 files changed, 27 insertions, 4 deletions
diff --git a/vendor/maunium.net/go/tview/doc.go b/vendor/maunium.net/go/tview/doc.go
index ccaaaf1..ddc410f 100644
--- a/vendor/maunium.net/go/tview/doc.go
+++ b/vendor/maunium.net/go/tview/doc.go
@@ -7,10 +7,12 @@ Widgets
The package implements the following widgets:
- - TextView: Scrollable windows that display multi-colored text. Text may also
+ - TextView: A scrollable window that display multi-colored text. Text may also
be highlighted.
- - Table: Scrollable display of tabular data. Table cells, rows, or columns may
- also be highlighted.
+ - Table: A scrollable display of tabular data. Table cells, rows, or columns
+ may also be highlighted.
+ - TreeView: A scrollable display for hierarchical data. Tree nodes can be
+ highlighted, collapsed, expanded, and more.
- List: A navigable text list with optional keyboard shortcuts.
- InputField: One-line input fields to enter text.
- DropDown: Drop-down selection fields.
@@ -83,7 +85,7 @@ tag is as follows:
[<foreground>:<background>:<flags>]
-Each of the three fields can be left blank and trailing fields can be ommitted.
+Each of the three fields can be left blank and trailing fields can be omitted.
(Empty square brackets "[]", however, are not considered color tags.) Colors
that are not specified will be left unchanged. A field with just a dash ("-")
means "reset to default".
@@ -135,6 +137,27 @@ Unicode Support
This package supports unicode characters including wide characters.
+Concurrency
+
+Many functions in this package are not thread-safe. For many applications, this
+may not be an issue: If your code makes changes in response to key events, it
+will execute in the main goroutine and thus will not cause any race conditions.
+
+If you access your primitives from other goroutines, however, you will need to
+synchronize execution. The easiest way to do this is to call
+Application.QueueUpdate() or Application.QueueUpdateDraw() (see the function
+documentation for details):
+
+ go func() {
+ app.QueueUpdateDraw(func() {
+ table.SetCellSimple(0, 0, "Foo bar")
+ })
+ }()
+
+One exception to this is the io.Writer interface implemented by TextView. You
+can safely write to a TextView from any goroutine. See the TextView
+documentation for details.
+
Type Hierarchy
All widgets listed above contain the Box type. All of Box's functions are