Copyright	(C) Frank Staals
License	see the LICENSE file
Maintainer	Frank Staals
Safe Haskell	None
Language	GHC2024

Ipe.IpeRender

Description

Use iperender to generate png, pdf, or svg files.

Note that all functions in this module require that iperender is installed (it is bundled with ipe) and available on the path.

Synopsis

ipeRenderWith :: Options -> FileType -> OsPath -> OsPath -> IO ()
ipeRender :: FileType -> OsPath -> OsPath -> IO ()
data FileType
- = PNG
- | EPS
- | PDF
- | SVG
data Options = Options {
- pageNumber :: Int
- viewNumber :: Int
- resolution :: Int
- transparent :: Background
- crop :: Crop
}
defaultOptions :: Options
data Background
- = OpaqueBackground
- | TransparentBackground
data Crop
- = NoCrop
- | Crop

Documentation

ipeRenderWith Source #

Arguments

:: Options	the options to use
-> FileType	output file type
-> OsPath	input file path
-> OsPath	output file path
-> IO ()

Call iperender to produce an image of the specified type.

note that pdf files produces with iperender cannot be opened with ipe.

ipeRender :: FileType -> OsPath -> OsPath -> IO () Source #

Call iperender with the default options.

note that pdf files produces with iperender cannot be opened with ipe.

data FileType Source #

Output filetypes supported by iperender

Constructors

PNG
EPS
PDF
SVG

Instances

Instances details

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

data Options Source #

Options for iperender

Constructors

Options
Fields pageNumber :: Int viewNumber :: Int resolution :: Int transparent :: Background crop :: Crop

Instances

Instances details

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

defaultOptions :: Options Source #

The default options in Ipe

data Background Source #

Whether or not to render a transparent background in output png images.

Constructors

OpaqueBackground
TransparentBackground

Instances

Instances details

Enum Background Source #
Instance details Defined in Ipe.IpeRender Methods succ :: Background -> Background Source # pred :: Background -> Background Source # toEnum :: Int -> Background Source # fromEnum :: Background -> Int Source # enumFrom :: Background -> [Background] Source # enumFromThen :: Background -> Background -> [Background] Source # enumFromTo :: Background -> Background -> [Background] Source # enumFromThenTo :: Background -> Background -> Background -> [Background] Source #
Read Background Source #
Instance details Defined in Ipe.IpeRender Methods readsPrec :: Int -> ReadS Background Source # readList :: ReadS [Background] Source # readPrec :: ReadPrec Background Source # readListPrec :: ReadPrec [Background] Source #
Show Background Source #
Instance details Defined in Ipe.IpeRender Methods showsPrec :: Int -> Background -> ShowS Source # show :: Background -> String Source # showList :: [Background] -> ShowS Source #
Eq Background Source #
Instance details Defined in Ipe.IpeRender Methods (==) :: Background -> Background -> Bool Source # (/=) :: Background -> Background -> Bool Source #
Ord Background Source #
Instance details Defined in Ipe.IpeRender Methods compare :: Background -> Background -> Ordering Source # (<) :: Background -> Background -> Bool Source # (<=) :: Background -> Background -> Bool Source # (>) :: Background -> Background -> Bool Source # (>=) :: Background -> Background -> Bool Source # max :: Background -> Background -> Background Source # min :: Background -> Background -> Background Source #

data Crop Source #

Whether or not to crop the output image.

Constructors

NoCrop
Crop

Instances

Instances details

Enum Crop Source #
Instance details Defined in Ipe.IpeRender Methods succ :: Crop -> Crop Source # pred :: Crop -> Crop Source # toEnum :: Int -> Crop Source # fromEnum :: Crop -> Int Source # enumFrom :: Crop -> [Crop] Source # enumFromThen :: Crop -> Crop -> [Crop] Source # enumFromTo :: Crop -> Crop -> [Crop] Source # enumFromThenTo :: Crop -> Crop -> Crop -> [Crop] Source #
Read Crop Source #
Instance details Defined in Ipe.IpeRender Methods readsPrec :: Int -> ReadS Crop Source # readList :: ReadS [Crop] Source # readPrec :: ReadPrec Crop Source # readListPrec :: ReadPrec [Crop] Source #
Show Crop Source #
Instance details Defined in Ipe.IpeRender Methods showsPrec :: Int -> Crop -> ShowS Source # show :: Crop -> String Source # showList :: [Crop] -> ShowS Source #
Eq Crop Source #
Instance details Defined in Ipe.IpeRender Methods (==) :: Crop -> Crop -> Bool Source # (/=) :: Crop -> Crop -> Bool Source #
Ord Crop Source #
Instance details Defined in Ipe.IpeRender Methods compare :: Crop -> Crop -> Ordering Source # (<) :: Crop -> Crop -> Bool Source # (<=) :: Crop -> Crop -> Bool Source # (>) :: Crop -> Crop -> Bool Source # (>=) :: Crop -> Crop -> Bool Source # max :: Crop -> Crop -> Crop Source # min :: Crop -> Crop -> Crop Source #