| Copyright | (c) Eric Mertens, 2016 |
|---|---|
| License | ISC |
| Maintainer | emertens@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Client.Image.Message
Description
This module provides image renderers for messages.
- data MessageRendererParams = MessageRendererParams {
- rendStatusMsg :: [Char]
- rendUserSigils :: [Char]
- rendNicks :: [Identifier]
- data RenderMode
- defaultRenderParams :: MessageRendererParams
- msgImage :: ZonedTime -> MessageRendererParams -> MessageBody -> Image
- detailedMsgImage :: ZonedTime -> MessageRendererParams -> MessageBody -> Image
- metadataImg :: IrcMsg -> Maybe (Image, Maybe Identifier)
- ignoreImage :: Image
- quietIdentifier :: Identifier -> Image
- coloredUserInfo :: RenderMode -> UserInfo -> Image
- coloredIdentifier :: Identifier -> Image
Documentation
data MessageRendererParams Source #
Parameters used when rendering messages
Constructors
| MessageRendererParams | |
Fields
| |
data RenderMode Source #
Level of detail to use when rendering
Constructors
| NormalRender | only render nicknames |
| DetailedRender | render full user info |
defaultRenderParams :: MessageRendererParams Source #
Default MessageRenderParams with no sigils or nicknames specified
Arguments
| :: ZonedTime | time of message |
| -> MessageRendererParams | |
| -> MessageBody | |
| -> Image |
Construct a message given the time the message was received and its render parameters.
detailedMsgImage :: ZonedTime -> MessageRendererParams -> MessageBody -> Image Source #
Construct a message given the time the message was received and its render parameters using a detailed view.
metadataImg :: IrcMsg -> Maybe (Image, Maybe Identifier) Source #
Returns image and identifier to be used when collapsing metadata messages.
ignoreImage :: Image Source #
Image used when treating ignored chat messages as metadata
quietIdentifier :: Identifier -> Image Source #
Render an identifier without using colors. This is useful for metadata.
coloredUserInfo :: RenderMode -> UserInfo -> Image Source #
Render an a full user. In normal mode only the nickname will be rendered. If detailed mode the full user info including the username and hostname parts will be rendered. The nickname will be colored.
coloredIdentifier :: Identifier -> Image Source #
Render a nickname in its hash-based color.