| Portability | portable |
|---|---|
| Stability | experimental |
| Maintainer | misc@NOSPAMalpheccar.org |
| Safe Haskell | None |
Graphics.PDF.Document
Contents
Description
Management of the PDF structure
- 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
- data PDFTransDirection
- data PDFTransDimension
- = Horizontal
- | Vertical
- data PDFTransDirection2
- data PDFDocumentInfo = PDFDocumentInfo {}
- data PDFDocumentPageMode
- = UseNone
- | UseOutlines
- | UseThumbs
- | FullScreen
- data PDFDocumentPageLayout
- data PDFViewerPreferences = PDFViewerPreferences {}
- 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
Instances
| PdfObject PDFXForm | |
| PDFXObject PDFXForm | |
| PdfResourceObject (PDFReference PDFXForm) |
Page management
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
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 |
Arguments
| :: PDFReference PDFPage | Page |
| -> Draw a | Drawing commands |
| -> PDF a |
Draw on a given page
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
| Eq PDFTransition | |
| PdfObject PDFTransition |
data PDFTransStyle Source
Transition style
Constructors
| Split PDFTransDimension PDFTransDirection | |
| Blinds PDFTransDimension | |
| Box PDFTransDirection | |
| Wipe PDFTransDirection2 | |
| Dissolve | |
| Glitter PDFTransDirection2 |
Instances
data PDFTransDirection2 Source
Direction of a transition
Constructors
| LeftToRight | |
| BottomToTop | Wipe only |
| RightToLeft | Wipe only |
| TopToBottom | |
| TopLeftToBottomRight | Glitter only |
Instances
Document information
data PDFDocumentPageMode Source
Document page mode
Constructors
| UseNone | |
| UseOutlines | |
| UseThumbs | |
| FullScreen |
Instances
data PDFViewerPreferences Source
Viewer preferences
Constructors
| PDFViewerPreferences | |
Fields
| |
Instances
| PdfObject PDFViewerPreferences |
standardDocInfo :: PDFDocumentInfoSource
No information for the document
Draw monad and drawing functions
Types
The drawing monad
Instances
| Monad Draw | |
| Functor Draw | |
| MonadPath Draw | |
| PDFGlobals Draw | |
| MonadReader DrawEnvironment Draw | |
| MonadState DrawState Draw | |
| MonadWriter Builder Draw |
class PDFXObject a whereSource
A PDF Xobject which can be drawn
Methods
drawXObject :: PDFReference a -> Draw ()Source
Instances
| PDFXObject PDFXForm | |
| PDFXObject AnyPdfXForm | |
| PDFXObject PDFJpeg |
class PDFGlobals m whereSource
Methods
bounds :: PDFXObject a => PDFReference a -> m (PDFFloat, PDFFloat)Source
Instances
General drawing functions
withNewContext :: Draw a -> Draw aSource
Draw in a new drawing context without perturbing the previous context that is restored after the draw
emptyDrawing :: Draw ()Source
An empty drawing