Source code Contents Index

Hledger.Cli.Commands.Vty

Description

A simple text UI for hledger, based on the vty library.

Synopsis

data AppState = AppState { av :: Vty aw :: Int ah :: Int amsg :: String aopts :: [Opt] aargs :: [String] ajournal :: Journal abuf :: [String] alocs :: [Loc] } data Loc = Loc { scr :: Screen sy :: Int cy :: Int largs :: [String] } data Screen = BalanceScreen | RegisterScreen | PrintScreen vty :: [Opt] -> [String] -> Journal -> IO () go :: AppState -> IO () pageHeight :: AppState -> Int setLocScrollY :: Int -> Loc -> Loc setLocCursorY :: Int -> Loc -> Loc scrollY :: AppState -> Int posY :: AppState -> Int cursorY :: AppState -> Int setScrollY :: Int -> AppState -> AppState setPosY :: Int -> AppState -> AppState setCursorY :: Int -> AppState -> AppState updateScrollY :: (Int -> Int) -> AppState -> AppState updatePosY :: (Int -> Int) -> AppState -> AppState updateCursorY :: (Int -> Int) -> AppState -> AppState resize :: Int -> Int -> AppState -> AppState moveToTop :: AppState -> AppState moveToBottom :: AppState -> AppState moveUpAndPushEdge :: AppState -> AppState moveDownAndPushEdge :: AppState -> AppState nextpage :: AppState -> AppState prevpage :: AppState -> AppState pushLoc :: Loc -> AppState -> AppState popLoc :: AppState -> AppState clearLocs :: AppState -> AppState exit :: AppState -> AppState loc :: AppState -> Loc currentArgs :: AppState -> [String] screen :: AppState -> Screen enter :: LocalTime -> Screen -> [String] -> AppState -> AppState resetTrailAndEnter :: LocalTime -> Screen -> AppState -> AppState updateData :: LocalTime -> AppState -> AppState backout :: LocalTime -> AppState -> AppState drilldown :: LocalTime -> AppState -> AppState currentAccountName :: AppState -> AccountName accountNameAt :: [String] -> Int -> AccountName scrollToTransaction :: Maybe Transaction -> AppState -> AppState currentTransaction :: AppState -> Maybe Transaction renderScreen :: AppState -> Picture padClipString :: Int -> Int -> String -> [String] renderString :: Attr -> String -> Image renderStatus :: Int -> String -> Image data UITheme = Restrained | Colorful | Blood

Documentation

data AppState Source

The application state when running the vty command. Constructors AppState av :: Vty the vty context aw :: Int window width ah :: Int window height amsg :: String status message aopts :: [Opt] command-line opts aargs :: [String] command-line args at startup ajournal :: Journal parsed journal abuf :: [String] lines of the current buffered view alocs :: [Loc] user's navigation trail within the UI ^ never null, head is current location Instances Show AppState

data Loc Source

A location within the user interface. Constructors Loc scr :: Screen one of the available screens sy :: Int viewport y scroll position cy :: Int cursor y position largs :: [String] command-line args, possibly narrowed for this location Instances Show Loc

data Screen Source

The screens available within the user interface. Constructors BalanceScreen like hledger balance, shows accounts RegisterScreen like hledger register, shows transaction-postings PrintScreen like hledger print, shows journal transactions | LedgerScreen -- ^ shows the raw journal Instances Eq Screen Show Screen

vty :: [Opt] -> [String] -> Journal -> IO () Source

Run the vty (curses-style) ui.

go :: AppState -> IO () Source

Update the screen, wait for the next event, repeat.

pageHeight :: AppState -> Int Source

The number of lines currently available for the main data display area.

setLocScrollY :: Int -> Loc -> Loc Source

setLocCursorY :: Int -> Loc -> Loc Source

scrollY :: AppState -> Int Source

posY :: AppState -> Int Source

cursorY :: AppState -> Int Source

setScrollY :: Int -> AppState -> AppState Source

setPosY :: Int -> AppState -> AppState Source

setCursorY :: Int -> AppState -> AppState Source

updateScrollY :: (Int -> Int) -> AppState -> AppState Source

updatePosY :: (Int -> Int) -> AppState -> AppState Source

updateCursorY :: (Int -> Int) -> AppState -> AppState Source

resize :: Int -> Int -> AppState -> AppState Source

moveToTop :: AppState -> AppState Source

moveToBottom :: AppState -> AppState Source

moveUpAndPushEdge :: AppState -> AppState Source

moveDownAndPushEdge :: AppState -> AppState Source

nextpage :: AppState -> AppState Source

Scroll down by page height or until we can just see the last line, without moving the cursor, or if we are already scrolled as far as possible then move the cursor to the last line.

prevpage :: AppState -> AppState Source

Scroll up by page height or until we can just see the first line, without moving the cursor, or if we are scrolled as far as possible then move the cursor to the first line.

pushLoc :: Loc -> AppState -> AppState Source

Push a new UI location on to the stack.

popLoc :: AppState -> AppState Source

clearLocs :: AppState -> AppState Source

exit :: AppState -> AppState Source

loc :: AppState -> Loc Source

currentArgs :: AppState -> [String] Source

Get the filter pattern args in effect for the current ui location.

screen :: AppState -> Screen Source

enter :: LocalTime -> Screen -> [String] -> AppState -> AppState Source

Enter a new screen, with possibly new args, adding the new ui location to the stack.

resetTrailAndEnter :: LocalTime -> Screen -> AppState -> AppState Source

updateData :: LocalTime -> AppState -> AppState Source

Regenerate the display data appropriate for the current screen.

backout :: LocalTime -> AppState -> AppState Source

drilldown :: LocalTime -> AppState -> AppState Source

currentAccountName :: AppState -> AccountName Source

Get the account name currently highlighted by the cursor on the balance screen. Results undefined while on other screens.

accountNameAt :: [String] -> Int -> AccountName Source

Get the full name of the account being displayed at a specific line within the balance command's output.

scrollToTransaction :: Maybe Transaction -> AppState -> AppState Source

If on the print screen, move the cursor to highlight the specified entry (or a reasonable guess). Doesn't work.

currentTransaction :: AppState -> Maybe Transaction Source

Get the transaction containing the posting currently highlighted by the cursor on the register screen (or best guess). Results undefined while on other screens.

renderScreen :: AppState -> Picture Source

padClipString :: Int -> Int -> String -> [String] Source

renderString :: Attr -> String -> Image Source

renderStatus :: Int -> String -> Image Source

data UITheme Source

Constructors Restrained Colorful Blood

Produced by Haddock version 2.6.1