System.Taffybar.Widget

Documentation

module System.Taffybar.Widget.Util

System.Taffybar.Widget.Battery

batteryBarNew :: MonadIO m => BarConfig -> Double -> m Widget

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 :: MonadIO m => BarConfig -> String -> Double -> m Widget

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

Arguments

:: [IORef BatteryContext]

-> String

Display format

-> Double

Poll period in seconds

-> IO Widget

defaultBatteryConfig :: BarConfig

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

System.Taffybar.Widget.CPUMonitor

cpuMonitorNew

Arguments

:: MonadIO m

=> GraphConfig

Configuration data for the Graph.

-> Double

Polling period (in seconds).

-> String

Name of the core to watch (e.g. "cpu", "cpu0").

-> m Widget

Creates a new CPU monitor. This is a PollingGraph fed by regular calls to getCPUInfo, associated to an IORef used to remember the values yielded by the last call to this function.

System.Taffybar.Widget.CommandRunner

commandRunnerNew

Arguments

:: MonadIO m

=> Double

Polling period (in seconds).

-> String

Command to execute. Should be in $PATH or an absolute path

-> [String]

Command argument. May be []

-> String

If command fails this will be displayed.

-> m Widget

Creates a new command runner widget. This is a PollingLabel fed by regular calls to command given by argument. The results of calling this function are displayed as string.

System.Taffybar.Widget.Decorators

module System.Taffybar.Widget.Decorators

System.Taffybar.Widget.DiskIOMonitor

dioMonitorNew

Arguments

:: MonadIO m

=> GraphConfig

Configuration data for the Graph.

-> Double

Polling period (in seconds).

-> String

Name of the disk or partition to watch (e.g. "sda", "sdb1").

-> m Widget

Creates a new disk IO monitor widget. This is a PollingGraph fed by regular calls to getDiskTransfer. The results of calling this function are normalized to the maximum value of the obtained probe (either read or write transfer).

System.Taffybar.Widget.FSMonitor

fsMonitorNew

Arguments

:: MonadIO m

=> Double

Polling interval (in seconds, e.g. 500)

-> [String]

Names of the partitions to monitor (e.g. ["/", "/home"])

-> m Widget

Creates a new filesystem monitor widget. It contains one PollingLabel that displays the data returned by the df command. The usage level of all requested partitions is extracted in one single operation.

System.Taffybar.Widget.FreedesktopNotifications

data Notification

A simple structure representing a Freedesktop notification

Constructors

Notification

Fields

• noteAppName :: Text
• noteReplaceId :: Word32
• noteSummary :: Text
• noteBody :: Text
• noteExpireTimeout :: Maybe Int32
• noteId :: Word32

Instances

Eq Notification

Methods

(==) :: Notification -> Notification -> Bool

(/=) :: Notification -> Notification -> Bool

Show Notification

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

data NotificationConfig

Constructors

NotificationConfig

Fields

• notificationMaxTimeout :: Maybe Int32

  Maximum time that a notification will be displayed (in seconds). Default: None

• notificationMaxLength :: Int

  Maximum length displayed, in characters. Default: 100

• notificationFormatter :: [Notification] -> String

  Function used to format notifications, takes the notifications from first to last

defaultNotificationConfig :: NotificationConfig

The default formatter is one of * Summary : Body * Summary * (N) Summary : Body * (N) Summary depending on the presence of a notification body, and where N is the number of queued notifications.

notifyAreaNew :: MonadIO m => NotificationConfig -> m Widget

Create a new notification area with the given configuration.

System.Taffybar.Widget.Layout

newtype LayoutConfig

Constructors

LayoutConfig

Fields

• formatLayout :: String -> TaffyIO String

defaultLayoutConfig :: LayoutConfig

layoutNew :: LayoutConfig -> TaffyIO Widget

Create a new Layout widget that will use the given Pager as its source of events.

System.Taffybar.Widget.MPRIS2

mpris2New :: TaffyIO Widget

System.Taffybar.Widget.NetworkGraph

module System.Taffybar.Widget.NetworkGraph

System.Taffybar.Widget.SNITray

sniTrayNew :: TaffyIO Widget

Build a new StatusNotifierItem tray that will share a host with any other trays that are constructed automatically

System.Taffybar.Widget.SimpleClock

textClockNew :: MonadIO m => Maybe TimeLocale -> String -> Double -> m Widget

Create the widget. I recommend passing Nothing for the TimeLocale parameter. The format string can include Pango markup (http:/developer.gnome.orgpangostablePangoMarkupFormat.html).

textClockNewWith :: MonadIO m => ClockConfig -> String -> Double -> m Widget

A configurable text-based clock widget. It currently allows for a configurable time zone through the ClockConfig.

See also textClockNew.

defaultClockConfig :: ClockConfig

A clock configuration that defaults to the current locale

data ClockConfig

Constructors

ClockConfig

Fields

• clockTimeZone :: Maybe TimeZone
• clockTimeLocale :: Maybe TimeLocale

Instances

Eq ClockConfig

Methods

(==) :: ClockConfig -> ClockConfig -> Bool

(/=) :: ClockConfig -> ClockConfig -> Bool

Ord ClockConfig

Methods

compare :: ClockConfig -> ClockConfig -> Ordering

(<) :: ClockConfig -> ClockConfig -> Bool

(<=) :: ClockConfig -> ClockConfig -> Bool

(>) :: ClockConfig -> ClockConfig -> Bool

(>=) :: ClockConfig -> ClockConfig -> Bool

max :: ClockConfig -> ClockConfig -> ClockConfig

min :: ClockConfig -> ClockConfig -> ClockConfig

Show ClockConfig

Methods

showsPrec :: Int -> ClockConfig -> ShowS

show :: ClockConfig -> String

showList :: [ClockConfig] -> ShowS

System.Taffybar.Widget.Text.CPUMonitor

module System.Taffybar.Widget.Text.CPUMonitor

System.Taffybar.Widget.Text.MemoryMonitor

module System.Taffybar.Widget.Text.MemoryMonitor

System.Taffybar.Widget.Text.NetworkMonitor

module System.Taffybar.Widget.Text.NetworkMonitor

System.Taffybar.Widget.Volume

volumeTextNew :: MonadIO m => String -> String -> Double -> m Widget

Creates a new text volume meter

volumeControlNew :: String -> String -> IO Widget

Creates a new volume meter widget

System.Taffybar.Widget.Weather

data WeatherConfig

The configuration for the weather widget. You can provide a custom format string through weatherTemplate as described above, or you can provide a custom function to turn a WeatherInfo into a String via the weatherFormatter field.

Constructors

WeatherConfig

Fields

• weatherStation :: String

  The weather station to poll. No default

• weatherTemplate :: String

  Template string, as described above. Default: $tempF$ °F

• weatherTemplateTooltip :: String

  Template string, as described above. Default: $tempF$ °F

• weatherFormatter :: WeatherFormatter

  Default: substitute in all interpolated variables (above)

• weatherProxy :: Maybe String

  The proxy server, e.g. "http://proxy:port". Default: Nothing

data WeatherInfo

Constructors

WI

Fields

• stationPlace :: String
• stationState :: String
• year :: String
• month :: String
• day :: String
• hour :: String
• wind :: String
• visibility :: String
• skyCondition :: String
• tempC :: Int
• tempF :: Int
• dewPoint :: String
• humidity :: Int
• pressure :: Int

Instances

Show WeatherInfo

Methods

showsPrec :: Int -> WeatherInfo -> ShowS

show :: WeatherInfo -> String

showList :: [WeatherInfo] -> ShowS

data WeatherFormatter

A wrapper to allow users to specify a custom weather formatter. The default interpolates variables into a string as described above. Custom formatters can do basically anything.

Constructors

WeatherFormatter (WeatherInfo -> String)

Specify a custom formatter for WeatherInfo

weatherNew

Arguments

:: WeatherConfig

Configuration to render

-> Double

Polling period in _minutes_

-> IO Widget

Create a periodically-updating weather widget that polls NOAA.

weatherCustomNew

Arguments

:: MonadIO m

=> IO (Either String WeatherInfo)

Weather querying action

-> String

Weather template

-> String

Weather template

-> WeatherFormatter

Weather formatter

-> Double

Polling period in _minutes_

-> m Widget

Create a periodically-updating weather widget using custom weather getter

defaultWeatherConfig :: String -> WeatherConfig

A sensible default configuration for the weather widget that just renders the temperature.

System.Taffybar.Widget.Windows

windowsNew :: WindowsConfig -> TaffyIO Widget

Create a new Windows widget that will use the given Pager as its source of events.

data WindowsConfig

Constructors

WindowsConfig

Fields

• getMenuLabel :: X11Window -> TaffyIO String

  A monadic function that will be used to make a label for the window in the window menu.

• getActiveLabel :: TaffyIO String

  Action to build the label text for the active window.

defaultWindowsConfig :: WindowsConfig

truncatedGetActiveLabel :: Int -> TaffyIO String

truncatedGetMenuLabel :: Int -> X11Window -> TaffyIO String

System.Taffybar.Widget.Workspaces

data IconInfo

Constructors

IIEWMH EWMHIconData

IIFilePath FilePath

IIColor ColorRGBA

IINone

Instances

Eq IconInfo

Methods

(==) :: IconInfo -> IconInfo -> Bool

(/=) :: IconInfo -> IconInfo -> Bool

Show IconInfo

Methods

showsPrec :: Int -> IconInfo -> ShowS

show :: IconInfo -> String

showList :: [IconInfo] -> ShowS

data Workspace

Constructors

Workspace

Fields

• workspaceIdx :: WorkspaceIdx
• workspaceName :: String
• workspaceState :: WorkspaceState
• windows :: [WindowData]

Instances

Eq Workspace

Methods

(==) :: Workspace -> Workspace -> Bool

(/=) :: Workspace -> Workspace -> Bool

Show Workspace

Methods

showsPrec :: Int -> Workspace -> ShowS

show :: Workspace -> String

showList :: [Workspace] -> ShowS

data WorkspacesConfig

Constructors

WorkspacesConfig

Fields

• widgetBuilder :: ControllerConstructor
• widgetGap :: Int
• windowIconSize :: Int
• underlineHeight :: Int
• minWSWidgetSize :: Maybe Int
• underlinePadding :: Int
• maxIcons :: Maybe Int
• minIcons :: Int
• getIconInfo :: WindowData -> WorkspacesIO IconInfo
• labelSetter :: Workspace -> WorkspacesIO String
• showWorkspaceFn :: Workspace -> Bool
• borderWidth :: Int
• updateEvents :: [String]
• updateRateLimitMicroseconds :: Integer
• iconSort :: [WindowData] -> WorkspacesIO [WindowData]
• urgentWorkspaceState :: Bool

type WorkspacesIO a = ReaderT WorkspacesContext IO a

hideEmpty :: Workspace -> Bool

workspacesNew :: WorkspacesConfig -> TaffyIO Widget

System.Taffybar.Widget.XDGMenu.MenuWidget

module System.Taffybar.Widget.XDGMenu.MenuWidget