Eve.CLI

Events

initCLI :: HasEvents s => AppT s IO ()

Place initCLI first in your eve initialization block. It registers listeners for terminal events and sets up the renderer

main :: IO ()
eve_ $ do
  initCLI
  -- add listeners here

onEvent :: (Typeable m, MonadIO m, HasEvents s) => (Event -> AppT s m result) -> AppT s m ListenerId

React to terminal events Event

onKeypress :: (Typeable m, MonadIO m, HasEvents s) => (Keypress -> AppT s m result) -> AppT s m ListenerId

React to a Keypress

onMouseDown :: (Typeable m, MonadIO m, HasEvents s) => (MouseDown -> AppT s m result) -> AppT s m ListenerId

React to a Mouse Down

onMouseUp :: (Typeable m, MonadIO m, HasEvents s) => (MouseUp -> AppT s m result) -> AppT s m ListenerId

React to a Mouse Up

onResize :: (Typeable m, MonadIO m, HasEvents s) => (Resize -> AppT s m result) -> AppT s m ListenerId

React to a Terminal Resize

onPaste :: (Typeable m, MonadIO m, HasEvents s) => (Paste -> AppT s m result) -> AppT s m ListenerId

React to a Paste

onEvent_ :: (Typeable m, MonadIO m, HasEvents s) => (Event -> AppT s m result) -> AppT s m ()

React to a Event

onKeypress_ :: (Typeable m, MonadIO m, HasEvents s) => (Keypress -> AppT s m result) -> AppT s m ()

React to a Keypress

onMouseDown_ :: (Typeable m, MonadIO m, HasEvents s) => (MouseDown -> AppT s m result) -> AppT s m ()

React to a Mouse Down

onMouseUp_ :: (Typeable m, MonadIO m, HasEvents s) => (MouseUp -> AppT s m result) -> AppT s m ()

React to a Mouse Up

onResize_ :: (Typeable m, MonadIO m, HasEvents s) => (Resize -> AppT s m result) -> AppT s m ()

React to a Terminal Resize

onPaste_ :: (Typeable m, MonadIO m, HasEvents s) => (Paste -> AppT s m result) -> AppT s m ()

React to a Paste

data Keypress

Type for terminal keypress events

Constructors

Keypress Key [Modifier]

Instances

Eq Keypress

Methods

(==) :: Keypress -> Keypress -> Bool

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

Show Keypress

Methods

showsPrec :: Int -> Keypress -> ShowS

show :: Keypress -> String

showList :: [Keypress] -> ShowS

data MouseDown

Type for terminal mouse down events

Constructors

MouseDown Int Int Button [Modifier]

Instances

Eq MouseDown

Methods

(==) :: MouseDown -> MouseDown -> Bool

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

Show MouseDown

Methods

showsPrec :: Int -> MouseDown -> ShowS

show :: MouseDown -> String

showList :: [MouseDown] -> ShowS

data MouseUp

Type for terminal mouse up events

Constructors

MouseUp Int Int (Maybe Button)

Instances

Eq MouseUp

Methods

(==) :: MouseUp -> MouseUp -> Bool

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

Show MouseUp

Methods

showsPrec :: Int -> MouseUp -> ShowS

show :: MouseUp -> String

showList :: [MouseUp] -> ShowS

data Resize

Type for terminal resize events

Constructors

Resize Int Int

Instances

Eq Resize

Methods

(==) :: Resize -> Resize -> Bool

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

Show Resize

Methods

showsPrec :: Int -> Resize -> ShowS

show :: Resize -> String

showList :: [Resize] -> ShowS

data Paste

Type for terminal paste events

Constructors

Paste ByteString

Instances

Eq Paste

Methods

(==) :: Paste -> Paste -> Bool

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

Show Paste

Methods

showsPrec :: Int -> Paste -> ShowS

show :: Paste -> String

showList :: [Paste] -> ShowS

data LostFocus

Type for terminal blur events

Constructors

LostFocus

Instances

Eq LostFocus

Methods

(==) :: LostFocus -> LostFocus -> Bool

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

Show LostFocus

Methods

showsPrec :: Int -> LostFocus -> ShowS

show :: LostFocus -> String

showList :: [LostFocus] -> ShowS

data GainedFocus

Type for terminal focus events

Constructors

GainedFocus

Instances

Eq GainedFocus

Methods

(==) :: GainedFocus -> GainedFocus -> Bool

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

Show GainedFocus

Methods

showsPrec :: Int -> GainedFocus -> ShowS

show :: GainedFocus -> String

showList :: [GainedFocus] -> ShowS

Rendering

renderImage :: (MonadIO m, HasStates s) => Image -> AppT s m ()

Render the provided image to screen

getSize :: (MonadIO m, HasStates s) => AppT s m (Width, Height)

Get the current terminal size. Also see onResize

type Width = Int

Terminal width in columns

type Height = Int

Terminal height in rows