Client.State.Window

This module defines types and operations used to store messages for display in the client's buffers.

Windows

data Window

A Window tracks all of the messages and metadata for a particular message buffer.

Constructors

Window

Fields

• _winMessages :: ![WindowLine]

  Messages to display, newest first

• _winUnread :: !Int

  Messages added since buffer was visible

• _winTotal :: !Int

  Messages in buffer

• _winMention :: !Bool

  Indicates an important event is unread

winMessages :: Lens' Window [WindowLine]

winUnread :: Lens' Window Int

winTotal :: Lens' Window Int

winMention :: Lens' Window Bool

Window lines

data WindowLine

A single message to be displayed in a window

Constructors

WindowLine

Fields

• _wlBody :: !MessageBody

  Original Haskell value

• _wlText :: !Text

  Searchable text form

• _wlImage :: !Image

  Normal rendered image

• _wlFullImage :: !Image

  Detailed rendered image

wlBody :: Lens' WindowLine MessageBody

wlText :: Lens' WindowLine Text

wlImage :: Lens' WindowLine Image

wlFullImage :: Lens' WindowLine Image

Window line importance

data WindowLineImportance

Flag for the important of a message being added to a window

Constructors

WLBoring

Don't update unread count

WLNormal

Increment unread count

WLImportant

Increment unread count and set important flag

Instances

Eq WindowLineImportance

Methods

(==) :: WindowLineImportance -> WindowLineImportance -> Bool

(/=) :: WindowLineImportance -> WindowLineImportance -> Bool

Show WindowLineImportance

Methods

showsPrec :: Int -> WindowLineImportance -> ShowS

show :: WindowLineImportance -> String

showList :: [WindowLineImportance] -> ShowS

Window operations

emptyWindow :: Window

A window with no messages

addToWindow :: WindowLineImportance -> WindowLine -> Window -> Window

Adds a given line to a window as the newest message. Window's unread count will be updated according to the given importance.

windowSeen :: Window -> Window

Update the window clearing the unread count and important flag.