|
|
|
|
|
| Description |
| The ProgressBar provides a means for an application to keep the user
patient while some time intensive task is going on.
|
|
| Synopsis |
|
|
|
| Documentation |
|
| progressBarNew :: IO ProgressBar |
| Create a new ProgreeBar.
|
|
| progressBarPulse :: ProgressBarClass pb => pb -> IO () |
| 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).
|
|
| progressBarSetText :: ProgressBarClass pb => pb -> String -> IO () |
| Causes the given text to appear
superimposed on the progress bar.
|
|
| progressBarSetFraction :: ProgressBarClass pb => pb -> Double -> IO () |
| Causes the progress bar to `fill in' the
given fraction of the bar. The fraction should be between 0.0 and 1.0,
inclusive.
|
|
| progressBarSetPulseStep :: ProgressBarClass pb => pb -> Double -> IO () |
Sets the fraction of total progress bar
length to move the bouncing block for each call to progressBarPulse.
- The fraction parameter must be between 0.0 and 1.0.
|
|
| progressBarGetFraction :: ProgressBarClass pb => pb -> IO Double |
| Returns the current fraction of the task
that has been completed.
|
|
| progressBarGetPulseStep :: ProgressBarClass pb => pb -> IO Double |
| Returns the current pulseStep of the task
that has been completed.
|
|
| progressBarGetText :: ProgressBarClass pb => pb -> IO (Maybe String) |
Retrieve the text displayed superimposed on the
ProgressBar.
- Returns Nothing if no text was set.
|
|
| data ProgressBarOrientation |
| Is the ProgressBar horizontally or vertically
directed?
| | Constructors | | ProgressLeftToRight | | | ProgressRightToLeft | | | ProgressBottomToTop | | | ProgressTopToBottom | |
| | Instances | |
|
|
| progressBarSetOrientation :: ProgressBarClass pb => pb -> ProgressBarOrientation -> IO () |
| Causes the progress bar to switch to a
different orientation (left-to-right, right-to-left, top-to-bottom, or
bottom-to-top).
|
|
| progressBarGetOrientation :: ProgressBarClass pb => pb -> IO ProgressBarOrientation |
| Retrieve the current ProgressBar
orientation.
|
|
| Produced by Haddock version 0.6 |
