summaryrefslogtreecommitdiff
path: root/area.go
diff options
context:
space:
mode:
authorPietro Gagliardi <[email protected]>2014-04-12 14:07:31 -0400
committerPietro Gagliardi <[email protected]>2014-04-12 14:07:31 -0400
commitaef419a83edf8d897fa48d87399df3753fc44504 (patch)
tree826036132293735f2af2ccce44c10590355952ff /area.go
parentae4950bbd8a4dcae995da86a8b637ff13e8a90f2 (diff)
Documented the thread safety of AreaHandler and Area.SetSize().
Diffstat (limited to 'area.go')
-rw-r--r--area.go3
1 files changed, 2 insertions, 1 deletions
diff --git a/area.go b/area.go
index c9734d5..d320410 100644
--- a/area.go
+++ b/area.go
@@ -37,7 +37,7 @@ type Area struct {
}
// AreaHandler represents the events that an Area should respond to.
-// You are responsible for the thread safety of any members of the actual type that implements ths interface.
+// These methods are all executed on the main goroutine, not necessarily the same one that you created the AreaHandler in; you are responsible for the thread safety of any members of the actual type that implements ths interface.
// (Having to use this interface does not strike me as being particularly Go-like, but the nature of Paint makes channel-based event handling a non-option; in practice, deadlocks occur.)
type AreaHandler interface {
// Paint is called when the Area needs to be redrawn.
@@ -287,6 +287,7 @@ func NewArea(width int, height int, handler AreaHandler) *Area {
// SetSize sets the Area's internal drawing size.
// It has no effect on the actual control size.
+// SetSize is safe for concurrent use; if the Area is being repainted or is handling an event, SetSize will wait for that to complete before changing the Area's size.
// It panics if width or height is zero or negative.
func (a *Area) SetSize(width int, height int) {
a.lock.Lock()