Safe Haskell	None
Language	Haskell2010

Data.Text.ParagraphLayout.Rich

Contents

Paragraph options
Content tree
Box options
Text options
Verification
Output layout

Description

Interface for laying out paragraphs of rich text.

The main entry point is the function layoutRich.

Synopsis

data Paragraph d = Paragraph Array Int (RootNode Int d) ParagraphOptions
constructParagraph :: Text -> RootNode Text d -> Text -> ParagraphOptions -> Paragraph d
data BoxSpacing = BoxSpacingLeftRight Int32 Int32
data LineHeight
- = Normal
- | Absolute Int32
data ParagraphOptions
defaultParagraphOptions :: ParagraphOptions
paragraphLineHeight :: ParagraphOptions -> LineHeight
paragraphMaxWidth :: ParagraphOptions -> Int32
data RootNode t d = RootBox (Box t d)
data InnerNode t d
- = InlineBox d (Box t d) BoxOptions
- | TextSequence d t
data Box t d = Box [InnerNode t d] TextOptions
data BoxOptions
defaultBoxOptions :: BoxOptions
data TextOptions
defaultTextOptions :: Direction -> TextOptions
boxSpacing :: BoxOptions -> BoxSpacing
textFont :: TextOptions -> Font
textLineHeight :: TextOptions -> LineHeight
textLanguage :: TextOptions -> String
textDirection :: TextOptions -> Direction
paragraphSpanBounds :: Paragraph d -> NonEmpty Int
paragraphSpanTexts :: Paragraph d -> [Text]
paragraphText :: Paragraph d -> Text
layoutRich :: Paragraph d -> ParagraphLayout d
data ParagraphLayout d = ParagraphLayout {
- paragraphRect :: Rect Int32
- paragraphFragments :: [Fragment d]
}
data Fragment d = Fragment {
- fragmentUserData :: d
- fragmentLine :: Int
- fragmentAncestorBoxes :: [AncestorBox d]
- fragmentRect :: Rect Int32
- fragmentPen :: (Int32, Int32)
- fragmentGlyphs :: [(GlyphInfo, GlyphPos)]
}
fragmentSpacedRect :: Fragment d -> Rect Int32
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 (RootNode Int d) ParagraphOptions

constructParagraph :: Text -> RootNode Text d -> Text -> ParagraphOptions -> Paragraph d #

data BoxSpacing #

Constructors

BoxSpacingLeftRight Int32 Int32

Instances

Instances details

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

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.

paragraphLineHeight :: ParagraphOptions -> LineHeight #

paragraphMaxWidth :: ParagraphOptions -> Int32 #

Content tree

data RootNode t d #

Constructors

RootBox (Box t d)

data InnerNode t d #

Constructors

InlineBox d (Box t d) BoxOptions
TextSequence d t

data Box t d #

Constructors

Box [InnerNode t d] TextOptions

data BoxOptions #

Instances

Instances details

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

defaultBoxOptions :: BoxOptions #

data TextOptions #

Instances

Instances details

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

defaultTextOptions :: Direction -> TextOptions #

Box options

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

boxSpacing :: BoxOptions -> BoxSpacing #

Text options

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

textFont :: TextOptions -> Font #

textLineHeight :: TextOptions -> LineHeight #

textLanguage :: TextOptions -> String #

textDirection :: TextOptions -> Direction #

Verification

paragraphSpanBounds :: Paragraph d -> NonEmpty Int #

paragraphSpanTexts :: Paragraph d -> [Text] #

paragraphText :: Paragraph d -> Text #

Output layout

layoutRich :: Paragraph d -> ParagraphLayout d #

data ParagraphLayout d #

Constructors

ParagraphLayout
Fields paragraphRect :: Rect Int32 paragraphFragments :: [Fragment d]

Instances

Instances details

Eq d => Eq (ParagraphLayout d)
Instance details Defined in Data.Text.ParagraphLayout.Internal.Rich.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.Rich.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.Rich.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.Rich.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 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

fragmentSpacedRect :: Fragment d -> Rect Int32 #

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