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 :: !WindowLines

  Messages to display, newest first

• _winMarker :: !(Maybe Int)

  Location of line drawn to indicate newer messages

• _winUnread :: !Int

  Messages added since buffer was visible

• _winTotal :: !Int

  Messages in buffer

• _winMention :: !WindowLineImportance

  Indicates an important event is unread

• _winHideMeta :: !Bool

  Hide metadata messages

winMessages :: Lens' Window WindowLines

winUnread :: Lens' Window Int

winTotal :: Lens' Window Int

winMention :: Lens' Window WindowLineImportance

winMarker :: Lens' Window (Maybe Int)

winHideMeta :: Lens' Window Bool

Window lines

data WindowLine

A single message to be displayed in a window. The normal message line consists of the image prefix and the image. This allows line wrapping to be applied separately to the image and prefix so that wrapped messages can fall to the right side of the prefix.

Constructors

WindowLine

Fields

• _wlSummary :: !IrcSummary

  Summary value

• _wlPrefix :: !Image'

  Normal rendered image prefix

• _wlImage :: !Image'

  Normal rendered image

• _wlFullImage :: !Image'

  Detailed rendered image

• _wlImportance :: !WindowLineImportance

  Importance of message

• _wlTimestamp :: !PackedTime

wlSummary :: Lens' WindowLine IrcSummary

wlText :: Getter WindowLine Text

wlPrefix :: Lens' WindowLine Image'

wlImage :: Lens' WindowLine Image'

wlFullImage :: Lens' WindowLine Image'

wlImportance :: Lens' WindowLine WindowLineImportance

wlTimestamp :: Lens' WindowLine PackedTime

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

Defined in Client.State.Window

Methods

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

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

Ord WindowLineImportance

Defined in Client.State.Window

Methods

compare :: WindowLineImportance -> WindowLineImportance -> Ordering

(<) :: WindowLineImportance -> WindowLineImportance -> Bool

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

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

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

max :: WindowLineImportance -> WindowLineImportance -> WindowLineImportance

min :: WindowLineImportance -> WindowLineImportance -> WindowLineImportance

Read WindowLineImportance

Defined in Client.State.Window

Methods

readsPrec :: Int -> ReadS WindowLineImportance

readList :: ReadS [WindowLineImportance]

readPrec :: ReadPrec WindowLineImportance

readListPrec :: ReadPrec [WindowLineImportance]

Show WindowLineImportance

Defined in Client.State.Window

Methods

showsPrec :: Int -> WindowLineImportance -> ShowS

show :: WindowLineImportance -> String

showList :: [WindowLineImportance] -> ShowS

Window operations

emptyWindow :: Window

A window with no messages

addToWindow :: 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.

windowActivate :: Window -> Window

Update the window when it first becomes active. If only boring messages have been added since last time the marker will be hidden.

windowDeactivate :: Window -> Window

Update the window when it becomes inactive. This resets the activity marker to the bottom of the window.

Packed time

data PackedTime

packZonedTime :: ZonedTime -> PackedTime

unpackUTCTime :: PackedTime -> UTCTime

unpackTimeOfDay :: PackedTime -> TimeOfDay