Safe Haskell	None
Language	Haskell2010

Yesod.Content.PDF

Contents

Conversion
Data type
Options

Description

Utilities for serving PDF from Yesod. Uses and depends on command line utility wkhtmltopdf to render PDF from HTML.

Synopsis

uri2PDF :: MonadIO m => WkhtmltopdfOptions -> URI -> m PDF
html2PDF :: MonadIO m => WkhtmltopdfOptions -> Html -> m PDF
newtype PDF = PDF {
- pdfBytes :: ByteString
}
typePDF :: ContentType
def :: Default a => a
data WkhtmltopdfOptions
wkCollate :: WkhtmltopdfOptions -> Bool
wkCopies :: WkhtmltopdfOptions -> Int
wkGrayscale :: WkhtmltopdfOptions -> Bool
wkLowQuality :: WkhtmltopdfOptions -> Bool
wkPageSize :: WkhtmltopdfOptions -> PageSize
wkOrientation :: WkhtmltopdfOptions -> Orientation
wkDisableSmartShrinking :: WkhtmltopdfOptions -> Bool
wkTitle :: WkhtmltopdfOptions -> Maybe String
wkMarginBottom :: WkhtmltopdfOptions -> UnitReal
wkMarginLeft :: WkhtmltopdfOptions -> UnitReal
wkMarginRight :: WkhtmltopdfOptions -> UnitReal
wkMarginTop :: WkhtmltopdfOptions -> UnitReal
wkZoom :: WkhtmltopdfOptions -> Double
wkJavascriptDelay :: WkhtmltopdfOptions -> Maybe Int
wkWindowStatus :: WkhtmltopdfOptions -> Maybe String
data PageSize
- = A4
- | Letter
- | OtherPageSize String
- | CustomPageSize UnitReal UnitReal
data Orientation
- = Portrait
- | Landscape
data UnitReal
- = Mm Double
- | Cm Double
- | OtherUnitReal String

Conversion

uri2PDF :: MonadIO m => WkhtmltopdfOptions -> URI -> m PDF Source #

Use wkhtmltopdf to render a PDF given the URI pointing to an HTML document.

html2PDF :: MonadIO m => WkhtmltopdfOptions -> Html -> m PDF Source #

Use wkhtmltopdf to render a PDF from an HTML (Text.Blaze.Html) type.

Data type

newtype PDF Source #

Constructors

PDF
Fields pdfBytes :: ByteString

Instances

Eq PDF Source #
Instance details Defined in Yesod.Content.PDF Methods (==) :: PDF -> PDF -> Bool # (/=) :: PDF -> PDF -> Bool #
Ord PDF Source #
Instance details Defined in Yesod.Content.PDF Methods compare :: PDF -> PDF -> Ordering # (<) :: PDF -> PDF -> Bool # (<=) :: PDF -> PDF -> Bool # (>) :: PDF -> PDF -> Bool # (>=) :: PDF -> PDF -> Bool # max :: PDF -> PDF -> PDF # min :: PDF -> PDF -> PDF #
Read PDF Source #
Instance details Defined in Yesod.Content.PDF Methods readsPrec :: Int -> ReadS PDF # readList :: ReadS [PDF] # readPrec :: ReadPrec PDF # readListPrec :: ReadPrec [PDF] #
Show PDF Source #
Instance details Defined in Yesod.Content.PDF Methods showsPrec :: Int -> PDF -> ShowS # show :: PDF -> String # showList :: [PDF] -> ShowS #
ToContent PDF Source #
Instance details Defined in Yesod.Content.PDF Methods toContent :: PDF -> Content #
HasContentType PDF Source #
Instance details Defined in Yesod.Content.PDF Methods getContentType :: Monad m => m PDF -> ContentType #
ToTypedContent PDF Source #
Instance details Defined in Yesod.Content.PDF Methods toTypedContent :: PDF -> TypedContent #

typePDF :: ContentType Source #

Provide MIME type "application/pdf" as a ContentType for Yesod.

Options

def :: Default a => a #

The default value for this type.

data WkhtmltopdfOptions Source #

Options passed to wkhtmltopdf. Please use the def value and then modify individual settings. For more information, see http://www.yesodweb.com/book/settings-types.

Instances

Eq WkhtmltopdfOptions Source #
Instance details Defined in Yesod.Content.PDF Methods (==) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool # (/=) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool #
Ord WkhtmltopdfOptions Source #
Instance details Defined in Yesod.Content.PDF Methods compare :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Ordering # (<) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool # (<=) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool # (>) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool # (>=) :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> Bool # max :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> WkhtmltopdfOptions # min :: WkhtmltopdfOptions -> WkhtmltopdfOptions -> WkhtmltopdfOptions #
Show WkhtmltopdfOptions Source #
Instance details Defined in Yesod.Content.PDF Methods showsPrec :: Int -> WkhtmltopdfOptions -> ShowS # show :: WkhtmltopdfOptions -> String # showList :: [WkhtmltopdfOptions] -> ShowS #
Default WkhtmltopdfOptions Source #
Instance details Defined in Yesod.Content.PDF Methods def :: WkhtmltopdfOptions #

wkCollate :: WkhtmltopdfOptions -> Bool Source #

Collate when printing multiple copies.

wkCopies :: WkhtmltopdfOptions -> Int Source #

Number of copies to print into the PDF file.

wkGrayscale :: WkhtmltopdfOptions -> Bool Source #

Whether output PDF should be in grayscale.

wkLowQuality :: WkhtmltopdfOptions -> Bool Source #

Generate lower quality output to conserve space.

wkPageSize :: WkhtmltopdfOptions -> PageSize Source #

Page size (e.g. A4, Letter).

wkOrientation :: WkhtmltopdfOptions -> Orientation Source #

Orientation of the output.

wkDisableSmartShrinking :: WkhtmltopdfOptions -> Bool Source #

Intelligent shrinking strategy used by WebKit that makes the pixel/dpi ratio none constant.

wkTitle :: WkhtmltopdfOptions -> Maybe String Source #

Title of the generated PDF file.

wkMarginBottom :: WkhtmltopdfOptions -> UnitReal Source #

Bottom margin size.

wkMarginLeft :: WkhtmltopdfOptions -> UnitReal Source #

Left margin size.

wkMarginRight :: WkhtmltopdfOptions -> UnitReal Source #

Right margin size.

wkMarginTop :: WkhtmltopdfOptions -> UnitReal Source #

Top margin size.

wkZoom :: WkhtmltopdfOptions -> Double Source #

Zoom factor.

wkJavascriptDelay :: WkhtmltopdfOptions -> Maybe Int Source #

Time to wait for Javascript to finish in milliseconds.

wkWindowStatus :: WkhtmltopdfOptions -> Maybe String Source #

String to wait for window.status to be set to.

data PageSize Source #

Cf. wkPageSize.

Constructors

A4
Letter
OtherPageSize String	http://doc.qt.io/qt-4.8/qprinter.html#PaperSize-enum.
CustomPageSize UnitReal UnitReal	Height and width.

Instances

Eq PageSize Source #
Instance details Defined in Yesod.Content.PDF Methods (==) :: PageSize -> PageSize -> Bool # (/=) :: PageSize -> PageSize -> Bool #
Ord PageSize Source #
Instance details Defined in Yesod.Content.PDF Methods compare :: PageSize -> PageSize -> Ordering # (<) :: PageSize -> PageSize -> Bool # (<=) :: PageSize -> PageSize -> Bool # (>) :: PageSize -> PageSize -> Bool # (>=) :: PageSize -> PageSize -> Bool # max :: PageSize -> PageSize -> PageSize # min :: PageSize -> PageSize -> PageSize #
Show PageSize Source #
Instance details Defined in Yesod.Content.PDF Methods showsPrec :: Int -> PageSize -> ShowS # show :: PageSize -> String # showList :: [PageSize] -> ShowS #

data Orientation Source #

Cf. wkOrientation.

Constructors

Portrait
Landscape

Instances

Bounded Orientation Source #
Instance details Defined in Yesod.Content.PDF Methods minBound :: Orientation # maxBound :: Orientation #
Enum Orientation Source #
Instance details Defined in Yesod.Content.PDF Methods succ :: Orientation -> Orientation # pred :: Orientation -> Orientation # toEnum :: Int -> Orientation # fromEnum :: Orientation -> Int # enumFrom :: Orientation -> [Orientation] # enumFromThen :: Orientation -> Orientation -> [Orientation] # enumFromTo :: Orientation -> Orientation -> [Orientation] # enumFromThenTo :: Orientation -> Orientation -> Orientation -> [Orientation] #
Eq Orientation Source #
Instance details Defined in Yesod.Content.PDF Methods (==) :: Orientation -> Orientation -> Bool # (/=) :: Orientation -> Orientation -> Bool #
Ord Orientation Source #
Instance details Defined in Yesod.Content.PDF Methods compare :: Orientation -> Orientation -> Ordering # (<) :: Orientation -> Orientation -> Bool # (<=) :: Orientation -> Orientation -> Bool # (>) :: Orientation -> Orientation -> Bool # (>=) :: Orientation -> Orientation -> Bool # max :: Orientation -> Orientation -> Orientation # min :: Orientation -> Orientation -> Orientation #
Show Orientation Source #
Instance details Defined in Yesod.Content.PDF Methods showsPrec :: Int -> Orientation -> ShowS # show :: Orientation -> String # showList :: [Orientation] -> ShowS #

data UnitReal Source #

A unit of measure.

Constructors

Mm Double
Cm Double
OtherUnitReal String

Instances

Eq UnitReal Source #
Instance details Defined in Yesod.Content.PDF Methods (==) :: UnitReal -> UnitReal -> Bool # (/=) :: UnitReal -> UnitReal -> Bool #
Ord UnitReal Source #
Instance details Defined in Yesod.Content.PDF Methods compare :: UnitReal -> UnitReal -> Ordering # (<) :: UnitReal -> UnitReal -> Bool # (<=) :: UnitReal -> UnitReal -> Bool # (>) :: UnitReal -> UnitReal -> Bool # (>=) :: UnitReal -> UnitReal -> Bool # max :: UnitReal -> UnitReal -> UnitReal # min :: UnitReal -> UnitReal -> UnitReal #
Show UnitReal Source #
Instance details Defined in Yesod.Content.PDF Methods showsPrec :: Int -> UnitReal -> ShowS # show :: UnitReal -> String # showList :: [UnitReal] -> ShowS #