118 lines
3.0 KiB
Go
118 lines
3.0 KiB
Go
/*
|
|
|
|
Package gui implements a abstraction layer for Go visual elements in
|
|
a cross platform and library independent way. (hopefully this is will work)
|
|
|
|
A quick overview of the features, some general design guidelines
|
|
and principles for how this package should generally work:
|
|
|
|
Definitions:
|
|
|
|
* Toolkit: the underlying library (MacOS gui, Windows gui, gtk, qt, etc)
|
|
* Node: A binary tree of all the underlying GUI toolkit elements
|
|
|
|
Principles:
|
|
|
|
* Make code using this package simple to use
|
|
* When in doubt, search upward in the binary tree
|
|
* It's ok to guess. We will return something close.
|
|
* Hide complexity internally here
|
|
* Isolate the GUI toolkit
|
|
* Try to use [Wikipedia Graphical widget] names
|
|
|
|
Quick Start
|
|
|
|
This section demonstrates how to quickly get started with spew. See the
|
|
sections below for further details on formatting and configuration options.
|
|
|
|
// This creates a simple hello world window
|
|
package main
|
|
|
|
import (
|
|
"log"
|
|
"git.wit.org/wit/gui"
|
|
)
|
|
|
|
var window *gui.Node // This is the beginning of the binary tree of widgets
|
|
|
|
// go will sit here until the window exits
|
|
func main() {
|
|
gui.Main(helloworld)
|
|
}
|
|
|
|
// This initializes the first window and 2 tabs
|
|
func helloworld() {
|
|
gui.Config.Title = "Hello World golang wit/gui Window"
|
|
gui.Config.Width = 640
|
|
gui.Config.Height = 480
|
|
|
|
window := gui.NewWindow()
|
|
addTab(window, "A Simple Tab Demo")
|
|
addTab(window, "A Second Tab")
|
|
}
|
|
|
|
func addTab(w *gui.Node, title string) {
|
|
tab := w.NewTab(title)
|
|
|
|
group := tab.NewGroup("foo bar")
|
|
group.NewButton("hello", func() {
|
|
log.Println("world")
|
|
})
|
|
}
|
|
|
|
|
|
Debian Build
|
|
|
|
This worked on debian sid on 2022/10/20
|
|
I didn't record the dependances needed
|
|
|
|
GO111MODULE="off" go get -v -t -u git.wit.org/wit/gui
|
|
cd ~/go/src/git.wit.org/wit/gui/cmds/helloworld/
|
|
GO111MODULE="off" go build -v -x
|
|
./helloworld
|
|
|
|
Toolkits
|
|
|
|
The goal is to design something that will work with more than one.
|
|
|
|
Right now, this abstraction is built on top of the go package 'andlabs/ui'
|
|
which does the cross platform support.
|
|
The next step is to intent is to allow this to work directly against GTK and QT.
|
|
|
|
It should be able to add Fyne, WASM, native macos & windows, android and
|
|
hopefully also things like libSDL, faiface/pixel, slint
|
|
|
|
Errors
|
|
|
|
Since it is possible for custom Stringer/error interfaces to panic, spew
|
|
detects them and handles them internally by printing the panic information
|
|
inline with the output. Since spew is intended to provide deep pretty printing
|
|
capabilities on structures, it intentionally does not return any errors.
|
|
|
|
Debugging
|
|
|
|
To dump variables with full newlines, indentation, type, and pointer
|
|
information this uses spew.Dump()
|
|
|
|
Bugs
|
|
|
|
"The author's idea of friendly may differ to that of many other people."
|
|
|
|
-- manpage quote from the excellent minimalistic window manager 'evilwm'
|
|
|
|
References
|
|
|
|
Useful links and other
|
|
external things
|
|
which might be useful
|
|
|
|
[Wikipedia Graphical widget]: https://en.wikipedia.org/wiki/Graphical_widget
|
|
[Github mirror]: https://github.com/witorg/gui
|
|
|
|
* [Wikipedia Graphical widget]
|
|
* [Github mirror]
|
|
|
|
|
|
*/
|
|
package gui
|