Safe Haskell	None
Language	Haskell2010

Brick.Types

Description

Basic types used by this library.

Synopsis

Documentation

data Location Source

A terminal screen location.

Constructors

Location
Fields loc :: (Int, Int) (Column, Row)

Instances

Show Location
Monoid Location
TerminalLocation Location
Field1 Location Location Int Int
Field2 Location Location Int Int

locL :: Iso' Location (Int, Int) Source

class TerminalLocation a where Source

The class of types that behave like terminal locations.

Methods

columnL :: Lens' a Int Source

Get the column out of the value

column :: a -> Int Source

rowL :: Lens' a Int Source

Get the row out of the value

row :: a -> Int Source

Instances

TerminalLocation Location
TerminalLocation CursorLocation

data CursorLocation Source

A cursor location. These are returned by the rendering process.

Constructors

CursorLocation
Fields cursorLocation :: !Location The location cursorLocationName :: !(Maybe Name) The name of the widget associated with the location

Instances

Show CursorLocation
TerminalLocation CursorLocation

cursorLocationL :: Lens' CursorLocation Location Source

cursorLocationNameL :: Lens' CursorLocation (Maybe Name) Source

class HandleEvent a where Source

The class of types that provide some basic event-handling.

Methods

handleEvent :: Event -> a -> a Source

Handle a Vty event

Instances

HandleEvent Editor
HandleEvent (Dialog a)
HandleEvent (List e)

newtype Name Source

Names of things. Used to name cursor locations, widgets, and viewports.

Constructors

Name String

Instances

Eq Name
Ord Name
Show Name
IsString Name

suffixLenses :: Name -> DecsQ Source

A template haskell function to build lenses for a record type. This function differs from the makeLenses function in that it does not require the record fields to be prefixed with underscores and it adds an L suffix to lens names to make it clear that they are lenses.