Safe Haskell	Safe
Language	Haskell2010

Text.LaTeX.Base.Types

Description

Some types shared along the library.

Synopsis

type ClassName = String
type PackageName = String
type PageStyle = String
data Label
createLabel :: String -> Label
labelName :: Label -> String
data Pos
- = Bottom
- | Center
- | Top
data HPos
- = HLeft
- | HCenter
- | HRight
data TableSpec
- = LeftColumn
- | CenterColumn
- | RightColumn
- | ParColumnTop LaTeX
- | ParColumnMid LaTeX
- | ParColumnBot LaTeX
- | NameColumn String
- | BeforeColumn LaTeX
- | AfterColumn LaTeX
- | VerticalLine
- | DVerticalLine
- | Separator LaTeX
data Measure
- = Pt Double
- | Mm Double
- | Cm Double
- | In Double
- | Ex Double
- | Em Double
- | CustomMeasure LaTeX

Documentation

type ClassName = String #

Class names are represented by a String.

type PackageName = String #

Package names are represented by a String.

type PageStyle = String #

Page styles are represented by a String.

data Label #

Type of labels.

Instances

Eq Label #
Instance details Defined in Text.LaTeX.Base.Types Methods (==) :: Label -> Label -> Bool # (/=) :: Label -> Label -> Bool #
Show Label #
Instance details Defined in Text.LaTeX.Base.Types Methods showsPrec :: Int -> Label -> ShowS # show :: Label -> String # showList :: [Label] -> ShowS #
IsString Label #
Instance details Defined in Text.LaTeX.Base.Types Methods fromString :: String -> Label #
Render Label #
Instance details Defined in Text.LaTeX.Base.Types Methods render :: Label -> Text #

createLabel :: String -> Label #

Create a label from its name.

labelName :: Label -> String #

Get the name of a label.

data Pos #

Vertical position.

Constructors

Bottom
Center
Top

Instances

Show Pos #
Instance details Defined in Text.LaTeX.Base.Types Methods showsPrec :: Int -> Pos -> ShowS # show :: Pos -> String # showList :: [Pos] -> ShowS #
Render Pos #
Instance details Defined in Text.LaTeX.Base.Types Methods render :: Pos -> Text #

data HPos #

Horizontal position.

Constructors

HLeft
HCenter
HRight

Instances

Show HPos #
Instance details Defined in Text.LaTeX.Base.Types Methods showsPrec :: Int -> HPos -> ShowS # show :: HPos -> String # showList :: [HPos] -> ShowS #
Render HPos #
Instance details Defined in Text.LaTeX.Base.Types Methods render :: HPos -> Text #

data TableSpec #

Type of table specifications.

Constructors

LeftColumn	Left-justified column.
CenterColumn	Centered column.
RightColumn	Right-justified column.
ParColumnTop LaTeX	Paragraph column with text vertically aligned at the top.
ParColumnMid LaTeX	Paragraph column with text vertically aligned at the middle. Requires `array` package.
ParColumnBot LaTeX	Paragraph column with text vertically aligned at the bottom. Requires `array` package.
NameColumn String	User defined column. Requires `array` package.
BeforeColumn LaTeX	Can be used before a `LeftColumn`, `CenterColumn`, `RightColumn`, `ParColumnTop`, `ParColumnMid` or a `ParColumnBot` specification. Inserts the code directly in front of the entry of the column. Requires `array` package.
AfterColumn LaTeX	Can be used after a `LeftColumn`, `CenterColumn`, `RightColumn`, `ParColumnTop`, `ParColumnMid` or a `ParColumnBot` specification. Inserts the code directly in front of the entry of the column. Requires `array` package.
VerticalLine	Vertical line between two columns.
DVerticalLine	Double vertical line between two columns.
Separator LaTeX	Column separator. Requires `array` package.

Instances

Show TableSpec #
Instance details Defined in Text.LaTeX.Base.Types Methods showsPrec :: Int -> TableSpec -> ShowS # show :: TableSpec -> String # showList :: [TableSpec] -> ShowS #
Render TableSpec #
Instance details Defined in Text.LaTeX.Base.Types Methods render :: TableSpec -> Text #

data Measure #

Measure units defined in LaTeX. Use CustomMeasure to use commands like textwidth. For instance:

rule Nothing (CustomMeasure linewidth) (Pt 2)

This will create a black box (see rule) as wide as the text and two points tall.

Constructors

Pt Double	A point is 1/72.27 inch, that means about 0.0138 inch or 0.3515 mm.
Mm Double	Millimeter.
Cm Double	Centimeter.
In Double	Inch.
Ex Double	The height of an "x" in the current font.
Em Double	The width of an "M" in the current font.
CustomMeasure LaTeX	You can introduce a `LaTeX` expression as a measure.

Instances

Eq Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Methods (==) :: Measure -> Measure -> Bool # (/=) :: Measure -> Measure -> Bool #
Data Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Measure -> c Measure # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Measure # toConstr :: Measure -> Constr # dataTypeOf :: Measure -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Measure) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Measure) # gmapT :: (forall b. Data b => b -> b) -> Measure -> Measure # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Measure -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Measure -> r # gmapQ :: (forall d. Data d => d -> u) -> Measure -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Measure -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Measure -> m Measure # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Measure -> m Measure # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Measure -> m Measure #
Show Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Methods showsPrec :: Int -> Measure -> ShowS # show :: Measure -> String # showList :: [Measure] -> ShowS #
Generic Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Associated Types type Rep Measure :: * -> * # Methods from :: Measure -> Rep Measure x # to :: Rep Measure x -> Measure #
Arbitrary Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Methods arbitrary :: Gen Measure # shrink :: Measure -> [Measure] #
Hashable Measure #
Instance details Defined in Text.LaTeX.Base.Syntax Methods hashWithSalt :: Int -> Measure -> Int # hash :: Measure -> Int #
Render Measure #
Instance details Defined in Text.LaTeX.Base.Render Methods render :: Measure -> Text #
Texy Measure #
Instance details Defined in Text.LaTeX.Base.Texy Methods texy :: LaTeXC l => Measure -> l #
type Rep Measure #
Instance details Defined in Text.LaTeX.Base.Syntax type Rep Measure = D1 (MetaData "Measure" "Text.LaTeX.Base.Syntax" "HaTeX-3.19.0.0-1voWiXp1tKKKgEwLgUmOc5" False) ((C1 (MetaCons "Pt" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) :+: (C1 (MetaCons "Mm" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) :+: C1 (MetaCons "Cm" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)))) :+: ((C1 (MetaCons "In" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) :+: C1 (MetaCons "Ex" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double))) :+: (C1 (MetaCons "Em" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Double)) :+: C1 (MetaCons "CustomMeasure" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 LaTeX)))))