taffybar-1.0.1: A desktop bar similar to xmobar, but with more GUI

Safe HaskellNone
LanguageHaskell2010

System.Taffybar.Battery

Description

This module provides battery widgets using the UPower system service.

Currently it reports only the first battery it finds. If it does not find a battery, it just returns an obnoxious widget with warning text in it. Battery hotplugging is not supported. These more advanced features could be supported if there is interest.

Synopsis

Documentation

batteryBarNew :: BarConfig -> Double -> IO Widget Source #

A fancy graphical battery widget that represents batteries as colored vertical bars (one per battery). There is also a textual percentage reppadout next to the bars, containing a summary of battery information.

batteryBarNewWithFormat :: BarConfig -> String -> Double -> IO Widget Source #

A battery bar constructor which allows using a custom format string in order to display more information, such as charging/discharging time and status. An example: "$percentage$% ($time$) - $status$".

textBatteryNew Source #

Arguments

:: [IORef BatteryContext] 
-> String

Display format

-> Double

Poll period in seconds

-> IO Widget 

A simple textual battery widget that auto-updates once every polling period (specified in seconds). The displayed format is specified format string where $percentage$ is replaced with the percentage of battery remaining and $time$ is replaced with the time until the battery is fully charged/discharged.

Multiple battery values are combined as follows: - for time remaining, the largest value is used. - for percentage, the mean is taken.

defaultBatteryConfig :: BarConfig Source #

A default configuration for the graphical battery display. The bar will be red when power is critical (< 10%), green if it is full (> 90%), and grey otherwise.

You can customize this with any of the options in BarConfig