terminfo-0.3.1.1: Haskell bindings to the terminfo library. Source code Contents Index

System.Console.Terminfo.Effects Portability portable (FFI) Stability experimental Maintainer judah.jacobson@gmail.com

Contents Bell alerts Text attributes Mode wrappers Low-level capabilities

Description

Synopsis

bell :: TermStr s => Capability s visualBell :: Capability TermOutput data Attributes = Attributes { standoutAttr :: Bool underlineAttr :: Bool reverseAttr :: Bool blinkAttr :: Bool dimAttr :: Bool boldAttr :: Bool invisibleAttr :: Bool protectedAttr :: Bool } defaultAttributes :: Attributes withAttributes :: TermStr s => Capability (Attributes -> s -> s) setAttributes :: TermStr s => Capability (Attributes -> s) allAttributesOff :: TermStr s => Capability s withStandout :: TermStr s => Capability (s -> s) withUnderline :: TermStr s => Capability (s -> s) withBold :: TermStr s => Capability (s -> s) enterStandoutMode :: TermStr s => Capability s exitStandoutMode :: TermStr s => Capability s enterUnderlineMode :: TermStr s => Capability s exitUnderlineMode :: TermStr s => Capability s reverseOn :: TermStr s => Capability s blinkOn :: TermStr s => Capability s boldOn :: TermStr s => Capability s dimOn :: TermStr s => Capability s invisibleOn :: TermStr s => Capability s protectedOn :: TermStr s => Capability s

Bell alerts

bell :: TermStr s => Capability s Source

Sound the audible bell.

visualBell :: Capability TermOutput Source

Present a visual alert using the flash capability.

Text attributes

data Attributes Source

Constructors Attributes standoutAttr :: Bool underlineAttr :: Bool reverseAttr :: Bool blinkAttr :: Bool dimAttr :: Bool boldAttr :: Bool invisibleAttr :: Bool protectedAttr :: Bool

defaultAttributes :: Attributes Source

These attributes have all properties turned off.

withAttributes :: TermStr s => Capability (Attributes -> s -> s) Source

Sets the attributes on or off before outputting the given text, and then turns them all off. This capability will always succeed; properties which cannot be set in the current terminal will be ignored.

setAttributes :: TermStr s => Capability (Attributes -> s) Source

Sets the attributes on or off. This capability will always succeed; properties which cannot be set in the current terminal will be ignored.

allAttributesOff :: TermStr s => Capability s Source

Turns off all text attributes. This capability will always succeed, but it has no effect in terminals which do not support text attributes.

Mode wrappers

withStandout :: TermStr s => Capability (s -> s) Source

Turns on standout mode before outputting the given text, and then turns it off.

withUnderline :: TermStr s => Capability (s -> s) Source

Turns on underline mode before outputting the given text, and then turns it off.

withBold :: TermStr s => Capability (s -> s) Source

Turns on bold mode before outputting the given text, and then turns all attributes off.

Low-level capabilities

enterStandoutMode :: TermStr s => Capability s Source

exitStandoutMode :: TermStr s => Capability s Source

enterUnderlineMode :: TermStr s => Capability s Source

exitUnderlineMode :: TermStr s => Capability s Source

reverseOn :: TermStr s => Capability s Source

blinkOn :: TermStr s => Capability s Source

boldOn :: TermStr s => Capability s Source

dimOn :: TermStr s => Capability s Source

invisibleOn :: TermStr s => Capability s Source

protectedOn :: TermStr s => Capability s Source

Produced by Haddock version 2.6.0