Browse Source

Link to relevant functions in FORK.md

tablepad
Trevor Slocum 2 years ago
parent
commit
4411a746d8
  1. 9
      FORK.md
  2. 39
      doc.go

9
FORK.md

@ -26,11 +26,11 @@ maintainers and allowing code changes which may be outside of tview's scope.
# Differences
## cview is thread-safe
## cview is [thread-safe](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#hdr-Concurrency)
tview [is not thread-safe](https://godoc.org/github.com/rivo/tview#hdr-Concurrency).
## Application.QueueUpdate and Application.QueueUpdateDraw do not block
## [Application.QueueUpdate](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Application.QueueUpdate) and [Application.QueueUpdateDraw](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Application.QueueUpdateDraw) do not block
tview [blocks until the queued function returns](https://github.com/rivo/tview/blob/fe3052019536251fd145835dbaa225b33b7d3088/application.go#L510).
@ -40,11 +40,12 @@ All clicks are handled as single clicks until an interval is set with [Applicati
## Setting a primitive's background color to `tcell.ColorDefault` does not result in transparency
Call `SetBackgroundTransparent(true)` to enable background transparency.
Call [Box.SetBackgroundTransparent](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#Box.SetBackgroundTransparent)
to enable background transparency.
## Lists and Forms do not wrap around by default
Call `SetWrapAround(true)` to wrap around when navigating.
Call [List.SetWrapAround](https://docs.rocketnine.space/gitlab.com/tslocum/cview/#List.SetWrapAround) to wrap around when navigating.
# Merged pull requests

39
doc.go

@ -2,7 +2,7 @@
Package cview implements rich widgets for terminal based user interfaces.
See the demos folder and the example application provided with the
Application.NewApplication documentation for usage examples.
NewApplication documentation for usage examples.
Widgets
@ -27,6 +27,9 @@ The following widgets are available:
TreeView - A scrollable display for hierarchical data. Tree nodes can be
highlighted, collapsed, expanded, and more.
Widgets may be used without an application created via NewApplication, allowing
them to be integrated into any tcell-based application.
Base Primitive
Widgets must implement the Primitive interface. All widgets embed the base
@ -53,6 +56,23 @@ Unicode Support
This package supports unicode characters including wide characters.
Keyboard Shortcuts
Widgets use keyboard shortcuts (a.k.a. keybindings) such as arrow keys and
H/J/K/L by default. You may replace these defaults by modifying the shortcuts
listed in Keys. You may also override keyboard shortcuts globally by setting a
handler with Application.SetInputCapture.
cbind is a library which simplifies the process of adding support for custom
keyboard shortcuts to your application. It allows setting handlers for
EventKeys. It also translates between EventKeys and human-readable strings such
as "Alt+Enter". This makes it possible to store keybindings in a configuration
file.
cbind: https://gitlab.com/tslocum/cbind
cbind example: https://docs.rocketnine.space/gitlab.com/tslocum/cbind/#example_NewConfiguration
Mouse Support
Mouse support may be enabled by calling Application.EnableMouse before
@ -147,23 +167,6 @@ When primitives are instantiated, they are initialized with colors taken from
the global Styles variable. You may change this variable to adapt the look and
feel of the primitives to your preferred style.
Keyboard Shortcuts
Widgets use keyboard shortcuts (a.k.a. keybindings) such as arrow keys and
H/J/K/L by default. You may replace these defaults by modifying the shortcuts
listed in Keys. You may also override keyboard shortcuts globally by setting a
handler with Application.SetInputCapture.
cbind is a library which simplifies the process of adding support for custom
keyboard shortcuts to your application. It allows setting handlers for
EventKeys. It also translates between EventKeys and human-readable strings such
as "Alt+Enter". This makes it possible to store keybindings in a configuration
file.
cbind: https://gitlab.com/tslocum/cbind
cbind example: https://docs.rocketnine.space/gitlab.com/tslocum/cbind/#example_NewConfiguration
Hello World
The following is an example application which shows a box titled "Greetings"

Loading…
Cancel
Save