| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Text.Colour.Chunk
Synopsis
- data Chunk = Chunk {
- chunkText :: !Text
- chunkItalic :: !(Maybe Bool)
- chunkConsoleIntensity :: !(Maybe ConsoleIntensity)
- chunkUnderlining :: !(Maybe Underlining)
- chunkBlinking :: !(Maybe Blinking)
- chunkForeground :: !(Maybe Colour)
- chunkBackground :: !(Maybe Colour)
- chunkWidth :: Chunk -> Int
- plainChunk :: TerminalCapabilities -> Chunk -> Bool
- plainColour :: TerminalCapabilities -> Colour -> Bool
- renderChunksUtf8BS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString
- renderChunksUtf8BSBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder
- renderChunksText :: Foldable f => TerminalCapabilities -> f Chunk -> Text
- renderChunksLazyText :: Foldable f => TerminalCapabilities -> f Chunk -> Text
- renderChunksBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder
- renderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString
- renderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder
- renderChunkText :: TerminalCapabilities -> Chunk -> Text
- renderChunkLazyText :: TerminalCapabilities -> Chunk -> Text
- renderChunkBuilder :: TerminalCapabilities -> Chunk -> Builder
- chunkSGR :: TerminalCapabilities -> Chunk -> [SGR]
- chunk :: Text -> Chunk
- fore :: Colour -> Chunk -> Chunk
- back :: Colour -> Chunk -> Chunk
- bold :: Chunk -> Chunk
- faint :: Chunk -> Chunk
- italic :: Chunk -> Chunk
- underline :: Chunk -> Chunk
- doubleUnderline :: Chunk -> Chunk
- noUnderline :: Chunk -> Chunk
- slowBlinking :: Chunk -> Chunk
- rapidBlinking :: Chunk -> Chunk
- noBlinking :: Chunk -> Chunk
- data Colour
- colourSGR :: TerminalCapabilities -> ConsoleLayer -> Colour -> Maybe SGR
- black :: Colour
- red :: Colour
- green :: Colour
- yellow :: Colour
- blue :: Colour
- magenta :: Colour
- cyan :: Colour
- white :: Colour
- brightBlack :: Colour
- brightRed :: Colour
- brightGreen :: Colour
- brightYellow :: Colour
- brightBlue :: Colour
- brightMagenta :: Colour
- brightCyan :: Colour
- brightWhite :: Colour
- colour256 :: Word8 -> Colour
- color256 :: Word8 -> Colour
- colourRGB :: Word8 -> Word8 -> Word8 -> Colour
- colorRGB :: Word8 -> Word8 -> Word8 -> Colour
Documentation
Constructors
| Chunk | |
Fields
| |
Instances
chunkWidth :: Chunk -> Int Source #
plainChunk :: TerminalCapabilities -> Chunk -> Bool Source #
plainColour :: TerminalCapabilities -> Colour -> Bool Source #
renderChunksUtf8BS :: Foldable f => TerminalCapabilities -> f Chunk -> ByteString Source #
Render chunks directly to a UTF8-encoded Bytestring.
renderChunksUtf8BSBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder Source #
Render chunks to a UTF8-encoded ByteString Builder.
renderChunksText :: Foldable f => TerminalCapabilities -> f Chunk -> Text Source #
Render chunks directly to strict Text.
renderChunksLazyText :: Foldable f => TerminalCapabilities -> f Chunk -> Text Source #
Render chunks directly to lazy Text.
renderChunksBuilder :: Foldable f => TerminalCapabilities -> f Chunk -> Builder Source #
renderChunkUtf8BS :: TerminalCapabilities -> Chunk -> ByteString Source #
Render a chunk directly to a UTF8-encoded Bytestring.
renderChunkUtf8BSBuilder :: TerminalCapabilities -> Chunk -> Builder Source #
Render a chunk directly to a UTF8-encoded Bytestring Builder.
renderChunkText :: TerminalCapabilities -> Chunk -> Text Source #
Render a chunk directly to strict Text.
renderChunkLazyText :: TerminalCapabilities -> Chunk -> Text Source #
Render a chunk directly to strict Text.
doubleUnderline :: Chunk -> Chunk Source #
noUnderline :: Chunk -> Chunk Source #
slowBlinking :: Chunk -> Chunk Source #
rapidBlinking :: Chunk -> Chunk Source #
noBlinking :: Chunk -> Chunk Source #
Constructors
| Colour8 !ColourIntensity !TerminalColour | |
| Colour8Bit !Word8 | |
| Colour24Bit !Word8 !Word8 !Word8 |
Instances
| Generic Colour Source # | |||||
Defined in Text.Colour.Chunk Associated Types
| |||||
| Show Colour Source # | |||||
| Eq Colour Source # | |||||
| Validity Colour Source # | |||||
Defined in Text.Colour.Chunk Methods validate :: Colour -> Validation # | |||||
| type Rep Colour Source # | |||||
Defined in Text.Colour.Chunk type Rep Colour = D1 ('MetaData "Colour" "Text.Colour.Chunk" "safe-coloured-text-0.3.0.2-DDjoaGj2H9nCTABs3rdvi3" 'False) (C1 ('MetaCons "Colour8" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ColourIntensity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TerminalColour)) :+: (C1 ('MetaCons "Colour8Bit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :+: C1 ('MetaCons "Colour24Bit" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8))))) | |||||
colourSGR :: TerminalCapabilities -> ConsoleLayer -> Colour -> Maybe SGR Source #
brightBlack :: Colour Source #
brightGreen :: Colour Source #
brightBlue :: Colour Source #
brightCyan :: Colour Source #
brightWhite :: Colour Source #
colour256 :: Word8 -> Colour Source #
Bulid an 8-bit RGB Colour
This will not be rendered unless With8BitColours is used.