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

Show (Letter s)

MaybeGlue (Letter s)

type BoxDimension = (PDFFloat, PDFFloat, PDFFloat)

Source

Dimension of a box : width, height and descent

Styles

class ComparableStyle a => Style a where

Source

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

Methods

sentenceStyle

Source

::
=> a	The style
-> Maybe (Rectangle -> Draw b -> Draw ())	Function receiving the bounding rectangle and the command for drawing the sentence

wordStyle

Source

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

textStyle :: a -> TextStyle

Source

updateStyle :: a -> a

Source

styleHeight :: a -> PDFFloat

Source

styleDescent :: a -> PDFFloat

Source

Instances

Style StandardStyle

data TextStyle

Source

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

Source

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

Source

Paragraph style

Methods

lineWidth

Source

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

linePosition

Source

:: 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

interline

Source

:: a	The style
-> Maybe (Rectangle -> Draw ())	Function used to style interline glues

paragraphChange

Source

:: 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

paragraphStyle

Source

::
=> a	The style
-> Maybe (Rectangle -> Draw b -> Draw ())	Function used to style a paragraph

Instances

ParagraphStyle StandardParagraphStyle StandardStyle

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

Source

A MonadStyle where some typesetting operators can be used

Methods

setStyle :: s -> m ()

Source

Set the current text style

currentStyle :: m s

Source

Get the current text style

addBox

Source

:: (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

Source

:: 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

Source

:: 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

Source

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

Methods

isSameStyleAs :: a -> a -> Bool

Source

Instances

ComparableStyle StandardParagraphStyle

ComparableStyle StandardStyle

Typesetting monads

data Para s a

Source

Instances

MonadReader BRState (Para s)

MonadState s (Para s)

Style s => MonadStyle s (Para s)

Monad (Para s)

Functor (Para s)

MonadWriter ([] (Letter s)) (Para s)

data TM ps s a

Source

Instances

Style s => MonadStyle s (TM ps s)

MonadWriter ([] (VBox ps s)) (TM ps s)

Monad (TM ps s)

Functor (TM ps s)

MonadState (TMState ps s) (TM ps s)

Containers

data VBox ps s

Source

Instances

Show (VBox ps s)

ParagraphStyle ps s => DisplayableBox (VBox ps s)

Box (VBox ps s)

MaybeGlue (VBox ps s)

data VerState s

Source

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

Source

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

Source

Constructors

FullJustification
Centered
LeftJustification
RightJustification

Instances

Eq Justification

data Orientation

Source

Constructors

E
W
N
S
NE
NW
SE
SW

Instances

displayFormattedText

Source

:: 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 ()

Source

Add a text line

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

Source

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

addPenalty :: Int -> Para s ()

Source

Add a penalty

mkLetter

Source

:: (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

Source

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

Paragraph construction operators

forceNewLine :: Style s => Para s ()

Source

For a newline and end the current paragraph

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

Source

Add a new paragraph to the text

endPara :: Style s => Para s ()

Source

startPara :: Style s => Para s ()

Source

Functions useful to change the paragraph style

getParaStyle :: TM ps s ps

Source

Get the current paragraph style

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

Source

Change the current paragraph style

Container

mkContainer

Source

::
=> 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

Source

:: (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

Source

Default vertical state

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

getBoxes

Source

:: 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

containerX :: Container ps s -> PDFFloat

Source

Container horizontal position

containerY :: Container ps s -> PDFFloat

Source

Container vertical position

containerWidth :: Container ps s -> PDFFloat

Source

Get the width of the container

containerHeight :: Container ps s -> PDFFloat

Source

Get the height of the container

containerContentHeight :: Container ps s -> PDFFloat

Source

Get the content height of the container with glue dilatation

containerContentRightBorder :: Container ps s -> PDFFloat

Source

Get the maximum right border of the container content (maybe bigger than container width due to overfull lines)

containerContentLeftBorder :: Container ps s -> PDFFloat

Source

Get the minimum left border of the container content

containerCurrentHeight :: Container ps s -> PDFFloat

Source

Get the current height of the container without glue dilatation

containerContentRectangle :: Container ps s -> Rectangle

Source

Return the rectangle containing the text after formatting and glue dilatation

drawTextBox

Source

:: (ParagraphStyle ps s, Style s)
=> PDFFloat	x
-> PDFFloat	y
-> PDFFloat	width limit
-> PDFFloat	height limit
-> Orientation
-> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> (Rectangle, Draw ())
Draw a text box with relative position. Useful for labels