Copyright	(c) Eric Mertens 2016
License	ISC
Maintainer	[email protected]
Safe Haskell	Safe-Inferred
Language	Haskell2010

Client.State.Focus

Contents

Types
Focus operations
Focus Prisms

Description

The client has a primary message window whose contents are determined by a Focus. In order to provide different views of channels the Subfocus breaks down channel focus into different subviews.

Synopsis

data Focus
- = Unfocused
- | NetworkFocus !Text
- | ChannelFocus !Text !Identifier
data Subfocus
- = FocusMessages
- | FocusInfo !Text !Identifier
- | FocusUsers !Text !Identifier
- | FocusMasks !Text !Identifier !Char
- | FocusWindows WindowsFilter
- | FocusPalette
- | FocusMentions
- | FocusDigraphs
- | FocusKeyMap
- | FocusHelp
- | FocusRtsStats
- | FocusIgnoreList
- | FocusCert
- | FocusChanList !Text (Maybe Int) (Maybe Int)
- | FocusWho !Text
data WindowsFilter
- = AllWindows
- | NetworkWindows
- | ChannelWindows
- | UserWindows
parseFocus :: Maybe Text -> String -> Maybe Focus
focusNetwork :: Focus -> Maybe Text
actualFocus :: Subfocus -> Focus -> Focus
isPrefixOfFocus :: String -> Focus -> Bool
_ChannelFocus :: Prism' Focus (Text, Identifier)
_NetworkFocus :: Prism' Focus Text
_Unfocused :: Prism' Focus ()

Types

data Focus Source #

Currently focused window

Constructors

Unfocused	No network
NetworkFocus !Text	Network
ChannelFocus !Text !Identifier	Network Channel/Nick

Instances

Instances details

Show Focus Source #
Instance details Defined in Client.State.Focus Methods showsPrec :: Int -> Focus -> ShowS # show :: Focus -> String # showList :: [Focus] -> ShowS #
Eq Focus Source #
Instance details Defined in Client.State.Focus Methods (==) :: Focus -> Focus -> Bool # (/=) :: Focus -> Focus -> Bool #
Ord Focus Source #	Unfocused first, followed by focuses sorted by network. Within the same network the network focus comes first and then the channels are ordered by channel identifier
Instance details Defined in Client.State.Focus Methods compare :: Focus -> Focus -> Ordering # (<) :: Focus -> Focus -> Bool # (<=) :: Focus -> Focus -> Bool # (>) :: Focus -> Focus -> Bool # (>=) :: Focus -> Focus -> Bool # max :: Focus -> Focus -> Focus # min :: Focus -> Focus -> Focus #

data Subfocus Source #

Subfocus view

Constructors

FocusMessages	Show messages
FocusInfo !Text !Identifier	Show channel metadata
FocusUsers !Text !Identifier	Show channel user list
FocusMasks !Text !Identifier !Char	Show channel mask list for given mode
FocusWindows WindowsFilter	Show client windows
FocusPalette	Show current palette
FocusMentions	Show all mentions
FocusDigraphs	Show all digraphs
FocusKeyMap	Show key bindings
FocusHelp	Show help window
FocusRtsStats	Show GHC RTS statistics
FocusIgnoreList	Show ignored masks
FocusCert	Show rendered certificate
FocusChanList !Text (Maybe Int) (Maybe Int)	Show channel list
FocusWho !Text	Show last reply to a WHO query

Instances

Instances details

Show Subfocus Source #
Instance details Defined in Client.State.Focus Methods showsPrec :: Int -> Subfocus -> ShowS # show :: Subfocus -> String # showList :: [Subfocus] -> ShowS #
Eq Subfocus Source #
Instance details Defined in Client.State.Focus Methods (==) :: Subfocus -> Subfocus -> Bool # (/=) :: Subfocus -> Subfocus -> Bool #

data WindowsFilter Source #

Filter argument for FocusWindows

Constructors

AllWindows	no filter
NetworkWindows	only network windows
ChannelWindows	only channel windows
UserWindows	only user windows

Instances

Instances details

Show WindowsFilter Source #
Instance details Defined in Client.State.Focus Methods showsPrec :: Int -> WindowsFilter -> ShowS # show :: WindowsFilter -> String # showList :: [WindowsFilter] -> ShowS #
Eq WindowsFilter Source #
Instance details Defined in Client.State.Focus Methods (==) :: WindowsFilter -> WindowsFilter -> Bool # (/=) :: WindowsFilter -> WindowsFilter -> Bool #

Focus operations

parseFocus Source #

Arguments

:: Maybe Text	default network
-> String	[network:]target
-> Maybe Focus

Parses a single focus name given a default network.

focusNetwork Source #

Arguments

:: Focus
-> Maybe Text	network

Return the network associated with the current focus

actualFocus :: Subfocus -> Focus -> Focus Source #

Returns what focus a subfocus is actually for.

isPrefixOfFocus :: String -> Focus -> Bool Source #

Focus Prisms

_ChannelFocus :: Prism' Focus (Text, Identifier) Source #

_NetworkFocus :: Prism' Focus Text Source #

_Unfocused :: Prism' Focus () Source #