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

Ipe.IpeToIpe

Description

Use ipetoipe to generate pdf files.

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

Synopsis

ipeToIpeWith :: Options -> FileType -> OsPath -> OsPath -> IO ()
ipeToIpe :: FileType -> OsPath -> OsPath -> IO ()
writeIpeFileAsPdf :: IpeWriteText r => OsPath -> IpeFile r -> IO ()
data FileType
- = PDF
- | XML
data Export
- = RetainIpeInfo
- | Export
type PageNumber = Int
type ViewNumber = Int
data MarkedView
- = All
- | OnlyMarkedViews
data NoZip
- = NoZip
- | Zip
data PageRange
- = EntireFile
- | PageRange (ClosedInterval PageNumber)
data Options = Options {
- export :: Export
- pages :: PageRange
- singleView :: Maybe (PageNumber, ViewNumber)
- markedView :: MarkedView
- runLatex :: Bool
- nozip :: NoZip
}
defaultOptions :: Options

Documentation

ipeToIpeWith Source #

Arguments

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

Call ipetoipe to produce an image of the specified type.

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

Call ipetoipe with the default options.

writeIpeFileAsPdf :: IpeWriteText r => OsPath -> IpeFile r -> IO () Source #

Write an ipe file to disk as an ipe readable pdf file.

Note that like all other functions in this module, this requires ipetoipe to be installed (it is bundled with ipe) and available on the path.

Note this will write soem intermediate file to your system temp dir.

data FileType Source #

Constructors

PDF
XML

Instances

Instances details

Finitary FileType Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Cardinality FileType
Instance details Defined in Ipe.IpeToIpe 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.IpeToIpe

Associated Types

type Rep FileType
Instance details Defined in Ipe.IpeToIpe type Rep FileType = D1 ('MetaData "FileType" "Ipe.IpeToIpe" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "PDF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "XML" '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.IpeToIpe

Methods

showsPrec :: Int -> FileType -> ShowS Source #

show :: FileType -> String Source #

showList :: [FileType] -> ShowS Source #

Eq FileType Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

(==) :: FileType -> FileType -> Bool Source #

(/=) :: FileType -> FileType -> Bool Source #

type Cardinality FileType Source #

Instance details

Defined in Ipe.IpeToIpe

type Cardinality FileType = GCardinality (Rep FileType)

type Rep FileType Source #

Instance details

Defined in Ipe.IpeToIpe

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

data Export Source #

Constructors

RetainIpeInfo
Export

Instances

Instances details

Finitary Export Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Cardinality Export
Instance details Defined in Ipe.IpeToIpe type Cardinality Export = GCardinality (Rep Export)

Methods

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

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

start :: Export Source #

end :: Export Source #

previous :: Export -> Maybe Export Source #

next :: Export -> Maybe Export Source #

Generic Export Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Rep Export
Instance details Defined in Ipe.IpeToIpe type Rep Export = D1 ('MetaData "Export" "Ipe.IpeToIpe" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "RetainIpeInfo" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Export" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Export -> Rep Export x Source #

to :: Rep Export x -> Export Source #

Show Export Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

showsPrec :: Int -> Export -> ShowS Source #

show :: Export -> String Source #

showList :: [Export] -> ShowS Source #

Eq Export Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

(==) :: Export -> Export -> Bool Source #

(/=) :: Export -> Export -> Bool Source #

type Cardinality Export Source #

Instance details

Defined in Ipe.IpeToIpe

type Cardinality Export = GCardinality (Rep Export)

type Rep Export Source #

Instance details

Defined in Ipe.IpeToIpe

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

type PageNumber = Int Source #

type ViewNumber = Int Source #

data MarkedView Source #

Constructors

All
OnlyMarkedViews

Instances

Instances details

Finitary MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Cardinality MarkedView
Instance details Defined in Ipe.IpeToIpe type Cardinality MarkedView = GCardinality (Rep MarkedView)

Methods

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

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

start :: MarkedView Source #

end :: MarkedView Source #

previous :: MarkedView -> Maybe MarkedView Source #

next :: MarkedView -> Maybe MarkedView Source #

Generic MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Rep MarkedView
Instance details Defined in Ipe.IpeToIpe type Rep MarkedView = D1 ('MetaData "MarkedView" "Ipe.IpeToIpe" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "All" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnlyMarkedViews" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: MarkedView -> Rep MarkedView x Source #

to :: Rep MarkedView x -> MarkedView Source #

Show MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

showsPrec :: Int -> MarkedView -> ShowS Source #

show :: MarkedView -> String Source #

showList :: [MarkedView] -> ShowS Source #

Eq MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

(==) :: MarkedView -> MarkedView -> Bool Source #

(/=) :: MarkedView -> MarkedView -> Bool Source #

type Cardinality MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

type Cardinality MarkedView = GCardinality (Rep MarkedView)

type Rep MarkedView Source #

Instance details

Defined in Ipe.IpeToIpe

type Rep MarkedView = D1 ('MetaData "MarkedView" "Ipe.IpeToIpe" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "All" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OnlyMarkedViews" 'PrefixI 'False) (U1 :: Type -> Type))

data NoZip Source #

Constructors

NoZip
Zip

Instances

Instances details

Finitary NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Cardinality NoZip
Instance details Defined in Ipe.IpeToIpe type Cardinality NoZip = GCardinality (Rep NoZip)

Methods

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

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

start :: NoZip Source #

end :: NoZip Source #

previous :: NoZip -> Maybe NoZip Source #

next :: NoZip -> Maybe NoZip Source #

Generic NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

Associated Types

type Rep NoZip
Instance details Defined in Ipe.IpeToIpe type Rep NoZip = D1 ('MetaData "NoZip" "Ipe.IpeToIpe" "hgeometry-ipe-1.0.0.0-inplace" 'False) (C1 ('MetaCons "NoZip" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Zip" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: NoZip -> Rep NoZip x Source #

to :: Rep NoZip x -> NoZip Source #

Show NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

showsPrec :: Int -> NoZip -> ShowS Source #

show :: NoZip -> String Source #

showList :: [NoZip] -> ShowS Source #

Eq NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

Methods

(==) :: NoZip -> NoZip -> Bool Source #

(/=) :: NoZip -> NoZip -> Bool Source #

type Cardinality NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

type Cardinality NoZip = GCardinality (Rep NoZip)

type Rep NoZip Source #

Instance details

Defined in Ipe.IpeToIpe

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

data PageRange Source #

Constructors

EntireFile
PageRange (ClosedInterval PageNumber)

Instances

Instances details

Show PageRange Source #
Instance details Defined in Ipe.IpeToIpe Methods showsPrec :: Int -> PageRange -> ShowS Source # show :: PageRange -> String Source # showList :: [PageRange] -> ShowS Source #
Eq PageRange Source #
Instance details Defined in Ipe.IpeToIpe Methods (==) :: PageRange -> PageRange -> Bool Source # (/=) :: PageRange -> PageRange -> Bool Source #

data Options Source #

Constructors

Options
Fields export :: Export pages :: PageRange singleView :: Maybe (PageNumber, ViewNumber) markedView :: MarkedView runLatex :: Bool nozip :: NoZip

Instances

Instances details

Show Options Source #
Instance details Defined in Ipe.IpeToIpe Methods showsPrec :: Int -> Options -> ShowS Source # show :: Options -> String Source # showList :: [Options] -> ShowS Source #
Eq Options Source #
Instance details Defined in Ipe.IpeToIpe Methods (==) :: Options -> Options -> Bool Source # (/=) :: Options -> Options -> Bool Source #

defaultOptions :: Options Source #