Graphics.PDF

Generation of PDF documents A PDF library with support for several pages, page transitions, outlines, annotations, compression, colors, shapes, patterns, jpegs, fonts, typesetting ... Have a look at the Graphics.PDF.Documentation module to see how to use it. Or, download the package and look at the test.hs file in the Test folder. That file is giving an example of each feature.

HPDF

PDF Monad

data PDF a

The PDF Monad

Instances

PDFGlobals PDF

Defined in Graphics.PDF.Draw

Methods

bounds :: PDFXObject a => PDFReference a -> PDF (PDFFloat, PDFFloat)

Applicative PDF

Defined in Graphics.PDF.Draw

Methods

pure :: a -> PDF a

(<*>) :: PDF (a -> b) -> PDF a -> PDF b

liftA2 :: (a -> b -> c) -> PDF a -> PDF b -> PDF c

(*>) :: PDF a -> PDF b -> PDF b

(<*) :: PDF a -> PDF b -> PDF a

Functor PDF

Defined in Graphics.PDF.Draw

Methods

fmap :: (a -> b) -> PDF a -> PDF b

(<$) :: a -> PDF b -> PDF a

Monad PDF

Defined in Graphics.PDF.Draw

Methods

(>>=) :: PDF a -> (a -> PDF b) -> PDF b

(>>) :: PDF a -> PDF b -> PDF b

return :: a -> PDF a

runPdf

Arguments

:: String

Name of the PDF document

-> PDFDocumentInfo

-> PDFRect

Default size for a page

-> PDF a

PDF action

-> IO ()

Generates a PDF document

pdfByteString

Arguments

:: PDFDocumentInfo

-> PDFRect

Default size for a page

-> PDF a

PDF action

-> ByteString

Generate a lazy bytestring for the PDF

PDF Common Types

data PDFRect

A PDF rectangle

Constructors

PDFRect !Double !Double !Double !Double

type PDFFloat = Double

A real number in a PDF document

data PDFReference s

A reference to a PDF object

Instances

PdfObject s => Num (PDFReference s)

Defined in Graphics.PDF.LowLevel.Types

Methods

(+) :: PDFReference s -> PDFReference s -> PDFReference s

(-) :: PDFReference s -> PDFReference s -> PDFReference s

(*) :: PDFReference s -> PDFReference s -> PDFReference s

negate :: PDFReference s -> PDFReference s

abs :: PDFReference s -> PDFReference s

signum :: PDFReference s -> PDFReference s

fromInteger :: Integer -> PDFReference s

Show (PDFReference s)

Defined in Graphics.PDF.LowLevel.Types

Methods

showsPrec :: Int -> PDFReference s -> ShowS

show :: PDFReference s -> String

showList :: [PDFReference s] -> ShowS

Eq (PDFReference s)

Defined in Graphics.PDF.LowLevel.Types

Methods

(==) :: PDFReference s -> PDFReference s -> Bool

(/=) :: PDFReference s -> PDFReference s -> Bool

Ord (PDFReference s)

Defined in Graphics.PDF.LowLevel.Types

Methods

compare :: PDFReference s -> PDFReference s -> Ordering

(<) :: PDFReference s -> PDFReference s -> Bool

(<=) :: PDFReference s -> PDFReference s -> Bool

(>) :: PDFReference s -> PDFReference s -> Bool

(>=) :: PDFReference s -> PDFReference s -> Bool

max :: PDFReference s -> PDFReference s -> PDFReference s

min :: PDFReference s -> PDFReference s -> PDFReference s

data PDFString

A PDFString containing a strict bytestring (serialied as UTF16BE)

Instances

Show PDFString

Defined in Graphics.PDF.LowLevel.Types

Methods

showsPrec :: Int -> PDFString -> ShowS

show :: PDFString -> String

showList :: [PDFString] -> ShowS

Eq PDFString

Defined in Graphics.PDF.LowLevel.Types

Methods

(==) :: PDFString -> PDFString -> Bool

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

Ord PDFString

Defined in Graphics.PDF.LowLevel.Types

Methods

compare :: PDFString -> PDFString -> Ordering

(<) :: PDFString -> PDFString -> Bool

(<=) :: PDFString -> PDFString -> Bool

(>) :: PDFString -> PDFString -> Bool

(>=) :: PDFString -> PDFString -> Bool

max :: PDFString -> PDFString -> PDFString

min :: PDFString -> PDFString -> PDFString

data PDFPage

A PDF Page object

Instances

Show PDFPage

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFPage -> ShowS

show :: PDFPage -> String

showList :: [PDFPage] -> ShowS

data Pages

List of all pages

Document management

data Draw a

The drawing monad

Instances

PDFGlobals Draw

Defined in Graphics.PDF.Draw

Methods

bounds :: PDFXObject a => PDFReference a -> Draw (PDFFloat, PDFFloat)

Applicative Draw

Defined in Graphics.PDF.Draw

Methods

pure :: a -> Draw a

(<*>) :: Draw (a -> b) -> Draw a -> Draw b

liftA2 :: (a -> b -> c) -> Draw a -> Draw b -> Draw c

(*>) :: Draw a -> Draw b -> Draw b

(<*) :: Draw a -> Draw b -> Draw a

Functor Draw

Defined in Graphics.PDF.Draw

Methods

fmap :: (a -> b) -> Draw a -> Draw b

(<$) :: a -> Draw b -> Draw a

Monad Draw

Defined in Graphics.PDF.Draw

Methods

(>>=) :: Draw a -> (a -> Draw b) -> Draw b

(>>) :: Draw a -> Draw b -> Draw b

return :: a -> Draw a

MonadWriter Builder Draw

Defined in Graphics.PDF.Draw

Methods

writer :: (a, Builder) -> Draw a

tell :: Builder -> Draw ()

listen :: Draw a -> Draw (a, Builder)

pass :: Draw (a, Builder -> Builder) -> Draw a

data PDFXForm

Instances

PDFXObject PDFXForm

Defined in Graphics.PDF.Draw

Methods

drawXObject :: PDFReference PDFXForm -> Draw ()

privateDrawXObject :: PDFReference PDFXForm -> Draw ()

data PDFTransition

A PDF Transition

Constructors

PDFTransition !PDFFloat !PDFTransStyle

Instances

Eq PDFTransition

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFTransition -> PDFTransition -> Bool

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

data PDFTransStyle

Transition style

Constructors

Split PDFTransDimension PDFTransDirection

Blinds PDFTransDimension

Box PDFTransDirection

Wipe PDFTransDirection2

Dissolve

Glitter PDFTransDirection2

Instances

Show PDFTransStyle

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFTransStyle -> ShowS

show :: PDFTransStyle -> String

showList :: [PDFTransStyle] -> ShowS

Eq PDFTransStyle

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFTransStyle -> PDFTransStyle -> Bool

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

data PDFTransDirection

Direction of a transition

Constructors

Inward

Outward

Instances

Show PDFTransDirection

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFTransDirection -> ShowS

show :: PDFTransDirection -> String

showList :: [PDFTransDirection] -> ShowS

Eq PDFTransDirection

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFTransDirection -> PDFTransDirection -> Bool

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

data PDFTransDimension

Dimension of a transition

Constructors

Horizontal

Vertical

Instances

Show PDFTransDimension

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFTransDimension -> ShowS

show :: PDFTransDimension -> String

showList :: [PDFTransDimension] -> ShowS

Eq PDFTransDimension

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFTransDimension -> PDFTransDimension -> Bool

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

data PDFTransDirection2

Direction of a transition

Constructors

LeftToRight

BottomToTop

Wipe only

RightToLeft

Wipe only

TopToBottom

TopLeftToBottomRight

Glitter only

Instances

Eq PDFTransDirection2

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFTransDirection2 -> PDFTransDirection2 -> Bool

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

data PDFDocumentInfo

Document metadata

Constructors

PDFDocumentInfo

Fields

• author :: Text
• subject :: Text
• pageMode :: PDFDocumentPageMode
• pageLayout :: PDFDocumentPageLayout
• viewerPreferences :: PDFViewerPreferences
• compressed :: Bool

data PDFDocumentPageMode

Document page mode

Constructors

UseNone

UseOutlines

UseThumbs

FullScreen

Instances

Show PDFDocumentPageMode

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFDocumentPageMode -> ShowS

show :: PDFDocumentPageMode -> String

showList :: [PDFDocumentPageMode] -> ShowS

Eq PDFDocumentPageMode

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFDocumentPageMode -> PDFDocumentPageMode -> Bool

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

data PDFDocumentPageLayout

Document page layout

Constructors

SinglePage

OneColumn

TwoColumnLeft

TwoColumnRight

TwoPageLeft

TwoPageRight

Instances

Show PDFDocumentPageLayout

Defined in Graphics.PDF.Draw

Methods

showsPrec :: Int -> PDFDocumentPageLayout -> ShowS

show :: PDFDocumentPageLayout -> String

showList :: [PDFDocumentPageLayout] -> ShowS

Eq PDFDocumentPageLayout

Defined in Graphics.PDF.Draw

Methods

(==) :: PDFDocumentPageLayout -> PDFDocumentPageLayout -> Bool

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

data PDFViewerPreferences

Viewer preferences

Constructors

PDFViewerPreferences

Fields

• hideToolbar :: Bool

  To hide the toolbar

• hideMenuBar :: Bool

  To hide the menubar

• hideWindowUI :: Bool

  To hide the window

• fitWindow :: Bool

  Fit window to screen

• centerWindow :: Bool

  Center window on screen

• displayDoctitle :: Bool

  Display the docu,ent title

• nonFullScreenPageMode :: PDFDocumentPageMode

  Display mode when exiting the full screen mode

class PDFXObject a where

A PDF Xobject which can be drawn

Minimal complete definition

Nothing

Methods

drawXObject :: PDFReference a -> Draw ()

Instances

PDFXObject PDFXForm

Defined in Graphics.PDF.Draw

Methods

drawXObject :: PDFReference PDFXForm -> Draw ()

privateDrawXObject :: PDFReference PDFXForm -> Draw ()

PDFXObject PDFJpeg

Defined in Graphics.PDF.Image

Methods

drawXObject :: PDFReference PDFJpeg -> Draw ()

privateDrawXObject :: PDFReference PDFJpeg -> Draw ()

PDFXObject RawImage

Defined in Graphics.PDF.Image

Methods

drawXObject :: PDFReference RawImage -> Draw ()

privateDrawXObject :: PDFReference RawImage -> Draw ()

class PDFGlobals m where

Methods

bounds :: PDFXObject a => PDFReference a -> m (PDFFloat, PDFFloat)

Instances

PDFGlobals Draw

Defined in Graphics.PDF.Draw

Methods

bounds :: PDFXObject a => PDFReference a -> Draw (PDFFloat, PDFFloat)

PDFGlobals PDF

Defined in Graphics.PDF.Draw

Methods

bounds :: PDFXObject a => PDFReference a -> PDF (PDFFloat, PDFFloat)

addPage

Arguments

:: Maybe PDFRect

Page size or default document's one

-> PDF (PDFReference PDFPage)

Reference to the new page

Add a new page to a PDF document

addPageWithTransition

Arguments

:: Maybe PDFRect

Page size or default document's one

-> Maybe PDFFloat

Optional duration

-> Maybe PDFTransition

Optional transition

-> PDF (PDFReference PDFPage)

Reference to the new page

drawWithPage

Arguments

:: PDFReference PDFPage

Page

-> Draw a

Drawing commands

-> PDF a

Draw on a given page

createPDFXForm

Arguments

:: PDFFloat

Left

-> PDFFloat

Bottom

-> PDFFloat

Right

-> PDFFloat

Top

-> Draw a

Drawing commands

-> PDF (PDFReference PDFXForm)

Create a PDF XObject

standardDocInfo :: PDFDocumentInfo

No information for the document

standardViewerPrefs :: PDFViewerPreferences

withNewContext :: Draw a -> Draw a

Draw in a new drawing context without perturbing the previous context that is restored after the draw

emptyDrawing :: Draw ()

An empty drawing

Drawing

module Graphics.PDF.Shapes

Colors

module Graphics.PDF.Colors

Geometry

module Graphics.PDF.Coordinates

applyMatrix :: Matrix -> Draw ()

Apply a transformation matrix to the current coordinate frame

Text

module Graphics.PDF.Text

Navigation

module Graphics.PDF.Navigation

Annotations

module Graphics.PDF.Annotation

Actions

module Graphics.PDF.Action

Images

module Graphics.PDF.Image

Patterns

module Graphics.PDF.Pattern

Shading

module Graphics.PDF.Shading

Transparency

module Graphics.PDF.Transparency

data ColorSpace a e where

Constructors

GraySpace :: ColorSpace PDFFloat ExprFloat

RGBSpace :: ColorSpace FloatRGB ExprRGB

CMYKSpace :: ColorSpace FloatCMYK ExprCMYK

Instances

Eq (ColorSpace a e)

Defined in Graphics.PDF.Draw

Methods

(==) :: ColorSpace a e -> ColorSpace a e -> Bool

(/=) :: ColorSpace a e -> ColorSpace a e -> Bool

Ord (ColorSpace a e)

Defined in Graphics.PDF.Draw

Methods

compare :: ColorSpace a e -> ColorSpace a e -> Ordering

(<) :: ColorSpace a e -> ColorSpace a e -> Bool

(<=) :: ColorSpace a e -> ColorSpace a e -> Bool

(>) :: ColorSpace a e -> ColorSpace a e -> Bool

(>=) :: ColorSpace a e -> ColorSpace a e -> Bool

max :: ColorSpace a e -> ColorSpace a e -> ColorSpace a e

min :: ColorSpace a e -> ColorSpace a e -> ColorSpace a e

calculator1 :: (ExprFloat -> e) -> Function1 Global a e

calculator2 :: (ExprFloat -> ExprFloat -> e) -> Function2 Global a e

data ColorFunction1

Constructors

forall a e.(ColorTuple a, Result e) => ColorFunction1 (ColorSpace a e) (Function1 Local a e)

Instances

Eq ColorFunction1

Defined in Graphics.PDF.Draw

Methods

(==) :: ColorFunction1 -> ColorFunction1 -> Bool

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

Ord ColorFunction1

Defined in Graphics.PDF.Draw

Methods

compare :: ColorFunction1 -> ColorFunction1 -> Ordering

(<) :: ColorFunction1 -> ColorFunction1 -> Bool

(<=) :: ColorFunction1 -> ColorFunction1 -> Bool

(>) :: ColorFunction1 -> ColorFunction1 -> Bool

(>=) :: ColorFunction1 -> ColorFunction1 -> Bool

max :: ColorFunction1 -> ColorFunction1 -> ColorFunction1

min :: ColorFunction1 -> ColorFunction1 -> ColorFunction1

data ColorFunction2

Constructors

forall a e.(ColorTuple a, Result e) => ColorFunction2 (ColorSpace a e) (Function2 Local a e)

Instances

Eq ColorFunction2

Defined in Graphics.PDF.Draw

Methods

(==) :: ColorFunction2 -> ColorFunction2 -> Bool

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

Ord ColorFunction2

Defined in Graphics.PDF.Draw

Methods

compare :: ColorFunction2 -> ColorFunction2 -> Ordering

(<) :: ColorFunction2 -> ColorFunction2 -> Bool

(<=) :: ColorFunction2 -> ColorFunction2 -> Bool

(>) :: ColorFunction2 -> ColorFunction2 -> Bool

(>=) :: ColorFunction2 -> ColorFunction2 -> Bool

max :: ColorFunction2 -> ColorFunction2 -> ColorFunction2

min :: ColorFunction2 -> ColorFunction2 -> ColorFunction2

data Function1 scope a e where

Constructors

GlobalFunction1 :: FunctionObject (PDFFloat -> a) (ExprFloat -> e) -> Function1 Local a e

Sampled1 :: Array Int a -> Function1 Global a e

Interpolated1 :: PDFFloat -> a -> a -> Function1 scope a e

Stitched1 :: Function1 Local a e -> [(PDFFloat, Function1 Local a e)] -> Function1 scope a e

Calculator1 :: (ExprFloat -> e) -> Function1 Global a e

Instances

(Local ~ scope, ColorTuple a, Eq a, Result e) => Eq (Function1 scope a e)

Defined in Graphics.PDF.Draw

Methods

(==) :: Function1 scope a e -> Function1 scope a e -> Bool

(/=) :: Function1 scope a e -> Function1 scope a e -> Bool

(Local ~ scope, ColorTuple a, Ord a, Result e) => Ord (Function1 scope a e)

Defined in Graphics.PDF.Draw

Methods

compare :: Function1 scope a e -> Function1 scope a e -> Ordering

(<) :: Function1 scope a e -> Function1 scope a e -> Bool

(<=) :: Function1 scope a e -> Function1 scope a e -> Bool

(>) :: Function1 scope a e -> Function1 scope a e -> Bool

(>=) :: Function1 scope a e -> Function1 scope a e -> Bool

max :: Function1 scope a e -> Function1 scope a e -> Function1 scope a e

min :: Function1 scope a e -> Function1 scope a e -> Function1 scope a e

data Function2 scope a e where

Constructors

GlobalFunction2 :: FunctionObject (PDFFloat -> PDFFloat -> a) (ExprFloat -> ExprFloat -> e) -> Function2 Local a e

Sampled2 :: Array (Int, Int) a -> Function2 Global a e

Calculator2 :: (ExprFloat -> ExprFloat -> e) -> Function2 Global a e

Instances

(Local ~ scope, ColorTuple a, Eq a, Result e) => Eq (Function2 scope a e)

Defined in Graphics.PDF.Draw

Methods

(==) :: Function2 scope a e -> Function2 scope a e -> Bool

(/=) :: Function2 scope a e -> Function2 scope a e -> Bool

(Local ~ scope, ColorTuple a, Ord a, Result e) => Ord (Function2 scope a e)

Defined in Graphics.PDF.Draw

Methods

compare :: Function2 scope a e -> Function2 scope a e -> Ordering

(<) :: Function2 scope a e -> Function2 scope a e -> Bool

(<=) :: Function2 scope a e -> Function2 scope a e -> Bool

(>) :: Function2 scope a e -> Function2 scope a e -> Bool

(>=) :: Function2 scope a e -> Function2 scope a e -> Bool

max :: Function2 scope a e -> Function2 scope a e -> Function2 scope a e

min :: Function2 scope a e -> Function2 scope a e -> Function2 scope a e

data Global

data Local

linearStitched :: ColorTuple a => a -> [(PDFFloat, a)] -> a -> Function1 Local a e

data FunctionObject a e

Instances

Eq (FunctionObject a e)

Defined in Graphics.PDF.Draw

Methods

(==) :: FunctionObject a e -> FunctionObject a e -> Bool

(/=) :: FunctionObject a e -> FunctionObject a e -> Bool

Ord (FunctionObject a e)

Defined in Graphics.PDF.Draw

Methods

compare :: FunctionObject a e -> FunctionObject a e -> Ordering

(<) :: FunctionObject a e -> FunctionObject a e -> Bool

(<=) :: FunctionObject a e -> FunctionObject a e -> Bool

(>) :: FunctionObject a e -> FunctionObject a e -> Bool

(>=) :: FunctionObject a e -> FunctionObject a e -> Bool

max :: FunctionObject a e -> FunctionObject a e -> FunctionObject a e

min :: FunctionObject a e -> FunctionObject a e -> FunctionObject a e

Fonts

module Graphics.PDF.Fonts.Font

module Graphics.PDF.Fonts.StandardFont

module Graphics.PDF.Fonts.Type1

readType1Font :: FilePath -> FilePath -> IO (Either ParseError Type1FontStructure)

Create a type 1 font

mkType1Font :: Type1FontStructure -> PDF AnyFont

Typesetting

module Graphics.PDF.Typesetting