word-wrap-0.4.1: A library for word-wrapping
Safe HaskellSafe-Inferred
LanguageHaskell2010

Text.Wrap

Synopsis

Documentation

data WrapSettings Source #

Settings to control how wrapping is performed.

Constructors

WrapSettings 

Fields

  • preserveIndentation :: Bool

    Whether to indent new lines created by wrapping when their original line was indented.

  • breakLongWords :: Bool

    Whether to break in the middle of the first word on a line when that word exceeds the wrapping width.

Instances

Instances details
Eq WrapSettings Source # 
Instance details

Defined in Text.Wrap

Methods

(==) :: WrapSettings -> WrapSettings -> Bool

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

Read WrapSettings Source # 
Instance details

Defined in Text.Wrap

Methods

readsPrec :: Int -> ReadS WrapSettings

readList :: ReadS [WrapSettings]

readPrec :: ReadPrec WrapSettings

readListPrec :: ReadPrec [WrapSettings]

Show WrapSettings Source # 
Instance details

Defined in Text.Wrap

Methods

showsPrec :: Int -> WrapSettings -> ShowS

show :: WrapSettings -> String

showList :: [WrapSettings] -> ShowS

wrapTextToLines :: WrapSettings -> Int -> Text -> [Text] Source #

Wrap text at the specified width. Newlines and whitespace in the input text are preserved. Returns the lines of text in wrapped form. New lines introduced due to wrapping will have leading whitespace stripped.

wrapText :: WrapSettings -> Int -> Text -> Text Source #

Like wrapTextToLines, but returns the wrapped text reconstructed with newlines inserted at wrap points.