glirc-2.41: Console IRC client

Copyright	(c) TheDaemoness 2024
License	ISC
Maintainer	[email protected]
Safe Haskell	Safe-Inferred
Language	Haskell2010

Client.State.Help

Description

The help buffer is basically a glorified list of Image's with some additional bookkeeping data.

Synopsis

data HelpState
data HelpQuery
- = HelpList
- | HelpCmd Text
- | HelpNet Text Text
- | HelpNetPartial Text Text (Maybe Text)
hsQuery :: Lens' HelpState HelpQuery
hsImages :: Lens' HelpState [Image']
helpQueryToText :: HelpQuery -> Maybe Text
makeHelp :: Maybe Text -> [Image'] -> HelpState
awaitHelp :: Text -> Text -> HelpState
awaitingHelp :: HelpState -> Maybe Text
applyHelpReply :: Palette -> IrcMsg -> HelpState -> HelpState

Documentation

data HelpState Source #

Cached help query and rendered help text.

data HelpQuery Source #

Constructors

HelpList
HelpCmd Text
HelpNet Text Text
HelpNetPartial Text Text (Maybe Text)

hsQuery :: Lens' HelpState HelpQuery Source #

hsImages :: Lens' HelpState [Image'] Source #

helpQueryToText :: HelpQuery -> Maybe Text Source #

makeHelp :: Maybe Text -> [Image'] -> HelpState Source #

awaitHelp :: Text -> Text -> HelpState Source #

awaitingHelp :: HelpState -> Maybe Text Source #

applyHelpReply :: Palette -> IrcMsg -> HelpState -> HelpState Source #