cview/doc_test.go

115 lines
2.9 KiB
Go
Raw Permalink Normal View History

package cview
import (
"fmt"
2020-08-30 15:36:03 +00:00
"github.com/gdamore/tcell/v2"
)
// Example of an application with multiple layouts.
func ExampleNewApplication() {
// Initialize application.
app := NewApplication()
// Handle panics gracefully.
defer app.HandlePanic()
// Create shared TextView.
sharedTextView := NewTextView()
sharedTextView.SetTextAlign(AlignCenter)
sharedTextView.SetText("Widgets may be re-used between multiple layouts.")
// Create main layout using Grid.
mainTextView := NewTextView()
mainTextView.SetTextAlign(AlignCenter)
mainTextView.SetText("This is mainLayout.\n\nPress <Tab> to view aboutLayout.")
mainLayout := NewGrid()
mainLayout.AddItem(mainTextView, 0, 0, 1, 1, 0, 0, false)
mainLayout.AddItem(sharedTextView, 1, 0, 1, 1, 0, 0, false)
// Create about layout using Grid.
aboutTextView := NewTextView()
aboutTextView.SetTextAlign(AlignCenter)
aboutTextView.SetText("cview muti-layout application example\n\nhttps://code.rocketnine.space/tslocum/cview")
aboutLayout := NewGrid()
aboutLayout.AddItem(aboutTextView, 0, 0, 1, 1, 0, 0, false)
aboutLayout.AddItem(sharedTextView, 1, 0, 1, 1, 0, 0, false)
// Track the current layout.
currentLayout := 0
// Set an input capture function that switches between layouts when the tab
// key is pressed.
app.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
if event.Key() == tcell.KeyTab {
if currentLayout == 0 {
currentLayout = 1
app.SetRoot(aboutLayout, true)
} else {
currentLayout = 0
app.SetRoot(mainLayout, true)
}
// Return nil to stop propagating the event to any remaining
// handlers.
return nil
}
// Return the event to continue propagating it.
return event
})
// Run the application.
app.SetRoot(mainLayout, true)
if err := app.Run(); err != nil {
panic(err)
}
}
// Example of an application with mouse support.
func ExampleApplication_EnableMouse() {
2020-04-14 16:46:24 +00:00
// Initialize application.
app := NewApplication()
// Handle panics gracefully.
defer app.HandlePanic()
2020-04-14 16:46:24 +00:00
// Enable mouse support.
app.EnableMouse(true)
// Enable double clicks.
app.SetDoubleClickInterval(StandardDoubleClick)
// Create a textview.
tv := NewTextView()
tv.SetText("Click somewhere!")
// Set a mouse capture function which prints where the mouse was clicked.
app.SetMouseCapture(func(event *tcell.EventMouse, action MouseAction) (*tcell.EventMouse, MouseAction) {
if action == MouseLeftClick || action == MouseLeftDoubleClick {
actionLabel := "click"
if action == MouseLeftDoubleClick {
actionLabel = "double-click"
}
x, y := event.Position()
fmt.Fprintf(tv, "\nYou %sed at %d,%d! Amazing!", actionLabel, x, y)
// Return nil to stop propagating the event to any remaining handlers.
return nil, 0
}
// Return the event to continue propagating it.
return event, action
})
// Run the application.
app.SetRoot(tv, true)
if err := app.Run(); err != nil {
panic(err)
}
}