Graphics.Rendering.Pango.Enums

Enumerations for describing font characteristics.

Documentation

type PangoUnit = Double

pangoScale :: Double

data Color

Color

• Specifies a color with three integer values for red, green and blue. All values range from 0 (least intense) to 65535 (highest intensity).

Constructors

Color Word16 Word16 Word16

Instances

Eq Color

Methods

(==) :: Color -> Color -> Bool

(/=) :: Color -> Color -> Bool

Show Color

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

data Rectangle

Rectangle

• Specifies x, y, width and height

Constructors

Rectangle Int Int Int Int

Instances

Eq Rectangle

Methods

(==) :: Rectangle -> Rectangle -> Bool

(/=) :: Rectangle -> Rectangle -> Bool

Show Rectangle

Methods

showsPrec :: Int -> Rectangle -> ShowS

show :: Rectangle -> String

showList :: [Rectangle] -> ShowS

data PangoRectangle

Rectangles describing an area in Doubles.

• Specifies x, y, width and height

Constructors

PangoRectangle Double Double Double Double

Instances

Show PangoRectangle

Methods

showsPrec :: Int -> PangoRectangle -> ShowS

show :: PangoRectangle -> String

showList :: [PangoRectangle] -> ShowS

Storable PangoRectangle

Methods

sizeOf :: PangoRectangle -> Int

alignment :: PangoRectangle -> Int

peekElemOff :: Ptr PangoRectangle -> Int -> IO PangoRectangle

pokeElemOff :: Ptr PangoRectangle -> Int -> PangoRectangle -> IO ()

peekByteOff :: Ptr b -> Int -> IO PangoRectangle

pokeByteOff :: Ptr b -> Int -> PangoRectangle -> IO ()

peek :: Ptr PangoRectangle -> IO PangoRectangle

poke :: Ptr PangoRectangle -> PangoRectangle -> IO ()

data FontMetrics

The characteristic measurements of a font.

• All values are measured in pixels.
• In Pango versions before 1.6 only ascent, descent, approximateCharWidth and approximateDigitWidth are available.

Constructors

FontMetrics

Fields

• ascent :: Double

  The ascent is the distance from the baseline to the logical top of a line of text. (The logical top may be above or below the top of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

• descent :: Double

  The descent is the distance from the baseline to the logical bottom of a line of text. (The logical bottom may be above or below the bottom of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

• approximateCharWidth :: Double

  The approximate character width. This is merely a representative value useful, for example, for determining the initial size for a window. Actual characters in text will be wider and narrower than this.

• approximateDigitWidth :: Double

  The approximate digit width. This is merely a representative value useful, for example, for determining the initial size for a window. Actual digits in text can be wider and narrower than this, though this value is generally somewhat more accurate than approximateCharWidth.

• underlineThickness :: Double

  The suggested thickness to draw an underline.

• underlinePosition :: Double

  The suggested position to draw the underline. The value returned is the distance above the baseline of the top of the underline. Since most fonts have underline positions beneath the baseline, this value is typically negative.

• strikethroughThickness :: Double

  The suggested thickness to draw for the strikethrough.

• strikethroughPosition :: Double

  The suggested position to draw the strikethrough. The value returned is the distance above the baseline of the top of the strikethrough.

Instances

Show FontMetrics

Methods

showsPrec :: Int -> FontMetrics -> ShowS

show :: FontMetrics -> String

showList :: [FontMetrics] -> ShowS

data Size

Define attributes for FontSize.

Constructors

SizePoint Double

SizeUnreadable

SizeTiny

SizeSmall

SizeMedium

SizeLarge

SizeHuge

SizeGiant

SizeSmaller

SizeLarger

Instances

Show Size

Methods

showsPrec :: Int -> Size -> ShowS

show :: Size -> String

showList :: [Size] -> ShowS

data FontStyle

The style of a font.

• StyleOblique is a slanted font like StyleItalic, but in a roman style.

Constructors

StyleNormal

StyleOblique

StyleItalic

Instances

Enum FontStyle

Methods

succ :: FontStyle -> FontStyle

pred :: FontStyle -> FontStyle

toEnum :: Int -> FontStyle

fromEnum :: FontStyle -> Int

enumFrom :: FontStyle -> [FontStyle]

enumFromThen :: FontStyle -> FontStyle -> [FontStyle]

enumFromTo :: FontStyle -> FontStyle -> [FontStyle]

enumFromThenTo :: FontStyle -> FontStyle -> FontStyle -> [FontStyle]

Eq FontStyle

Methods

(==) :: FontStyle -> FontStyle -> Bool

(/=) :: FontStyle -> FontStyle -> Bool

Show FontStyle

Methods

showsPrec :: Int -> FontStyle -> ShowS

show :: FontStyle -> String

showList :: [FontStyle] -> ShowS

data Weight

Define attributes for Weight.

Constructors

WeightThin

WeightUltralight

WeightLight

WeightBook

WeightNormal

WeightMedium

WeightSemibold

WeightBold

WeightUltrabold

WeightHeavy

WeightUltraheavy

Instances

Enum Weight

Methods

succ :: Weight -> Weight

pred :: Weight -> Weight

toEnum :: Int -> Weight

fromEnum :: Weight -> Int

enumFrom :: Weight -> [Weight]

enumFromThen :: Weight -> Weight -> [Weight]

enumFromTo :: Weight -> Weight -> [Weight]

enumFromThenTo :: Weight -> Weight -> Weight -> [Weight]

Eq Weight

Methods

(==) :: Weight -> Weight -> Bool

(/=) :: Weight -> Weight -> Bool

Show Weight

Methods

showsPrec :: Int -> Weight -> ShowS

show :: Weight -> String

showList :: [Weight] -> ShowS

data Variant

The variant of a font.

• The VariantSmallCaps is a version of a font where lower case letters are shown as physically smaller upper case letters.

Constructors

VariantNormal

VariantSmallCaps

Instances

Enum Variant

Methods

succ :: Variant -> Variant

pred :: Variant -> Variant

toEnum :: Int -> Variant

fromEnum :: Variant -> Int

enumFrom :: Variant -> [Variant]

enumFromThen :: Variant -> Variant -> [Variant]

enumFromTo :: Variant -> Variant -> [Variant]

enumFromThenTo :: Variant -> Variant -> Variant -> [Variant]

Eq Variant

Methods

(==) :: Variant -> Variant -> Bool

(/=) :: Variant -> Variant -> Bool

Show Variant

Methods

showsPrec :: Int -> Variant -> ShowS

show :: Variant -> String

showList :: [Variant] -> ShowS

data Stretch

Define how wide characters are.

Constructors

StretchUltraCondensed

StretchExtraCondensed

StretchCondensed

StretchSemiCondensed

StretchNormal

StretchSemiExpanded

StretchExpanded

StretchExtraExpanded

StretchUltraExpanded

Instances

Enum Stretch

Methods

succ :: Stretch -> Stretch

pred :: Stretch -> Stretch

toEnum :: Int -> Stretch

fromEnum :: Stretch -> Int

enumFrom :: Stretch -> [Stretch]

enumFromThen :: Stretch -> Stretch -> [Stretch]

enumFromTo :: Stretch -> Stretch -> [Stretch]

enumFromThenTo :: Stretch -> Stretch -> Stretch -> [Stretch]

Eq Stretch

Methods

(==) :: Stretch -> Stretch -> Bool

(/=) :: Stretch -> Stretch -> Bool

Show Stretch

Methods

showsPrec :: Int -> Stretch -> ShowS

show :: Stretch -> String

showList :: [Stretch] -> ShowS

data Underline

Define attributes for Underline.

• The squiggly underline for errors is only available in Gtk 2.4 and higher.

Constructors

UnderlineNone

UnderlineSingle

UnderlineDouble

UnderlineLow

UnderlineError

Instances

Enum Underline

Methods

succ :: Underline -> Underline

pred :: Underline -> Underline

toEnum :: Int -> Underline

fromEnum :: Underline -> Int

enumFrom :: Underline -> [Underline]

enumFromThen :: Underline -> Underline -> [Underline]

enumFromTo :: Underline -> Underline -> [Underline]

enumFromThenTo :: Underline -> Underline -> Underline -> [Underline]

Eq Underline

Methods

(==) :: Underline -> Underline -> Bool

(/=) :: Underline -> Underline -> Bool

Show Underline

Methods

showsPrec :: Int -> Underline -> ShowS

show :: Underline -> String

showList :: [Underline] -> ShowS

data PangoDirection

The PangoDirection type represents a direction in the Unicode bidirectional algorithm.

• The "weak" values denote a left-to-right or right-to-left direction only if there is no character with a strong direction in a paragraph. An example is a sequence of special, graphical characters which are neutral with respect to their rendering direction. A fresh PangoContext is by default weakly left-to-right.
• Not every value in this enumeration makes sense for every usage of PangoDirection; for example, the return value of unicharDirection and findBaseDir cannot be PangoDirectionWeakLtr or PangoDirectionWeakRtl, since every character is either neutral or has a strong direction; on the other hand PangoDirectionNeutral doesn't make sense to pass to log2visGetEmbeddingLevels.

Constructors

PangoDirectionLtr

PangoDirectionRtl

PangoDirectionWeakLtr

PangoDirectionWeakRtl

PangoDirectionNeutral

Instances

Enum PangoDirection

Methods

succ :: PangoDirection -> PangoDirection

pred :: PangoDirection -> PangoDirection

toEnum :: Int -> PangoDirection

fromEnum :: PangoDirection -> Int

enumFrom :: PangoDirection -> [PangoDirection]

enumFromThen :: PangoDirection -> PangoDirection -> [PangoDirection]

enumFromTo :: PangoDirection -> PangoDirection -> [PangoDirection]

enumFromThenTo :: PangoDirection -> PangoDirection -> PangoDirection -> [PangoDirection]

Eq PangoDirection

Methods

(==) :: PangoDirection -> PangoDirection -> Bool

(/=) :: PangoDirection -> PangoDirection -> Bool

Ord PangoDirection

Methods

compare :: PangoDirection -> PangoDirection -> Ordering

(<) :: PangoDirection -> PangoDirection -> Bool

(<=) :: PangoDirection -> PangoDirection -> Bool

(>) :: PangoDirection -> PangoDirection -> Bool

(>=) :: PangoDirection -> PangoDirection -> Bool

max :: PangoDirection -> PangoDirection -> PangoDirection

min :: PangoDirection -> PangoDirection -> PangoDirection

data PangoAttribute

Attributes for PangoItems.

• A given attribute is applied from its start position paStart up, but not including the end position, paEnd.

Constructors

AttrLanguage

A hint as to what language this piece of text is written in.

Fields

• paStart :: Int
• paEnd :: Int
• paLang :: Language

AttrFamily

The font family, e.g. sans serif.

Fields

• paStart :: Int
• paEnd :: Int
• paFamily :: DefaultGlibString

AttrStyle

The slant of the current font.

Fields

• paStart :: Int
• paEnd :: Int
• paStyle :: FontStyle

AttrWeight

Weight of font, e.g. WeightBold.

Fields

• paStart :: Int
• paEnd :: Int
• paWeight :: Weight

AttrVariant

VariantSmallCaps will display lower case letters as small upper case letters (if the font supports this).

Fields

• paStart :: Int
• paEnd :: Int
• paVariant :: Variant

AttrStretch

Stretch or condense the width of the letters.

Fields

• paStart :: Int
• paEnd :: Int
• paStretch :: Stretch

AttrSize

Specify the size of the font in points.

Fields

• paStart :: Int
• paEnd :: Int
• paSize :: Double

AttrAbsSize

Specify the size of the font in device units (pixels).

• Available in Pango 1.8.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paSize :: Double

AttrFontDescription

Specify several attributes of a font at once. Note that no deep copy of the description is made when this attributes is passed to or received from functions.

Fields

• paStart :: Int
• paEnd :: Int
• paFontDescription :: FontDescription

AttrForeground

Specify the foreground color.

Fields

• paStart :: Int
• paEnd :: Int
• paColor :: Color

AttrBackground

Specify the background color.

Fields

• paStart :: Int
• paEnd :: Int
• paColor :: Color

AttrUnderline

Specify the kind of underline, e.g. UnderlineSingle.

Fields

• paStart :: Int
• paEnd :: Int
• paUnderline :: Underline

AttrUnderlineColor

Specify the color of an underline.

• Available in Pango 1.8.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paColor :: Color

AttrStrikethrough

Specify if this piece of text should have a line through it.

Fields

• paStart :: Int
• paEnd :: Int
• paStrikethrough :: Bool

AttrStrikethroughColor

Specify the color of the strike through line.

• Available in Pango 1.8.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paColor :: Color

AttrRise

Displace the text vertically. Positive values move the text upwards.

Fields

• paStart :: Int
• paEnd :: Int
• paRise :: Double

AttrShape

Restrict the amount of what is drawn of the marked shapes.

• Available in Pango 1.8.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paInk :: PangoRectangle
• paLogical :: PangoRectangle

AttrScale

Scale the font up (values greater than one) or shrink the font.

Fields

• paStart :: Int
• paEnd :: Int
• paScale :: Double

AttrFallback

Determine if a fall back font should be substituted if no matching font is available.

Fields

• paStart :: Int
• paEnd :: Int
• paFallback :: Bool

AttrLetterSpacing

Add extra space between graphemes of the text.

• Available in Pango 1.6.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paLetterSpacing :: Double

AttrGravity

Sets the gravity field of a font description. The gravity field specifies how the glyphs should be rotated. If gravity is GravityAuto, this actually unsets the gravity mask on the font description.

• This function is seldom useful to the user. Gravity should normally be set on a PangoContext.
• Available in Pango 1.16.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paGravity :: PangoGravity

AttrGravityHint

Set the way horizontal scripts behave in a vertical context.

• Available in Pango 1.16.0 and higher.

Fields

• paStart :: Int
• paEnd :: Int
• paGravityHint :: PangoGravityHint

Instances

Show PangoAttribute

Methods

showsPrec :: Int -> PangoAttribute -> ShowS

show :: PangoAttribute -> String

showList :: [PangoAttribute] -> ShowS

data EllipsizeMode

The EllipsizeMode type describes what sort of (if any) ellipsization should be applied to a line of text. In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis.

Constructors

EllipsizeNone

EllipsizeStart

EllipsizeMiddle

EllipsizeEnd

Instances

Enum EllipsizeMode

Methods

succ :: EllipsizeMode -> EllipsizeMode

pred :: EllipsizeMode -> EllipsizeMode

toEnum :: Int -> EllipsizeMode

fromEnum :: EllipsizeMode -> Int

enumFrom :: EllipsizeMode -> [EllipsizeMode]

enumFromThen :: EllipsizeMode -> EllipsizeMode -> [EllipsizeMode]

enumFromTo :: EllipsizeMode -> EllipsizeMode -> [EllipsizeMode]

enumFromThenTo :: EllipsizeMode -> EllipsizeMode -> EllipsizeMode -> [EllipsizeMode]

Eq EllipsizeMode

Methods

(==) :: EllipsizeMode -> EllipsizeMode -> Bool

(/=) :: EllipsizeMode -> EllipsizeMode -> Bool

data PangoGravity

The PangoGravity type represents the orientation of glyphs in a segment of text. The value GravitySouth, for instance, indicates that the text stands upright, i.e. that the base of the letter is directed downwards.

This is useful when rendering vertical text layouts. In those situations, the layout is rotated using a non-identity PangoMatrix, and then glyph orientation is controlled using PangoGravity. Not every value in this enumeration makes sense for every usage of Gravity; for example, PangoGravityAuto only can be passed to pangoContextSetBaseGravity and can only be returned by pangoContextGetBaseGravity.

• See also: PangoGravityHint
• Gravity is resolved from the context matrix.
• Since Pango 1.16

Constructors

PangoGravitySouth

PangoGravityEast

PangoGravityNorth

PangoGravityWest

PangoGravityAuto

Instances

Enum PangoGravity

Methods

succ :: PangoGravity -> PangoGravity

pred :: PangoGravity -> PangoGravity

toEnum :: Int -> PangoGravity

fromEnum :: PangoGravity -> Int

enumFrom :: PangoGravity -> [PangoGravity]

enumFromThen :: PangoGravity -> PangoGravity -> [PangoGravity]

enumFromTo :: PangoGravity -> PangoGravity -> [PangoGravity]

enumFromThenTo :: PangoGravity -> PangoGravity -> PangoGravity -> [PangoGravity]

Eq PangoGravity

Methods

(==) :: PangoGravity -> PangoGravity -> Bool

(/=) :: PangoGravity -> PangoGravity -> Bool

Show PangoGravity

Methods

showsPrec :: Int -> PangoGravity -> ShowS

show :: PangoGravity -> String

showList :: [PangoGravity] -> ShowS

data PangoGravityHint

The PangoGravityHint defines how horizontal scripts should behave in a vertical context.

• PangoGravityHintNatural: scripts will take their natural gravity based on the base gravity and the script. This is the default.
• PangoGravityHintStrong: always use the base gravity set, regardless of the script.
• PangoGravityHintLine: for scripts not in their natural direction (eg. Latin in East gravity), choose per-script gravity such that every script respects the line progression. This means, Latin and Arabic will take opposite gravities and both flow top-to-bottom for example.

Constructors

PangoGravityHintNatural

PangoGravityHintStrong

PangoGravityHintLine

Instances

Enum PangoGravityHint

Methods

succ :: PangoGravityHint -> PangoGravityHint

pred :: PangoGravityHint -> PangoGravityHint

toEnum :: Int -> PangoGravityHint

fromEnum :: PangoGravityHint -> Int

enumFrom :: PangoGravityHint -> [PangoGravityHint]

enumFromThen :: PangoGravityHint -> PangoGravityHint -> [PangoGravityHint]

enumFromTo :: PangoGravityHint -> PangoGravityHint -> [PangoGravityHint]

enumFromThenTo :: PangoGravityHint -> PangoGravityHint -> PangoGravityHint -> [PangoGravityHint]

Eq PangoGravityHint

Methods

(==) :: PangoGravityHint -> PangoGravityHint -> Bool

(/=) :: PangoGravityHint -> PangoGravityHint -> Bool

Show PangoGravityHint

Methods

showsPrec :: Int -> PangoGravityHint -> ShowS

show :: PangoGravityHint -> String

showList :: [PangoGravityHint] -> ShowS

data Language

An RFC-3066 language designator to choose scripts.

Instances

Eq Language

Methods

(==) :: Language -> Language -> Bool

(/=) :: Language -> Language -> Bool

Show Language

Methods

showsPrec :: Int -> Language -> ShowS

show :: Language -> String

showList :: [Language] -> ShowS

emptyLanguage :: Language

Specifying no particular language.

languageFromString :: GlibString string => string -> IO Language

Take a RFC-3066 format language tag as a string and convert it to a Language type that can be efficiently passed around and compared with other language tags.

• This function first canonicalizes the string by converting it to lowercase, mapping '_' to '-', and stripping all characters other than letters and '-'.