Graphics.Vty.Widgets.ProgressBar

This module provides a ''progress bar'' widget which stores a progress value between 0 and 100 inclusive. Use the schedule function to modify the progress bar's state from a thread.

Documentation

data ProgressBar

newProgressBar :: MonadIO m => Color -> Color -> m ProgressBar

Create a new progress bar with the specified completed and uncompleted colors, respectively.

progressBarWidget :: ProgressBar -> Widget (Box HFill HFill)

Get the widget of a progress bar.

setProgress :: MonadIO m => ProgressBar -> Int -> m ()

Set the progress bar's progress value. Values outside the allowed range will be ignored.

addProgress :: MonadIO m => ProgressBar -> Int -> m ()

Add a delta value to the progress bar's current value.

getProgress :: MonadIO m => ProgressBar -> m Int

Get the progress bar's current progress value.

onProgressChange :: MonadIO m => ProgressBar -> (Int -> IO ()) -> m ()

Register a handler to be invoked when the progress bar's progress value changes. The handler will be passed the new progress value.