-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | minimal ncurses-like library
--   
--   A basic ncurses-like library
@package hscharm
@version 0.0.2


-- | HsCharm wraps charm, a minimal ncurses-like terminal UI library
module HsCharm

-- | charmVersion is semver.
charmVersion :: String

-- | getWidth queries terminal width.
getWidth :: IO Int

-- | getHeight queries terminal height
getHeight :: IO Int

-- | cursorOff hides the cursor.
cursorOff :: IO ()

-- | cursorOn shows the cursor.
cursorOn :: IO ()

-- | echoOff disables key echoing.
echoOff :: IO ()

-- | echoOn enables key echoing.
echoOn :: IO ()

-- | rawOn enables raw manipulation.
rawOn :: IO ()

-- | rawOff disables raw manipulation.
rawOff :: IO ()

-- | getCursor queries the cursor position.
getCursor :: IO (Int, Int)

-- | moveCursor repositions the cursor.
moveCursor :: Int -> Int -> IO ()

-- | blotChar renders a chacter.
blotChar :: Char -> IO ()

-- | blotString renders a string message.
blotString :: String -> IO ()

-- | hCenterString displays a string centered horizontally on screen.
hCenterString :: String -> IO ()

-- | vCenterString displays a string centered vertically on screen.
vCenterString :: String -> IO ()

-- | clearScreen wipes the terminal display.
clearScreen :: IO ()

-- | handleSignal dispatches events.
handleSignal :: Int -> IO ()

-- | startCharm prepares the charm session.
startCharm :: IO ()

-- | endCharm tears down charm session resources.
endCharm :: IO ()

-- | getKey queries key presses.
getKey :: IO Key

-- | Key models keybard input.
data Key
KeyBackspace :: Key
KeyTab :: Key
KeyNewline :: Key
KeySpace :: Key
KeyExclamation :: Key
KeyDoubleQuote :: Key
KeyHash :: Key
KeyDollar :: Key
KeyPercent :: Key
KeyAmpersand :: Key
KeySingleQuote :: Key
KeyLeftParen :: Key
KeyRightParen :: Key
KeyAsterisk :: Key
KeyPlus :: Key
KeyComma :: Key
KeyMinus :: Key
KeyPeriod :: Key
KeySlash :: Key
KeyZero :: Key
KeyOne :: Key
KeyTwo :: Key
KeyThree :: Key
KeyFour :: Key
KeyFive :: Key
KeySix :: Key
KeySeven :: Key
KeyEight :: Key
KeyNine :: Key
KeyColon :: Key
KeySemicolon :: Key
KeyLessThan :: Key
KeyEquals :: Key
KeyGreaterThan :: Key
KeyQuestion :: Key
KeyAt :: Key
KeyCapitalA :: Key
KeyCapitalB :: Key
KeyCapitalC :: Key
KeyCapitalD :: Key
KeyCapitalE :: Key
KeyCapitalF :: Key
KeyCapitalG :: Key
KeyCapitalH :: Key
KeyCapitalI :: Key
KeyCapitalJ :: Key
KeyCapitalK :: Key
KeyCapitalL :: Key
KeyCapitalM :: Key
KeyCapitalN :: Key
KeyCapitalO :: Key
KeyCapitalP :: Key
KeyCapitalQ :: Key
KeyCapitalR :: Key
KeyCapitalS :: Key
KeyCapitalT :: Key
KeyCapitalU :: Key
KeyCapitalV :: Key
KeyCapitalW :: Key
KeyCapitalX :: Key
KeyCapitalY :: Key
KeyCapitalZ :: Key
KeyLeftBracket :: Key
KeyBackslash :: Key
KeyRightBracket :: Key
KeyCaret :: Key
KeyUnderscore :: Key
KeyBacktick :: Key
KeyA :: Key
KeyB :: Key
KeyC :: Key
KeyD :: Key
KeyE :: Key
KeyF :: Key
KeyG :: Key
KeyH :: Key
KeyI :: Key
KeyJ :: Key
KeyK :: Key
KeyL :: Key
KeyM :: Key
KeyN :: Key
KeyO :: Key
KeyP :: Key
KeyQ :: Key
KeyR :: Key
KeyS :: Key
KeyT :: Key
KeyU :: Key
KeyV :: Key
KeyW :: Key
KeyX :: Key
KeyY :: Key
KeyZ :: Key
KeyLeftBrace :: Key
KeyPipe :: Key
KeyRightBrace :: Key
KeyTilde :: Key
KeyUp :: Key
KeyDown :: Key
KeyRight :: Key
KeyLeft :: Key
KeyEscape :: Key
KeyUnknown :: Key
instance GHC.Show.Show HsCharm.Key
instance GHC.Enum.Enum HsCharm.Key
instance GHC.Classes.Ord HsCharm.Key
instance GHC.Classes.Eq HsCharm.Key