5.5 KiB
gui
Package gui implements a abstraction layer for Go visual elements.
Definitions:
* Toolkit: the underlying GUI library (MacOS gui, Windows gui, gtk, qt, etc)
* Node: A binary tree of all the underlying widgets
Principles:
* Make code using this package simple to use
* Hide complexity internally here
* Isolate the GUI toolkit
* Widget names should try to match [Wikipedia Graphical widget]
* When in doubt, search upward in the binary tree
* It's ok to guess. Try to do something sensible.
Quick Start
// 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.Init()
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](./helloworld)
Toolkits
* andlabs - [https://github.com/andlabs/ui](https://github.com/andlabs/ui)
* gocui - [https://github.com/awesome-gocui/gocui](https://github.com/awesome-gocui/gocui)
The next step is to allow this to work against go-gtk and go-qt.
TODO: Add Fyne, WASM, native macos & windows, android and hopefully also things like libSDL, faiface/pixel, slint
Bugs
"The author's idea of friendly may differ to that of many other people."
-- quote from the minimalistic window manager 'evilwm'
References
Useful links and other external things which might be useful
* [Wikipedia Graphical widget]
* [Github mirror]
* [Federated git pull]
* [GO Style Guide]
Functions
func DebugWidgetWindow
func DebugWidgetWindow(w *Node)
func DebugWindow
func DebugWindow()
Creates a window helpful for debugging this package
func ExampleCatcher
func ExampleCatcher(f func())
func Indent
func Indent(b bool, a ...interface{})
func InitPlugins
func InitPlugins(names []string)
func LoadToolkit
func LoadToolkit(name string) bool
loads and initializes a toolkit (andlabs/ui, gocui, etc)
func Main
func Main(f func())
This should not pass a function
func SetDebug
func SetDebug(s bool)
func SetFlag
func SetFlag(s string, b bool)
func ShowDebugValues
func ShowDebugValues()
func StandardExit
func StandardExit()
The window is destroyed and the application exits TODO: properly exit the plugin since Quit() doesn't do it
func Watchdog
func Watchdog()
This program sits here. If you exit here, the whole thing will os.Exit()
This goroutine can be used like a watchdog timer
Types
type GuiArgs
type GuiArgs struct { ... }
This struct can be used with the go-arg package
type GuiConfig
type GuiConfig struct { ... }
Variables
var Config GuiConfig
type Node
type Node struct { ... }
The Node is a binary tree. This is how all GUI elements are stored simply the name and the size of whatever GUI element exists
func NewWindow
func NewWindow() *Node
This routine creates a blank window with a Title and size (W x H)
This routine can not have any arguements due to the nature of how it can be passed via the 'andlabs/ui' queue which, because it is cross platform, must pass UI changes into the OS threads (that is my guess).
This example demonstrates how to create a NewWindow()
Interacting with a GUI in a cross platform fashion adds some unusual problems. To obvuscate those, andlabs/ui starts a goroutine that interacts with the native gui toolkits on the Linux, MacOS, Windows, etc.
Because of this oddity, to initialize a new window, the function is not passed any arguements and instead passes the information via the Config type.
package main
import (
"git.wit.org/wit/gui"
)
func main() {
// Define the name and size
gui.Config.Title = "WIT GUI Window 1"
gui.Config.Width = 640
gui.Config.Height = 480
// Create the Window
gui.NewWindow()
}
Output:
You get a window
func Start
func Start() *Node
func StartS
func StartS(name string) *Node
type Symbol
type Symbol any
Sub Packages
Readme created from Go doc with goreadme