hgeometry-ipe
Copyright(C) Frank Staals
Licensesee the LICENSE file
MaintainerFrank Staals
Safe HaskellNone
LanguageGHC2024

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

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
Finitary FileType Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Cardinality FileType 
Instance details

Defined in Ipe.IpeRender

type Cardinality FileType = GCardinality (Rep FileType)

Methods

fromFinite :: Finite (Cardinality FileType) -> FileType Source #

toFinite :: FileType -> Finite (Cardinality FileType) Source #

start :: FileType Source #

end :: FileType Source #

previous :: FileType -> Maybe FileType Source #

next :: FileType -> Maybe FileType Source #

Generic FileType Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Rep FileType 
Instance details

Defined in Ipe.IpeRender

type Rep FileType = D1 ('MetaData "FileType" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) ((C1 ('MetaCons "PNG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EPS" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PDF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SVG" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: FileType -> Rep FileType x Source #

to :: Rep FileType x -> 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 #

type Cardinality FileType Source # 
Instance details

Defined in Ipe.IpeRender

type Cardinality FileType = GCardinality (Rep FileType)
type Rep FileType Source # 
Instance details

Defined in Ipe.IpeRender

type Rep FileType = D1 ('MetaData "FileType" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) ((C1 ('MetaCons "PNG" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EPS" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PDF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SVG" 'PrefixI 'False) (U1 :: Type -> Type)))

data Options Source #

Options for iperender

Constructors

Options 

Fields

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
Finitary Background Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Cardinality Background 
Instance details

Defined in Ipe.IpeRender

type Cardinality Background = GCardinality (Rep Background)

Methods

fromFinite :: Finite (Cardinality Background) -> Background Source #

toFinite :: Background -> Finite (Cardinality Background) Source #

start :: Background Source #

end :: Background Source #

previous :: Background -> Maybe Background Source #

next :: Background -> Maybe Background Source #

Generic Background Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Rep Background 
Instance details

Defined in Ipe.IpeRender

type Rep Background = D1 ('MetaData "Background" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "OpaqueBackground" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TransparentBackground" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Background -> Rep Background x Source #

to :: Rep Background x -> 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 #

type Cardinality Background Source # 
Instance details

Defined in Ipe.IpeRender

type Cardinality Background = GCardinality (Rep Background)
type Rep Background Source # 
Instance details

Defined in Ipe.IpeRender

type Rep Background = D1 ('MetaData "Background" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "OpaqueBackground" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TransparentBackground" 'PrefixI 'False) (U1 :: Type -> Type))

data Crop Source #

Whether or not to crop the output image.

Constructors

NoCrop 
Crop 

Instances

Instances details
Finitary Crop Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Cardinality Crop 
Instance details

Defined in Ipe.IpeRender

type Cardinality Crop = GCardinality (Rep Crop)

Methods

fromFinite :: Finite (Cardinality Crop) -> Crop Source #

toFinite :: Crop -> Finite (Cardinality Crop) Source #

start :: Crop Source #

end :: Crop Source #

previous :: Crop -> Maybe Crop Source #

next :: Crop -> Maybe Crop Source #

Generic Crop Source # 
Instance details

Defined in Ipe.IpeRender

Associated Types

type Rep Crop 
Instance details

Defined in Ipe.IpeRender

type Rep Crop = D1 ('MetaData "Crop" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "NoCrop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Crop" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Crop -> Rep Crop x Source #

to :: Rep Crop x -> 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 #

type Cardinality Crop Source # 
Instance details

Defined in Ipe.IpeRender

type Cardinality Crop = GCardinality (Rep Crop)
type Rep Crop Source # 
Instance details

Defined in Ipe.IpeRender

type Rep Crop = D1 ('MetaData "Crop" "Ipe.IpeRender" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "NoCrop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Crop" 'PrefixI 'False) (U1 :: Type -> Type))