HPDF-1.1: Generation of PDF documents Contents Index

Graphics.PDF.Document Portability portable Stability experimental Maintainer misc@NOSPAMalpheccar.org

Contents Document actions Special document objects Page management Page transitions Document information 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 :: PDFString subject :: PDFString 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 () bounds :: PDFReference a -> Draw (PDFFloat, PDFFloat) withNewContext :: Draw a -> Draw a emptyDrawing :: Draw ()

Document actions

Special document objects

data PDFXForm

Instances PDFXObject PDFXForm PdfObject PDFXForm PdfResourceObject (PDFReference PDFXForm)

Page management

addPage

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

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

:: PDFReference PDFPage Page -> Draw a Drawing commands -> PDF a Draw on a given page

createPDFXForm

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

Page transitions

data PDFTransition

A PDF Transition Constructors PDFTransition !PDFFloat !PDFTransStyle Instances Eq PDFTransition PdfObject PDFTransition

data PDFTransStyle

Transition style Constructors Split PDFTransDimension PDFTransDirection Blinds PDFTransDimension Box PDFTransDirection Wipe PDFTransDirection2 Dissolve Glitter PDFTransDirection2 Instances Eq PDFTransStyle Show PDFTransStyle

data PDFTransDirection

Direction of a transition Constructors Inward Outward Instances Eq PDFTransDirection Show PDFTransDirection

data PDFTransDimension

Dimension of a transition Constructors Horizontal Vertical Instances Eq PDFTransDimension Show PDFTransDimension

data PDFTransDirection2

Direction of a transition Constructors LeftToRight BottomToTop Wipe only RightToLeft Wipe only TopToBottom TopLeftToBottomRight Glitter only Instances Eq PDFTransDirection2

Document information

data PDFDocumentInfo

Document metadata Constructors PDFDocumentInfo author :: PDFString subject :: PDFString pageMode :: PDFDocumentPageMode pageLayout :: PDFDocumentPageLayout viewerPreferences :: PDFViewerPreferences compressed :: Bool

data PDFDocumentPageMode

Document page mode Constructors UseNone UseOutlines UseThumbs FullScreen Instances Eq PDFDocumentPageMode Show PDFDocumentPageMode

data PDFDocumentPageLayout

Document page layout Constructors SinglePage OneColumn TwoColumnLeft TwoColumnRight TwoPageLeft TwoPageRight Instances Eq PDFDocumentPageLayout Show PDFDocumentPageLayout

data PDFViewerPreferences

Viewer preferences Constructors PDFViewerPreferences 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 Instances PdfObject PDFViewerPreferences

standardDocInfo :: PDFDocumentInfo

No information for the document

standardViewerPrefs :: PDFViewerPreferences

Draw monad and drawing functions

Types

data Draw a

The drawing monad Instances Functor Draw Monad Draw MonadPath Draw MonadReader DrawEnvironment Draw MonadState DrawState Draw MonadWriter Builder Draw

class PDFXObject a where

A PDF Xobject which can be drawn Methods drawXObject :: PDFReference a -> Draw () bounds :: PDFReference a -> Draw (PDFFloat, PDFFloat) Instances PDFXObject AnyPdfXForm PDFXObject PDFJpeg PDFXObject PDFXForm

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

Produced by Haddock version 0.8