andlabs-ui/README.md

# ui: platform-native GUI library for Go

## Feature requests wanted! (Really; IDK what to add next!)

This is a library that aims to provide simple GUI software development in Go. It runs on/requires:

- Windows: cgo, MinGW-w64 (see note below), Windows XP and newer
	- **Note**: Notice I specifically said [MinGW-w64](http://mingw-w64.sourceforge.net/) here. This is important: regular MinGW is missing various recent header files which package ui uses, and thus won't build with it. Make sure your MinGW is that version instead. If you're running on Windows and are not sure what to download, get the mingw-builds distribution.
- Mac OS X: cgo, Mac OS X 10.7 and newer
- other Unixes: cgo, GTK+ 3.4 and newer

Go 1.4 RC1 or newer (including Go tip/master/direct from the source repository) is required. This is due to a variety of compiler and linker bugs on Windows and Mac OS X spanning the Go 1.3 release family.

(this README needs some work)

Be sure to have at least each outermost Window escaping to the heap until a good resolution to Go issue 8310 comes out.

prevlib.tar contains the previous version of the library as it stood when I restarted; don't bother using it.

# Documentation

The in-code documentation needs improvement. I have written a [tutorial](https://github.com/andlabs/ui/wiki/Getting-Started) in the Wiki.

# Updates

**5 November 2014**<br>TextFields can now be marked as read-only (non-editable). Textboxes will gain this ability soon.

**4 November 2014**<br>Added two new controls, Spinbox (which allows numeric entry with up and down buttons) and ProgressBar (which measures progress). Both aren't fully fleshed out, but are good enough for general use now.

**28 October 2014**<br>Mac OS X resizing issues should be (mostly?) fixed now. Textbox still doesn't work right...

**24 October 2014**<br>Textbox, a multi-line version of TextField, has been added. (Note that it may not work properly on Mac OS X; this is being investigated.) In addition, excess space around controls on Mac OS X should be settled now.

**18 October 2014**<br>The container system was rewritten entirely. You can now set a margin on Windows and Groups and spacing between controls ("padding") on Stacks, Grids, and SimpleGrids. Margins on Tabs will come soon. The work needed to change this will make future additions (like Popover and Spinbox) easier/more sensible. (The Mac OS X code is still glitchy; mind the dust.)

As part of the change, standalone Labels have been removed. All Labels now behave like standalone labels. A new layout container, Form, will be introduced in the near future to allow proper layout of widgets with labels.

**3 September 2014**<br>The new GtkGrid-style Grid is now implemented! See its documentation for more details. Also, debugging spew has been removed.

**31 August 2014**<br>Grid is now renamed SimpleGrid in preparation for implementing a more [GtkGrid](https://developer.gnome.org/gtk3/unstable/GtkGrid.html)-like Grid. Mind the change.

# Screenshots
The example widget gallery on GTK+ in the Adwaita theme (3.13/master):

![widget gallery example](https://raw.githubusercontent.com/andlabs/ui/master/examples/widgetgallery/widgetgallery.png)
Added a new README. 2014-08-30 22:05:36 -05:00			`# ui: platform-native GUI library for Go`

README updates. 2014-09-05 20:38:55 -05:00			`## Feature requests wanted! (Really; IDK what to add next!)`

Added a new README. 2014-08-30 22:05:36 -05:00			`This is a library that aims to provide simple GUI software development in Go. It runs on/requires:`

Re-added the note about MinGW-w64 to the README. It got lost in the rewrite migration. 2014-09-26 20:19:30 -05:00			`- Windows: cgo, MinGW-w64 (see note below), Windows XP and newer`
			`- Note: Notice I specifically said [MinGW-w64](http://mingw-w64.sourceforge.net/) here. This is important: regular MinGW is missing various recent header files which package ui uses, and thus won't build with it. Make sure your MinGW is that version instead. If you're running on Windows and are not sure what to download, get the mingw-builds distribution.`
			`- Mac OS X: cgo, Mac OS X 10.7 and newer`
			`- other Unixes: cgo, GTK+ 3.4 and newer`
Added a new README. 2014-08-30 22:05:36 -05:00
Now require Go 1.4 due to crazy Go bugs unfixed in 1.3 stable releases. Thanks to github user @infogulch. 2014-11-25 06:45:01 -06:00			`Go 1.4 RC1 or newer (including Go tip/master/direct from the source repository) is required. This is due to a variety of compiler and linker bugs on Windows and Mac OS X spanning the Go 1.3 release family.`
Added a new README. 2014-08-30 22:05:36 -05:00
			`(this README needs some work)`

README updates. 2014-09-05 20:38:55 -05:00			`Be sure to have at least each outermost Window escaping to the heap until a good resolution to Go issue 8310 comes out.`

Added a new README. 2014-08-30 22:05:36 -05:00			`prevlib.tar contains the previous version of the library as it stood when I restarted; don't bother using it.`
Added screenshot. 2014-08-30 22:33:57 -05:00
README updates. 2014-09-24 08:34:13 -05:00			`# Documentation`

Link to tutorial in README.md 2014-10-06 19:45:31 -05:00			`The in-code documentation needs improvement. I have written a [tutorial](https://github.com/andlabs/ui/wiki/Getting-Started) in the Wiki.`
README updates. 2014-09-24 08:34:13 -05:00
Changed Grid to SimpleGrid in preparation for a better Grid. 2014-08-31 12:02:47 -05:00			`# Updates`

Updated README. 2014-11-05 15:38:29 -06:00			`5 November 2014<br>TextFields can now be marked as read-only (non-editable). Textboxes will gain this ability soon.`

Updated README. 2014-11-04 10:57:33 -06:00			`4 November 2014<br>Added two new controls, Spinbox (which allows numeric entry with up and down buttons) and ProgressBar (which measures progress). Both aren't fully fleshed out, but are good enough for general use now.`

Updated the README and TODO lists. 2014-10-27 23:16:43 -05:00			`28 October 2014<br>Mac OS X resizing issues should be (mostly?) fixed now. Textbox still doesn't work right...`

README typo fixes. 2014-10-24 20:38:59 -05:00			`24 October 2014<br>Textbox, a multi-line version of TextField, has been added. (Note that it may not work properly on Mac OS X; this is being investigated.) In addition, excess space around controls on Mac OS X should be settled now.`
README updates. 2014-10-24 20:38:28 -05:00
Capitalize O in October. 2014-10-18 16:07:02 -05:00			`18 October 2014<br>The container system was rewritten entirely. You can now set a margin on Windows and Groups and spacing between controls ("padding") on Stacks, Grids, and SimpleGrids. Margins on Tabs will come soon. The work needed to change this will make future additions (like Popover and Spinbox) easier/more sensible. (The Mac OS X code is still glitchy; mind the dust.)`
Updated the README. 2014-10-18 16:05:33 -05:00
Whoops, forgot to document NewStandaloneLabel()'s demise and amend the example program. Fixed. 2014-10-18 16:40:12 -05:00			`As part of the change, standalone Labels have been removed. All Labels now behave like standalone labels. A new layout container, Form, will be introduced in the near future to allow proper layout of widgets with labels.`

More TODOs and updated README. 2014-09-03 20:04:52 -05:00			`3 September 2014<br>The new GtkGrid-style Grid is now implemented! See its documentation for more details. Also, debugging spew has been removed.`

Changed Grid to SimpleGrid in preparation for a better Grid. 2014-08-31 12:02:47 -05:00			`31 August 2014<br>Grid is now renamed SimpleGrid in preparation for implementing a more [GtkGrid](https://developer.gnome.org/gtk3/unstable/GtkGrid.html)-like Grid. Mind the change.`

Added screenshot. 2014-08-30 22:33:57 -05:00			`# Screenshots`
			`The example widget gallery on GTK+ in the Adwaita theme (3.13/master):`

Okay, fixed for real now 2014-08-30 22:35:22 -05:00			`![widget gallery example](https://raw.githubusercontent.com/andlabs/ui/master/examples/widgetgallery/widgetgallery.png)`