Matterhorn.Draw.Messages

Documentation

data MessageData

A bundled structure that includes all the information necessary to render a given message

Constructors

MessageData

Fields

• mdEditThreshold :: Maybe ServerTime

  If specified, any messages edited before this point in time are not indicated as edited.

• mdShowOlderEdits :: Bool

  Indicates whether "edited" markers should be shown for old messages (i.e., ignore the mdEditThreshold value).

• mdShowReactions :: Bool

  Whether to render reactions.

• mdMessage :: Message

  The message to render.

• mdUserName :: Maybe Text

  The username of the message's author, if any. This is passed here rather than obtaining from the message because we need to do lookups in the ChatState to compute this, and we don't pass the ChatState into renderMessage.

• mdParentMessage :: Maybe Message

  The parent message of this message, if any.

• mdParentUserName :: Maybe Text

  The author of the parent message, if any.

• mdThreadState :: ThreadState

  The thread state of this message.

• mdRenderReplyParent :: Bool

  Whether to render the parent message.

• mdRenderReplyIndent :: Bool

  Whether to render reply indent decorations

• mdHighlightSet :: HighlightSet

  The highlight set to use to highlight usernames, channel names, etc.

• mdIndentBlocks :: Bool

  Whether to indent the message underneath the author's name (True) or just display it to the right of the author's name (False).

• mdTruncateVerbatimBlocks :: Maybe Int

  At what height to truncate long verbatim/code blocks.

• mdMessageWidthLimit :: Maybe Int

  A width override to use to wrap non-code blocks and code blocks without syntax highlighting. If unspecified, all blocks in the message will be wrapped and truncated at the width specified by the rendering context. If specified, all non-code blocks will be wrapped at this width and highlighted code blocks will be rendered using the context's width.

• mdMyUsername :: Text

  The username of the user running Matterhorn.

• mdMyUserId :: UserId

  The user ID of the user running Matterhorn.

• mdWrapNonhighlightedCodeBlocks :: Bool

  Whether to wrap text in non-highlighted code blocks.

• mdClickableNameTag :: Name

  Used to namespace clickable extents produced by rendering this message

renderMessage :: MessageData -> Widget Name

This performs rendering of the specified message according to settings in MessageData.

printableNameForUserRef :: ChatState -> UserRef -> Maybe Text

printableNameForUserRef converts the UserRef into a printable name, based on the current known user data.

renderSingleMessage

Arguments

:: ChatState

The application state

-> HighlightSet

The highlight set to use when rendering this message

-> Bool

Whether to render reply indentations

-> Maybe ServerTime

This specifies an "indicator boundary". Showing various indicators (e.g. "edited") is not typically done for messages that are older than this boundary value.

-> Message

The message to render

-> ThreadState

The thread state in which to render the message

-> Name

Clickable name tag

-> Widget Name

renderSingleMessage is the main message drawing function.

unsafeRenderMessageSelection

Arguments

:: (SeqDirection dir1, SeqDirection dir2)

=> ((Message, ThreadState), (DirectionalSeq dir1 (Message, ThreadState), DirectionalSeq dir2 (Message, ThreadState)))

The message to render, the messages before it, and after it, respectively

-> (Message -> ThreadState -> Name -> Widget Name)

A per-message rendering function to use

-> Name

Clickable name tag

-> Widget Name

Render a selected message with focus, including the messages before and the messages after it. The foldable parameters exist because (depending on the situation) we might use either of the message list types for the before and after (i.e. the chronological or retrograde message sequences).

renderLastMessages :: ChatState -> HighlightSet -> Maybe ServerTime -> Bool -> Name -> DirectionalSeq Retrograde (Message, ThreadState) -> Widget Name

addEllipsis :: Widget a -> Widget a

mkClickableInline :: Maybe MessageId -> Name -> Int -> Inline -> Maybe Name