Graphics.PDF.Typesetting

A letter which can be anything. Sizes are widths and for glue the dilation and compression factors For the generic letter, height and descent are also provided

Constructors

Letter BoxDimension !AnyBox !(Maybe s)	Any box as a letter
Glue !PDFFloat !PDFFloat !PDFFloat !(Maybe s)	A glue with style to know if it is part of the same sentence
FlaggedPenalty !PDFFloat !Int !s	Hyphen point
Penalty !Int	Penalty
AChar !s !Char !PDFFloat	A char
Kern !PDFFloat !(Maybe s)	A kern : non dilatable and non breakable glue

Instances

PointedBox s (PDFFloat, PDFFloat, PDFFloat, Int, Letter s)

MaybeGlue (Letter s)

Show (Letter s)

MonadWriter [Letter s] Para

type BoxDimension = (PDFFloat, PDFFloat, PDFFloat)

Dimension of a box : width, height and descent

Styles

class ComparableStyle a => Style a where

Style of text (sentences and words). Minimum definition textStyle

Methods

sentenceStyle

:: a	The style
-> Maybe (Rectangle -> Draw b -> Draw ())	Function receiving the bounding rectangle and the command for drawing the sentence
Modify the look of a sentence (sequence of words using the same style on a line)

wordStyle

:: a	The style
-> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ())	Word styling function

textStyle :: a -> TextStyle

updateStyle :: a -> a

A style may contain data changed from word to word

styleHeight :: a -> PDFFloat

A style may change the height of words

 Default implementation
 styleHeight = getHeight . textFont . textStyle

styleDescent :: a -> PDFFloat

A style may change the descent of lines

 Default implementation
 styleDescent = getDescent . textFont . textStyle

Instances

Style StandardStyle

data TextStyle

Text style used by PDF operators

Constructors

TextStyle

textFont :: !PDFFont
textStrokeColor :: !Color
textFillColor :: !Color
textMode :: !TextMode
penWidth :: !PDFFloat
scaleSpace :: !PDFFloat	Scaling factor for normal space size (scale also the dilation and compression factors)
scaleDilatation :: !PDFFloat	Scale the dilation factor of glues
scaleCompression :: !PDFFloat	Scale the compression factor of glues

Instances

Eq TextStyle

data StyleFunction

What kind of style drawing function is required for a word when word styling is enabled

Constructors

DrawWord	Must style a word
DrawGlue	Must style a glue

Instances

Eq StyleFunction

class (ComparableStyle a, Style s) => ParagraphStyle a s | a -> s where

Paragraph style

Methods

lineWidth

:: a	The style
-> PDFFloat	Width of the text area used by the typesetting algorithm
-> Int	Line number
-> PDFFloat	Line width
Width of the line of the paragraph

linePosition

:: a	The style
-> PDFFloat	Width of the text area used by the typesetting algorithm
-> Int	Line number
-> PDFFloat	Horizontal offset from the left edge of the text area
Horizontal shift of the line position relatively to the left egde of the paragraph bounding box

interline

:: a	The style
-> Maybe (Rectangle -> Draw ())	Function used to style interline glues
How to style the interline glues added in a paragraph by the line breaking algorithm

paragraphChange

:: a	The style
-> Int	Line offset different from 0 when a paragraph has been broken
-> [Letter s]	List of letters in the paragraph
-> (a, [Letter s])	Update style and list of letters
Change the content of a paragraph before the line breaking algorithm is run. It may also change the style

paragraphStyle

:: a	The style
-> Maybe (Rectangle -> Draw b -> Draw ())	Function used to style a paragraph
Get the paragraph bounding box and the paragraph draw command to apply additional effects

Instances

ParagraphStyle StandardParagraphStyle StandardStyle

class (Style s, Monad m) => MonadStyle s m | m -> s where

A MonadStyle where some typesetting operators can be used

Methods

setStyle :: s -> m ()

Set the current text style

currentStyle :: m s

Get the current text style

addBox

:: (Show a, DisplayableBox a, Box a)
=> a
-> PDFFloat	Width
-> PDFFloat	Height
-> PDFFloat	Descent
-> m ()
Add a box using the current mode (horizontal or vertical. The current style is always applied to the added box)

glue

:: PDFFloat	Size of glue (width or height depending on the mode)
-> PDFFloat	Dilatation factor
-> PDFFloat	Compression factor
-> m ()
Add a glue using the current style

unstyledGlue

:: PDFFloat	Size of glue (width or height depending on the mode)
-> PDFFloat	Dilatation factor
-> PDFFloat	Compression factor
-> m ()
Add a glue with no style (it is just a translation)

Instances

Style s => MonadStyle s (Para s)

Style s => MonadStyle s (TM ps s)

class ComparableStyle a where

Used to compare two style without taking into account the style state

Methods

isSameStyleAs :: a -> a -> Bool

Instances

ComparableStyle StandardParagraphStyle

ComparableStyle StandardStyle

Typesetting monads

data Para s a

Instances

Functor Para

Monad Para

MonadReader BRState Para

MonadState s Para

Style s => MonadStyle s (Para s)

MonadWriter [Letter s] Para

data TM ps s a

Instances

Functor TM

Monad TM

Style s => MonadStyle s (TM ps s)

MonadWriter [VBox ps s] TM

MonadState (TMState ps s) TM

Containers

data VBox ps s

Instances

MonadWriter [VBox ps s] TM

Box (VBox ps s)

ParagraphStyle ps s => DisplayableBox (VBox ps s)

MaybeGlue (VBox ps s)

Show (VBox ps s)

data VerState s

Constructors

VerState

baselineskip :: !(PDFFloat, PDFFloat, PDFFloat)	Default value (12,0.17,0.0)
lineskip :: !(PDFFloat, PDFFloat, PDFFloat)	Default value (3.0,0.33,0.0)
lineskiplimit :: !PDFFloat	Default value 2
currentParagraphStyle :: !s

data Container ps s

Container for vboxes (x,y,width,maxheight,height,currenty,current z, tolerance para) tolerance para means a paragraph is not started if too close from the bottom edge of the box

data Justification

Constructors

FullJustification
Centered
LeftJustification
RightJustification

Instances

Eq Justification

Functions

Text display

displayFormattedText

:: ParagraphStyle ps s
=> Rectangle	Text area
-> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> Draw a	Draw monad
Display a formatted text in a given bounding rectangle with a given default paragraph style, a given default text style. No clipping is taking place. Drawing stop when the last line is crossing the bounding rectangle in vertical direction

Text construction operators

txt :: Style s => String -> Para s ()

Add a text line

kern :: Style s => PDFFloat -> Para s ()

add a kern (space that can be dilated or compressed and on which no line breaking can occur)

addPenalty :: Int -> Para s ()

Add a penalty

mkLetter

:: (Show a, Box a, DisplayableBox a)
=> BoxDimension	Dimension of the box
-> Maybe s	Text style of the box (can use t)
-> a	Box
-> Letter s
Make a letter from any box

mkDrawBox :: Draw () -> DrawBox

Make a drawing box. A box object containing a Draw value

Paragraph construction operators

forceNewLine :: Style s => Para s ()

For a newline and end the current paragraph

paragraph :: Style s => Para s a -> TM ps s a

Add a new paragraph to the text

endPara :: Style s => Para s ()

startPara :: Style s => Para s ()

Functions useful to change the paragraph style

getParaStyle :: TM ps s ps

Get the current paragraph style

setParaStyle :: ParagraphStyle ps s => ps -> TM ps s ()

Change the current paragraph style

Container

mkContainer

:: PDFFloat	x
-> PDFFloat	y
-> PDFFloat	width
-> PDFFloat	height
-> PDFFloat	Pargraph tolerance
-> Container ps s	New container
Create a empty container to constraint the amount of line that can be displayed

fillContainer

:: (ParagraphStyle ps s, ComparableStyle ps)
=> VerState ps	Vertical style for interline glues
-> Container ps s	Container
-> [VBox ps s]	VBox to add
-> (Draw (), Container ps s, [VBox ps s])	Component to draw, new container and remaining VBoxes due to overfull container
Fill a container with lines

defaultVerState :: s -> VerState s

Default vertical state

 Default values
 baselineskip = (12,0.17,0.0)
 lineskip = (3.0,0.33,0.0)
 lineskiplimit = 2

getBoxes

:: ParagraphStyle ps s
=> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> [VBox ps s]	List of boxes
Return the list of Vboxes for a text