progress - Constructor

Create a progress meter

Synopsis
progress(min, max, title, subtitle, minlabel, maxlabel, estimate_time, barwidth, barheight, startopen)

Description
Create a progress meter. If have_gui() is false (for example, no DISPLAY environment variable is set) this results in a no-op tool. You generally do not need to set minlabel and maxlabel, since the defaults are generally what you want.

Note that min may in fact be greater than max. If so, the progress meter will ``count down'' correctly.

The startopen parameter is a little unusual. If it is a boolean (tt T or F) then, if true, the progress meter starts with the GUI ``on''. If a number, the progress meter's GUI turns on after the supplied number of seconds has elapsed. The reason this has been implemented is that it is distracting to see very short-lived progress meters popping up and disappearing very quickly.

Arguments

min	minimum value
	Allowed:	Numeric
max	maximum value
	Allowed:	Numeric
title	window title
	Allowed:	String
	Default:	""
subtitle	bar title
	Allowed:	String
	Default:	""
minlabel	left label
	Allowed:	String
	Default:	"" (minimum value)
maxlabel	right label
	Allowed:	String
	Default:	"" (maximum value)
estimate_time	estimate time remaining?
	Allowed:	Boolean
	Default:	T
barwidth	width of bar in pixels
	Allowed:	Integer
	Default:	200
barheight	height of bar in pixels
	Allowed:	Integer
	Default:	20
startopen	start with the window displayed? Or, how long to wait before displaying?
	Allowed:	Boolean or Integer
	Default:	5

Returns
progress tool

Next: progress.update - Function Up: progress - Tool Previous: progress - Tool Contents Index

	Package	display
	Module	guiutils
	Tool	progress