Copyright	(c) 2006-2016 alpheccar.org
License	BSD-style
Maintainer	misc@NOSPAMalpheccar.org
Stability	experimental
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Graphics.PDF.Document

Contents

Document actions
Draw monad and drawing functions
- Types
- General drawing functions

Description

Management of the PDF structure

Synopsis

data PDFXForm
addPage :: Maybe PDFRect -> PDF (PDFReference PDFPage)
addPageWithTransition :: Maybe PDFRect -> Maybe PDFFloat -> Maybe PDFTransition -> PDF (PDFReference PDFPage)
drawWithPage :: PDFReference PDFPage -> Draw a -> PDF a
createPDFXForm :: PDFFloat -> PDFFloat -> PDFFloat -> PDFFloat -> Draw a -> PDF (PDFReference PDFXForm)
data PDFTransition = PDFTransition !PDFFloat !PDFTransStyle
data PDFTransStyle
- = Split PDFTransDimension PDFTransDirection
- | Blinds PDFTransDimension
- | Box PDFTransDirection
- | Wipe PDFTransDirection2
- | Dissolve
- | Glitter PDFTransDirection2
data PDFTransDirection
- = Inward
- | Outward
data PDFTransDimension
- = Horizontal
- | Vertical
data PDFTransDirection2
- = LeftToRight
- | BottomToTop
- | RightToLeft
- | TopToBottom
- | TopLeftToBottomRight
data PDFDocumentInfo = PDFDocumentInfo {
- author :: Text
- subject :: Text
- pageMode :: PDFDocumentPageMode
- pageLayout :: PDFDocumentPageLayout
- viewerPreferences :: PDFViewerPreferences
- compressed :: Bool
}
data PDFDocumentPageMode
- = UseNone
- | UseOutlines
- | UseThumbs
- | FullScreen
data PDFDocumentPageLayout
- = SinglePage
- | OneColumn
- | TwoColumnLeft
- | TwoColumnRight
- | TwoPageLeft
- | TwoPageRight
data PDFViewerPreferences = PDFViewerPreferences {
- hideToolbar :: Bool
- hideMenuBar :: Bool
- hideWindowUI :: Bool
- fitWindow :: Bool
- centerWindow :: Bool
- displayDoctitle :: Bool
- nonFullScreenPageMode :: PDFDocumentPageMode
}
standardDocInfo :: PDFDocumentInfo
standardViewerPrefs :: PDFViewerPreferences
data Draw a
class PDFXObject a where
- drawXObject :: PDFReference a -> Draw ()
class PDFGlobals m where
- bounds :: PDFXObject a => PDFReference a -> m (PDFFloat, PDFFloat)
withNewContext :: Draw a -> Draw a
emptyDrawing :: Draw ()

Document actions

Special document objects

data PDFXForm Source #

Instances

Instances details

PDFXObject PDFXForm Source #
Instance details Defined in Graphics.PDF.Draw Methods drawXObject :: PDFReference PDFXForm -> Draw () Source # privateDrawXObject :: PDFReference PDFXForm -> Draw ()

Page management

addPage Source #

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 Source #

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 Source #

Arguments

:: PDFReference PDFPage	Page
-> Draw a	Drawing commands
-> PDF a

Draw on a given page

createPDFXForm Source #

Arguments

:: PDFFloat	Left
-> PDFFloat	Bottom
-> PDFFloat	Right
-> PDFFloat	Top
-> Draw a	Drawing commands
-> PDF (PDFReference PDFXForm)

Create a PDF XObject

Page transitions

data PDFTransition Source #

A PDF Transition

Constructors

PDFTransition !PDFFloat !PDFTransStyle

Instances

Instances details

Eq PDFTransition Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFTransition -> PDFTransition -> Bool # (/=) :: PDFTransition -> PDFTransition -> Bool #

data PDFTransStyle Source #

Transition style

Constructors

Split PDFTransDimension PDFTransDirection
Blinds PDFTransDimension
Box PDFTransDirection
Wipe PDFTransDirection2
Dissolve
Glitter PDFTransDirection2

Instances

Instances details

Show PDFTransStyle Source #
Instance details Defined in Graphics.PDF.Draw Methods showsPrec :: Int -> PDFTransStyle -> ShowS # show :: PDFTransStyle -> String # showList :: [PDFTransStyle] -> ShowS #
Eq PDFTransStyle Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFTransStyle -> PDFTransStyle -> Bool # (/=) :: PDFTransStyle -> PDFTransStyle -> Bool #

data PDFTransDirection Source #

Direction of a transition

Constructors

Inward
Outward

Instances

Instances details

Show PDFTransDirection Source #
Instance details Defined in Graphics.PDF.Draw Methods showsPrec :: Int -> PDFTransDirection -> ShowS # show :: PDFTransDirection -> String # showList :: [PDFTransDirection] -> ShowS #
Eq PDFTransDirection Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFTransDirection -> PDFTransDirection -> Bool # (/=) :: PDFTransDirection -> PDFTransDirection -> Bool #

data PDFTransDimension Source #

Dimension of a transition

Constructors

Horizontal
Vertical

Instances

Instances details

Show PDFTransDimension Source #
Instance details Defined in Graphics.PDF.Draw Methods showsPrec :: Int -> PDFTransDimension -> ShowS # show :: PDFTransDimension -> String # showList :: [PDFTransDimension] -> ShowS #
Eq PDFTransDimension Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFTransDimension -> PDFTransDimension -> Bool # (/=) :: PDFTransDimension -> PDFTransDimension -> Bool #

data PDFTransDirection2 Source #

Direction of a transition

Constructors

LeftToRight
BottomToTop	Wipe only
RightToLeft	Wipe only
TopToBottom
TopLeftToBottomRight	Glitter only

Instances

Instances details

Eq PDFTransDirection2 Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFTransDirection2 -> PDFTransDirection2 -> Bool # (/=) :: PDFTransDirection2 -> PDFTransDirection2 -> Bool #

Document information

data PDFDocumentInfo Source #

Document metadata

Constructors

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

data PDFDocumentPageMode Source #

Document page mode

Constructors

UseNone
UseOutlines
UseThumbs
FullScreen

Instances

Instances details

Show PDFDocumentPageMode Source #
Instance details Defined in Graphics.PDF.Draw Methods showsPrec :: Int -> PDFDocumentPageMode -> ShowS # show :: PDFDocumentPageMode -> String # showList :: [PDFDocumentPageMode] -> ShowS #
Eq PDFDocumentPageMode Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFDocumentPageMode -> PDFDocumentPageMode -> Bool # (/=) :: PDFDocumentPageMode -> PDFDocumentPageMode -> Bool #

data PDFDocumentPageLayout Source #

Document page layout

Constructors

SinglePage
OneColumn
TwoColumnLeft
TwoColumnRight
TwoPageLeft
TwoPageRight

Instances

Instances details

Show PDFDocumentPageLayout Source #
Instance details Defined in Graphics.PDF.Draw Methods showsPrec :: Int -> PDFDocumentPageLayout -> ShowS # show :: PDFDocumentPageLayout -> String # showList :: [PDFDocumentPageLayout] -> ShowS #
Eq PDFDocumentPageLayout Source #
Instance details Defined in Graphics.PDF.Draw Methods (==) :: PDFDocumentPageLayout -> PDFDocumentPageLayout -> Bool # (/=) :: PDFDocumentPageLayout -> PDFDocumentPageLayout -> Bool #

data PDFViewerPreferences Source #

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 Source #

No information for the document

standardViewerPrefs :: PDFViewerPreferences Source #

Draw monad and drawing functions

Types

data Draw a Source #

The drawing monad

Instances

Instances details

PDFGlobals Draw Source #
Instance details Defined in Graphics.PDF.Draw Methods bounds :: PDFXObject a => PDFReference a -> Draw (PDFFloat, PDFFloat) Source #
Applicative Draw Source #
Instance details 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 Source #
Instance details Defined in Graphics.PDF.Draw Methods fmap :: (a -> b) -> Draw a -> Draw b # (<$) :: a -> Draw b -> Draw a #
Monad Draw Source #
Instance details 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 Source #
Instance details 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 Source #

A PDF Xobject which can be drawn

Minimal complete definition

Nothing

Methods

drawXObject :: PDFReference a -> Draw () Source #

Instances

Instances details

PDFXObject PDFXForm Source #
Instance details Defined in Graphics.PDF.Draw Methods drawXObject :: PDFReference PDFXForm -> Draw () Source # privateDrawXObject :: PDFReference PDFXForm -> Draw ()
PDFXObject PDFJpeg Source #
Instance details Defined in Graphics.PDF.Image Methods drawXObject :: PDFReference PDFJpeg -> Draw () Source # privateDrawXObject :: PDFReference PDFJpeg -> Draw ()
PDFXObject RawImage Source #
Instance details Defined in Graphics.PDF.Image Methods drawXObject :: PDFReference RawImage -> Draw () Source # privateDrawXObject :: PDFReference RawImage -> Draw ()

class PDFGlobals m where Source #

Methods

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

Instances

Instances details

PDFGlobals Draw Source #
Instance details Defined in Graphics.PDF.Draw Methods bounds :: PDFXObject a => PDFReference a -> Draw (PDFFloat, PDFFloat) Source #
PDFGlobals PDF Source #
Instance details Defined in Graphics.PDF.Draw Methods bounds :: PDFXObject a => PDFReference a -> PDF (PDFFloat, PDFFloat) Source #

General drawing functions

withNewContext :: Draw a -> Draw a Source #

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

emptyDrawing :: Draw () Source #

An empty drawing