Graphics.PDF.Document

Management of the PDF structure

Document actions

Special document objects

data PDFXForm

Instances

PDFXObject PDFXForm

Defined in Graphics.PDF.Draw

Methods

drawXObject :: PDFReference PDFXForm -> Draw ()

privateDrawXObject :: PDFReference PDFXForm -> Draw ()

Page management

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

createPDFXFormExtra

Arguments

:: Rectangle

Bounding Box

-> Draw a

Drawing commands

-> PDFDictionary

-> PDF (PDFReference PDFXForm)

Create a PDF XObject

Page transitions

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

Document information

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

standardDocInfo :: PDFDocumentInfo

No information for the document

standardViewerPrefs :: PDFViewerPreferences

Draw monad and drawing functions

Types

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

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)

General drawing functions

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