Hi3Status.Block

Blocks are the main components of a status line. A block is any instance of the Block class.

Class

class Block a where

Methods

runBlock :: a -> BlockM ()

This function takes in a block, and returns a value of type BlockM (), which is executed in its own thread when the status line begins.

Instances

Block StaticTextBlock

Block BacklightBlock

Block BatteryBlock

Block ClockBlock

Block VolumeBlock

Block WifiBlock

Block EthernetBlock

Block NetworkBlock

Block WindowBlock

Block WeatherBlock

Block MusicBlock

Block CommandBlock

Monad

data BlockM a

BlockM is a monad responsible for controlling the operation of a block. Each block has two lines of communication with the main status line:

• The status line can tell the block that it needs updating.
• The block can push updates in the form of BlockDescriptions to the status line, which will then be processed and submitted to i3bar.

Instances

Monad BlockM

Functor BlockM

Applicative BlockM

MonadIO BlockM

pushBlockDescription :: BlockDescription -> BlockM ()

Push a new block description to the status line.

waitForUpdateSignal :: BlockM ()

Wait until an update is required.

getUpdater :: BlockM (IO ())

Return the updater for this block, i.e. a value of the type IO () that when run will request that the block be updated. This is useful when, for example, we desire to set an update timer internal to the block itself:

updateInFiveSeconds :: BlockM ()
updateInFiveSeconds = do
    updater <- getUpdater
    liftIO $ forkIO $ do
        threadDelay 5000000
        updater

Descriptions

data BlockDescription

A BlockDescription contains everything needed by i3bar to properly render a block. This includes things like the text of a block, and the color of the text. For more information about each field, see the i3bar protocol at http://i3wm.org/docs/i3bar-protocol.html.

Constructors

BlockDescription

Fields

full_text :: Text

short_text :: Maybe Text

color :: Maybe Text

min_width :: Maybe Int

align :: Maybe BlockAlign

name :: Maybe Text

instanc :: Maybe Text

urgent :: Maybe Bool

separator :: Maybe Bool

separator_block_width :: Maybe Int

markup :: Maybe Text

Instances

IsString BlockDescription

ToJSON BlockDescription

emptyBlockDescription :: BlockDescription

An empty block description, i.e. one with full_text = "", and everything else equal to Nothing.