Safe Haskell	None
Language	Haskell2010

Graphics.Svg.CssTypes

Description

Define the types used to describes CSS elements

Synopsis

data CssSelector
- = Nearby
- | DirectChildren
- | AllOf [CssDescriptor]
type CssSelectorRule = [CssSelector]
data CssRule = CssRule {
- cssRuleSelector :: ![CssSelectorRule]
- cssDeclarations :: ![CssDeclaration]
}
data CssDescriptor
- = OfClass Text
- | OfName Text
- | OfId Text
- | OfPseudoClass Text
- | AnyElem
- | WithAttrib Text Text
data CssDeclaration = CssDeclaration {
- _cssDeclarationProperty :: Text
- _cssDecarationlValues :: [[CssElement]]
}
data CssElement
- = CssIdent !Text
- | CssString !Text
- | CssReference !Text
- | CssNumber !Number
- | CssColor !PixelRGBA8
- | CssFunction !Text ![CssElement]
- | CssOpComa
- | CssOpSlash
class CssMatcheable a where
- cssIdOf :: a -> Maybe Text
- cssClassOf :: a -> [Text]
- cssNameOf :: a -> Text
- cssAttribOf :: a -> Text -> Maybe Text
type CssContext a = [[a]]
type Dpi = Int
data Number
- = Num Double
- | Px Double
- | Em Double
- | Percent Double
- | Pc Double
- | Mm Double
- | Cm Double
- | Point Double
- | Inches Double
serializeNumber :: Number -> String
findMatchingDeclarations :: CssMatcheable a => [CssRule] -> CssContext a -> [CssDeclaration]
toUserUnit :: Dpi -> Number -> Number
mapNumber :: (Double -> Double) -> Number -> Number
tserialize :: TextBuildable a => a -> Builder

Documentation

data CssSelector #

Define complex selector.

Constructors

Nearby	Correspond to the `+` CSS selector.
DirectChildren	Correspond to the `>` CSS selectro.
AllOf [CssDescriptor]	Grouping construct, all the elements of the list must be matched.

Instances

Eq CssSelector #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: CssSelector -> CssSelector -> Bool # (/=) :: CssSelector -> CssSelector -> Bool #
Show CssSelector #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> CssSelector -> ShowS # show :: CssSelector -> String # showList :: [CssSelector] -> ShowS #

type CssSelectorRule = [CssSelector] #

A CssSelectorRule is a list of all the elements that must be meet in a depth first search fashion.

data CssRule #

Represent a CSS selector and the different declarations to apply to the matched elemens.

Constructors

CssRule
Fields cssRuleSelector :: ![CssSelectorRule] At the first level represent a list of elements to be matched. If any match is made, you can apply the declarations. At the second level cssDeclarations :: ![CssDeclaration] Declarations to apply to the matched element.

Instances

Eq CssRule #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: CssRule -> CssRule -> Bool # (/=) :: CssRule -> CssRule -> Bool #
Show CssRule #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> CssRule -> ShowS # show :: CssRule -> String # showList :: [CssRule] -> ShowS #

data CssDescriptor #

Describe an element of a CSS selector. Multiple elements can be combined in a CssSelector type.

Constructors

OfClass Text	.IDENT
OfName Text	IDENT
OfId Text	#IDENT
OfPseudoClass Text	`:IDENT` (ignore function syntax)
AnyElem	`*`
WithAttrib Text Text	``

Instances

Eq CssDescriptor #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: CssDescriptor -> CssDescriptor -> Bool # (/=) :: CssDescriptor -> CssDescriptor -> Bool #
Show CssDescriptor #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> CssDescriptor -> ShowS # show :: CssDescriptor -> String # showList :: [CssDescriptor] -> ShowS #

data CssDeclaration #

Represent the content to apply to some CSS matched rules.

Constructors

CssDeclaration
Fields _cssDeclarationProperty :: Text Property name to change (like font-family or color). _cssDecarationlValues :: [[CssElement]] List of values

Instances

Eq CssDeclaration #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: CssDeclaration -> CssDeclaration -> Bool # (/=) :: CssDeclaration -> CssDeclaration -> Bool #
Show CssDeclaration #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> CssDeclaration -> ShowS # show :: CssDeclaration -> String # showList :: [CssDeclaration] -> ShowS #

data CssElement #

Value of a CSS property.

Constructors

CssIdent !Text
CssString !Text
CssReference !Text
CssNumber !Number
CssColor !PixelRGBA8
CssFunction !Text ![CssElement]
CssOpComa
CssOpSlash

Instances

Eq CssElement #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: CssElement -> CssElement -> Bool # (/=) :: CssElement -> CssElement -> Bool #
Show CssElement #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> CssElement -> ShowS # show :: CssElement -> String # showList :: [CssElement] -> ShowS #

class CssMatcheable a where #

Interface for elements to be matched against some CssRule.

Methods

cssIdOf :: a -> Maybe Text #

For an element, tell its optional ID attribute.

cssClassOf :: a -> [Text] #

For an element, return all of it's class attributes.

cssNameOf :: a -> Text #

Return the name of the tagname of the element

cssAttribOf :: a -> Text -> Maybe Text #

Return a value of a given attribute if present

Instances

CssMatcheable Tree #
Instance details Defined in Graphics.Svg.Types Methods cssIdOf :: Tree -> Maybe Text # cssClassOf :: Tree -> [Text] # cssNameOf :: Tree -> Text # cssAttribOf :: Tree -> Text -> Maybe Text #

type CssContext a = [[a]] #

Represent a zipper in depth at the first list level, and the previous nodes at in the second list level.

type Dpi = Int #

Alias describing a "dot per inch" information used for size calculation (see toUserUnit).

data Number #

Encode complex number possibly dependant to the current render size.

Constructors

Num Double	Simple coordinate in current user coordinate.
Px Double	With suffix "px"
Em Double	Number relative to the current font size.
Percent Double	Number relative to the current viewport size.
Pc Double
Mm Double	Number in millimeters, relative to DPI.
Cm Double	Number in centimeters, relative to DPI.
Point Double	Number in points, relative to DPI.
Inches Double	Number in inches, relative to DPI.

Instances

Eq Number #
Instance details Defined in Graphics.Svg.CssTypes Methods (==) :: Number -> Number -> Bool # (/=) :: Number -> Number -> Bool #
Show Number #
Instance details Defined in Graphics.Svg.CssTypes Methods showsPrec :: Int -> Number -> ShowS # show :: Number -> String # showList :: [Number] -> ShowS #

serializeNumber :: Number -> String #

Encode the number to string which can be used in a CSS or a svg attributes.

findMatchingDeclarations :: CssMatcheable a => [CssRule] -> CssContext a -> [CssDeclaration] #

Given CSS rules, find all the declaration to apply to the element in a given context.

toUserUnit :: Dpi -> Number -> Number #

This function replace all device dependant units to user units given it's DPI configuration. Preserve percentage and "em" notation.

mapNumber :: (Double -> Double) -> Number -> Number #

Helper function to modify inner value of a number

tserialize :: TextBuildable a => a -> Builder #

Serialize an element to a text builder.