Safe Haskell	None
Language	Haskell2010

Data.Text.ParagraphLayout.Plain

Contents

Paragraph options
Text spans
Span options
Verification
Output layout

Description

Deprecated: Use Data.Text.ParagraphLayout.Rich instead.

Legacy interface for laying out paragraphs of plain text.

This interface only allows one font with a fixed line height to be used for the entire paragraph. As a consequence, all lines will have the same height.

Synopsis

data Paragraph d = Paragraph Array Int [Span d] ParagraphOptions
data LineHeight
- = Normal
- | Absolute Int32
data ParagraphOptions
defaultParagraphOptions :: ParagraphOptions
paragraphFont :: ParagraphOptions -> Font
paragraphLineHeight :: ParagraphOptions -> LineHeight
paragraphMaxWidth :: ParagraphOptions -> Int32
data Span d = Span {
- spanUserData :: d
- spanLength :: Int
- spanOptions :: SpanOptions
}
data SpanOptions
defaultSpanOptions :: SpanOptions
spanLanguage :: SpanOptions -> String
paragraphSpanBounds :: Paragraph d -> NonEmpty Int
paragraphSpanTexts :: Paragraph d -> [Text]
paragraphText :: Paragraph d -> Text
layoutPlain :: Paragraph d -> ParagraphLayout d
data ParagraphLayout d = ParagraphLayout {
- paragraphRect :: Rect Int32
- spanLayouts :: [SpanLayout d]
}
data SpanLayout d = SpanLayout [Fragment d]
data Fragment d = Fragment {
- fragmentUserData :: d
- fragmentLine :: Int
- fragmentAncestorBoxes :: [AncestorBox d]
- fragmentRect :: Rect Int32
- fragmentPen :: (Int32, Int32)
- fragmentGlyphs :: [(GlyphInfo, GlyphPos)]
}
data AncestorBox d = AncestorBox {
- boxUserData :: d
- boxLeftEdge :: BoxEdge
- boxRightEdge :: BoxEdge
- boxStartEdge :: BoxEdge
- boxEndEdge :: BoxEdge
}
data BoxEdge
- = NoEdge
- | SpacedEdge Int32

Documentation

data Paragraph d #

Constructors

Paragraph Array Int [Span d] ParagraphOptions

data LineHeight #

Constructors

Normal
Absolute Int32

Instances

Instances details

Eq LineHeight
Instance details Defined in Data.Text.ParagraphLayout.Internal.LineHeight Methods (==) :: LineHeight -> LineHeight -> Bool (/=) :: LineHeight -> LineHeight -> Bool
Read LineHeight
Instance details Defined in Data.Text.ParagraphLayout.Internal.LineHeight Methods readsPrec :: Int -> ReadS LineHeight readList :: ReadS [LineHeight] readPrec :: ReadPrec LineHeight readListPrec :: ReadPrec [LineHeight]
Show LineHeight
Instance details Defined in Data.Text.ParagraphLayout.Internal.LineHeight Methods showsPrec :: Int -> LineHeight -> ShowS show :: LineHeight -> String showList :: [LineHeight] -> ShowS

data ParagraphOptions #

Instances

Instances details

Eq ParagraphOptions
Instance details Defined in Data.Text.ParagraphLayout.Internal.ParagraphOptions Methods (==) :: ParagraphOptions -> ParagraphOptions -> Bool (/=) :: ParagraphOptions -> ParagraphOptions -> Bool

defaultParagraphOptions :: ParagraphOptions #

Paragraph options

These are record selectors that can be used for reading as well as updating specific option fields.

paragraphFont :: ParagraphOptions -> Font #

paragraphLineHeight :: ParagraphOptions -> LineHeight #

paragraphMaxWidth :: ParagraphOptions -> Int32 #

Text spans

data Span d #

Constructors

Span
Fields spanUserData :: d spanLength :: Int spanOptions :: SpanOptions

Instances

Instances details

Eq d => Eq (Span d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Span Methods (==) :: Span d -> Span d -> Bool (/=) :: Span d -> Span d -> Bool

data SpanOptions #

Instances

Instances details

Eq SpanOptions
Instance details Defined in Data.Text.ParagraphLayout.Internal.Span Methods (==) :: SpanOptions -> SpanOptions -> Bool (/=) :: SpanOptions -> SpanOptions -> Bool

defaultSpanOptions :: SpanOptions #

Span options

These are record selectors that can be used for reading as well as updating specific option fields.

spanLanguage :: SpanOptions -> String #

Verification

paragraphSpanBounds :: Paragraph d -> NonEmpty Int #

paragraphSpanTexts :: Paragraph d -> [Text] #

paragraphText :: Paragraph d -> Text #

Output layout

layoutPlain :: Paragraph d -> ParagraphLayout d #

data ParagraphLayout d #

Constructors

ParagraphLayout
Fields paragraphRect :: Rect Int32 spanLayouts :: [SpanLayout d]

Instances

Instances details

Eq d => Eq (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Plain.ParagraphLayout Methods (==) :: ParagraphLayout d -> ParagraphLayout d -> Bool (/=) :: ParagraphLayout d -> ParagraphLayout d -> Bool
Read d => Read (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Plain.ParagraphLayout Methods readsPrec :: Int -> ReadS (ParagraphLayout d) readList :: ReadS [ParagraphLayout d] readPrec :: ReadPrec (ParagraphLayout d) readListPrec :: ReadPrec [ParagraphLayout d]
Show d => Show (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Plain.ParagraphLayout Methods showsPrec :: Int -> ParagraphLayout d -> ShowS show :: ParagraphLayout d -> String showList :: [ParagraphLayout d] -> ShowS
Line (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Plain.ParagraphLayout Methods lineHeight :: ParagraphLayout d -> Int32
Paginable (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Paginable Methods paginate :: PageOptions -> ParagraphLayout d -> (PageContinuity, ParagraphLayout d, Maybe (ParagraphLayout d)) #

data SpanLayout d #

Constructors

SpanLayout [Fragment d]

Instances

Instances details

Eq d => Eq (SpanLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Span Methods (==) :: SpanLayout d -> SpanLayout d -> Bool (/=) :: SpanLayout d -> SpanLayout d -> Bool
Read d => Read (SpanLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Span Methods readsPrec :: Int -> ReadS (SpanLayout d) readList :: ReadS [SpanLayout d] readPrec :: ReadPrec (SpanLayout d) readListPrec :: ReadPrec [SpanLayout d]
Show d => Show (SpanLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Span Methods showsPrec :: Int -> SpanLayout d -> ShowS show :: SpanLayout d -> String showList :: [SpanLayout d] -> ShowS

data Fragment d #

Constructors

Fragment
Fields fragmentUserData :: d fragmentLine :: Int fragmentAncestorBoxes :: [AncestorBox d] fragmentRect :: Rect Int32 fragmentPen :: (Int32, Int32) fragmentGlyphs :: [(GlyphInfo, GlyphPos)]

Instances

Instances details

Eq d => Eq (Fragment d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Fragment Methods (==) :: Fragment d -> Fragment d -> Bool (/=) :: Fragment d -> Fragment d -> Bool
Read d => Read (Fragment d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Fragment Methods readsPrec :: Int -> ReadS (Fragment d) readList :: ReadS [Fragment d] readPrec :: ReadPrec (Fragment d) readListPrec :: ReadPrec [Fragment d]
Show d => Show (Fragment d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Fragment Methods showsPrec :: Int -> Fragment d -> ShowS show :: Fragment d -> String showList :: [Fragment d] -> ShowS

data AncestorBox d #

Constructors

AncestorBox
Fields boxUserData :: d boxLeftEdge :: BoxEdge boxRightEdge :: BoxEdge boxStartEdge :: BoxEdge boxEndEdge :: BoxEdge

Instances

Instances details

Eq d => Eq (AncestorBox d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods (==) :: AncestorBox d -> AncestorBox d -> Bool (/=) :: AncestorBox d -> AncestorBox d -> Bool
Read d => Read (AncestorBox d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods readsPrec :: Int -> ReadS (AncestorBox d) readList :: ReadS [AncestorBox d] readPrec :: ReadPrec (AncestorBox d) readListPrec :: ReadPrec [AncestorBox d]
Show d => Show (AncestorBox d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods showsPrec :: Int -> AncestorBox d -> ShowS show :: AncestorBox d -> String showList :: [AncestorBox d] -> ShowS

data BoxEdge #

Constructors

NoEdge
SpacedEdge Int32

Instances

Instances details

Eq BoxEdge
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods (==) :: BoxEdge -> BoxEdge -> Bool (/=) :: BoxEdge -> BoxEdge -> Bool
Read BoxEdge
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods readsPrec :: Int -> ReadS BoxEdge readList :: ReadS [BoxEdge] readPrec :: ReadPrec BoxEdge readListPrec :: ReadPrec [BoxEdge]
Show BoxEdge
Instance details Defined in Data.Text.ParagraphLayout.Internal.AncestorBox Methods showsPrec :: Int -> BoxEdge -> ShowS show :: BoxEdge -> String showList :: [BoxEdge] -> ShowS