Name

ProgressBar —

The ProgressBar provides a means for an application to keep the user patient while some time intensive task is going on.

Synopsis

progressBarNew:: IO ProgressBar
progressBarGetFraction:: ProgressBarClass pb => pb -> IO Double
progressBarGetOrientation:: ProgressBarClass pb => pb -> IO ProgressBarOrientation
progressBarGetPulseStep:: ProgressBarClass pb => pb -> IO Double
progressBarGetText:: ProgressBarClass pb => pb -> IO (Maybe String)
progressBarPulse:: ProgressBarClass pb => pb -> IO ()
progressBarSetFraction:: ProgressBarClass pb => pb -> Double -> IO ()
progressBarSetOrientation:: ProgressBarClass pb => pb -> ProgressBarOrientation -> IO ()
progressBarSetPulseStep:: ProgressBarClass pb => pb -> Double -> IO ()
progressBarSetText:: ProgressBarClass pb => pb -> String -> IO ()

Constructors

progressBarNew

Create a new ProgreeBar.

progressBarNew

Methods

progressBarGetFraction

Returns the current fraction of the task that has been completed.

progressBarGetFraction:: pb:: IO Double
pb

progressBarGetOrientation

Retrieve the current ProgressBar orientation.

progressBarGetOrientation:: pb:: IO ProgressBarOrientation
pb

progressBarGetPulseStep

Returns the current pulseStep of the task that has been completed.

progressBarGetPulseStep:: pb:: IO Double
pb

progressBarGetText

Retrieve the text displayed superimposed on the ProgressBar.

progressBarGetText:: pb:: IO (Maybe String)
pb

Returns Nothing if no text was set.

progressBarPulse

Indicates that some progress is made, but you don't know how much. Causes the progress bar to enter `activity mode', where a block bounces back and forth. Each call to progressBarPulse causes the block to move on by a little bit (the amount of movement per pulse is determined by progressBarSetPulseStep).

progressBarPulse:: pb:: IO ()
pb

progressBarSetFraction

Causes the progress bar to `fill in' the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

progressBarSetFraction:: pb:: Double:: IO ()
pbfraction

progressBarSetOrientation

Causes the progress bar to switch to a different orientation (left-to-right, right-to-left, top-to-bottom, or bottom-to-top).

progressBarSetOrientation:: pb:: ProgressBarOrientation:: IO ()
pborientation

progressBarSetPulseStep

Sets the fraction of total progress bar length to move the bouncing block for each call to progressBarPulse.

progressBarSetPulseStep:: pb:: Double:: IO ()
pbfraction

The fraction parameter must be between 0.0 and 1.0.

progressBarSetText

Causes the given text to appear superimposed on the progress bar.

progressBarSetText:: pb:: String:: IO ()
pbtext