2014-02-24 23:13:47 -06:00
// 25 february 2014
2014-03-12 20:55:45 -05:00
2014-02-24 23:13:47 -06:00
package ui
import (
2014-02-24 23:48:23 -06:00
"sync"
2014-02-24 23:13:47 -06:00
)
// A ProgressBar is a horizontal rectangle that fills up from left to right to indicate the progress of a long-running task.
2014-03-12 16:12:41 -05:00
// This progress is represented by an integer within the range [0,100], representing a percentage.
// Alternatively, a progressbar can show an animation indicating that progress is being made but how much is indeterminate.
// Newly-created ProgressBars default to showing 0% progress.
2014-02-24 23:13:47 -06:00
type ProgressBar struct {
2014-06-10 10:23:00 -05:00
lock sync . Mutex
created bool
sysData * sysData
initProg int
2014-02-24 23:13:47 -06:00
}
// NewProgressBar creates a new ProgressBar.
func NewProgressBar ( ) * ProgressBar {
return & ProgressBar {
2014-06-10 10:23:00 -05:00
sysData : mksysdata ( c_progressbar ) ,
2014-02-24 23:13:47 -06:00
}
}
2014-03-12 16:12:41 -05:00
// SetProgress sets the currently indicated progress amount on the ProgressBar.
// If percent is in the range [0,100], the progressBar shows that much percent complete.
// If percent is -1, the ProgressBar is made indeterminate.
// Otherwise, SetProgress panics.
2014-06-04 18:09:26 -05:00
// Calling SetProgress(-1) repeatedly will neither leave indeterminate mode nor stop any animation involved in indeterminate mode indefinitely; any other side-effect of doing so is implementation-defined.
2014-02-24 23:13:47 -06:00
func ( p * ProgressBar ) SetProgress ( percent int ) {
2014-03-18 10:50:56 -05:00
p . lock . Lock ( )
defer p . lock . Unlock ( )
2014-03-12 16:12:41 -05:00
if percent < - 1 || percent > 100 {
panic ( "percent value out of range" )
2014-02-24 23:31:48 -06:00
}
2014-02-24 23:13:47 -06:00
if p . created {
p . sysData . setProgress ( percent )
return
}
p . initProg = percent
}
func ( p * ProgressBar ) make ( window * sysData ) error {
p . lock . Lock ( )
defer p . lock . Unlock ( )
2014-04-01 15:43:56 -05:00
err := p . sysData . make ( window )
2014-02-24 23:13:47 -06:00
if err != nil {
return err
}
p . sysData . setProgress ( p . initProg )
p . created = true
return nil
}
2014-06-25 21:17:26 -05:00
func ( p * ProgressBar ) allocate ( x int , y int , width int , height int , d * sysSizeData ) [ ] * allocation {
return [ ] * allocation { & allocation {
2014-06-10 10:23:00 -05:00
x : x ,
y : y ,
width : width ,
height : height ,
2014-06-25 21:17:26 -05:00
this : p ,
} }
2014-02-24 23:13:47 -06:00
}
2014-06-25 21:17:26 -05:00
func ( p * ProgressBar ) preferredSize ( d * sysSizeData ) ( width int , height int ) {
return p . sysData . preferredSize ( d )
}
func ( p * ProgressBar ) commitResize ( a * allocation , d * sysSizeData ) {
2014-06-25 22:21:57 -05:00
p . sysData . commitResize ( a , d )
2014-06-25 21:17:26 -05:00
}
func ( p * ProgressBar ) getAuxResizeInfo ( d * sysSizeData ) {
p . sysData . getAuxResizeInfo ( d )
2014-02-24 23:13:47 -06:00
}