Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodrigocfd/windigo
Windows API and GUI in idiomatic Go.
https://github.com/rodrigocfd/windigo
ffi go golang gui native win32 windows
Last synced: about 3 hours ago
JSON representation
Windows API and GUI in idiomatic Go.
- Host: GitHub
- URL: https://github.com/rodrigocfd/windigo
- Owner: rodrigocfd
- License: mit
- Created: 2021-02-18T10:46:06.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-02T21:40:01.000Z (5 months ago)
- Last Synced: 2025-01-25T22:02:45.427Z (7 days ago)
- Topics: ffi, go, golang, gui, native, win32, windows
- Language: Go
- Homepage: https://pkg.go.dev/github.com/rodrigocfd/windigo
- Size: 2.49 MB
- Stars: 425
- Watchers: 13
- Forks: 24
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/rodrigocfd/windigo)
[](https://github.com/rodrigocfd/windigo)
[](https://github.com/rodrigocfd/windigo)
[](https://opensource.org/licenses/MIT)
# Windigo
Win32 API and GUI in idiomatic Go.
## Overview
The UI library is divided in the following packages:
| Package | Description |
| - | - |
| `ui` | High-level UI wrappers for windows and controls. |
| `ui/wm` | High-level event parameters (Windows message callbacks). |
For the Win32 API bindings:
| Package | Description |
| - | - |
| [`win`](win/) | Native Win32 structs, handles and functions. |
| [`win/co`](win/co/) | Native Win32 constants, all typed. |
| `win/errco` | Native Win32 [error codes](https://learn.microsoft.com/en-us/windows/win32/debug/system-error-codes), with types `errco.ERROR` and `errco.CDERR`. |
For the [COM](win/com/) bindings, there is the main package, and two subpackages – the `co` suffix contains the constants, and the `vt` contains the virtual tables:
| Packages | Description |
| - | - |
| `win/com/autom`
`win/com/autom/automco`
`win/com/autom/automvt` | Native Win32 [Automation](https://learn.microsoft.com/en-us/windows/win32/api/_automat/) COM interfaces. |
| `win/com/com`
`win/com/com/comco`
`win/com/com/comvt` | Native Win32 [COM API base](https://learn.microsoft.com/en-us/windows/win32/api/_com/). |
| `win/com/d2d1`
`win/com/d2d1/d2d1co`
`win/com/d2d1/d2d1vt` | Native Win32 [Direct2D](https://learn.microsoft.com/en-us/windows/win32/direct2d/direct2d-portal) COM interfaces. |
| `win/com/dshow`
`win/com/dshow/dshowco`
`win/com/dshow/dshowvt` | Native Win32 [DirectShow](https://learn.microsoft.com/en-us/windows/win32/directshow/directshow) COM interfaces. |
| `win/com/shell`
`win/com/shell/shellco`
`win/com/shell/shellvt` | Native Win32 [Shell](https://learn.microsoft.com/en-us/windows/win32/api/_shell/) COM interfaces. |
Windigo is designed to be familiar to Win32 programmers, using the same concepts, so most C/C++ Win32 tutorials should be applicable.
Windows and controls can be created in two ways:
* programmatically, by specifying the options used in the underlying [CreateWindowEx](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw);
* by loading [resources](https://en.wikipedia.org/wiki/Resource_(Windows)#Resource_software) from a `.rc` or a `.res` file.
CGo is **not** used, just syscalls.
## Error treatment
The native Win32 functions deal with errors in two ways:
* Recoverable errors will return an `errco.ERROR` value, which implements the [`error`](https://golang.org/pkg/builtin/#error) interface;
* Unrecoverable errors will simply **panic**. This avoids the excess of `if err != nil` with errors that cannot be recovered anyway, like internal Windows errors.
## Example
The example below creates a window programmatically, and handles the button click. Also, it uses the `minimal.syso` provided in the [resources](resources/) folder.
```go
package main
import (
"fmt"
"runtime"
"github.com/rodrigocfd/windigo/ui"
"github.com/rodrigocfd/windigo/win"
"github.com/rodrigocfd/windigo/win/co"
)
func main() {
runtime.LockOSThread()
myWindow := NewMyWindow() // instantiate
myWindow.wnd.RunAsMain() // ...and run
}
// This struct represents our main window.
type MyWindow struct {
wnd ui.WindowMain
lblName ui.Static
txtName ui.Edit
btnShow ui.Button
}
// Creates a new instance of our main window.
func NewMyWindow() *MyWindow {
wnd := ui.NewWindowMain(
ui.WindowMainOpts().
Title("Hello you").
ClientArea(win.SIZE{Cx: 340, Cy: 80}).
IconId(101), // ID of icon resource, see resources folder
)
me := &MyWindow{
wnd: wnd,
lblName: ui.NewStatic(wnd,
ui.StaticOpts().
Text("Your name").
Position(win.POINT{X: 10, Y: 22}),
),
txtName: ui.NewEdit(wnd,
ui.EditOpts().
Position(win.POINT{X: 80, Y: 20}).
Size(win.SIZE{Cx: 150}),
),
btnShow: ui.NewButton(wnd,
ui.ButtonOpts().
Text("&Show").
Position(win.POINT{X: 240, Y: 19}),
),
}
me.btnShow.On().BnClicked(func() {
msg := fmt.Sprintf("Hello, %s!", me.txtName.Text())
me.wnd.Hwnd().MessageBox(msg, "Saying hello", co.MB_ICONINFORMATION)
})
return me
}
```
## License
Licensed under [MIT license](https://opensource.org/licenses/MIT), see [LICENSE.md](LICENSE.md) for details.