gi-pango-1.0.21: Pango bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Pango.Enums

Contents

Description

 
Synopsis

Enumerations

Alignment

data Alignment Source #

A Alignment describes how to align the lines of a Layout within the available space. If the Layout is set to justify using layoutSetJustify, this only has effect for partial lines.

Constructors

AlignmentLeft

Put all available space on the right

AlignmentCenter

Center the line within the available space

AlignmentRight

Put all available space on the left

AnotherAlignment Int

Catch-all for unknown values

AttrType

data AttrType Source #

The AttrType distinguishes between different types of attributes. Along with the predefined values, it is possible to allocate additional values for custom attributes using attrTypeRegister. The predefined values are given below. The type of structure used to store the attribute is listed in parentheses after the description.

Constructors

AttrTypeInvalid

does not happen

AttrTypeLanguage

language (AttrLanguage)

AttrTypeFamily

font family name list (AttrString)

AttrTypeStyle

font slant style (AttrInt)

AttrTypeWeight

font weight (AttrInt)

AttrTypeVariant

font variant (normal or small caps) (AttrInt)

AttrTypeStretch

font stretch (AttrInt)

AttrTypeSize

font size in points scaled by SCALE (AttrInt)

AttrTypeFontDesc

font description (AttrFontDesc)

AttrTypeForeground

foreground color (AttrColor)

AttrTypeBackground

background color (AttrColor)

AttrTypeUnderline

whether the text has an underline (AttrInt)

AttrTypeStrikethrough

whether the text is struck-through (AttrInt)

AttrTypeRise

baseline displacement (AttrInt)

AttrTypeShape

shape (AttrShape)

AttrTypeScale

font size scale factor (AttrFloat)

AttrTypeFallback

whether fallback is enabled (AttrInt)

AttrTypeLetterSpacing

letter spacing (AttrInt)

AttrTypeUnderlineColor

underline color (AttrColor)

AttrTypeStrikethroughColor

strikethrough color (AttrColor)

AttrTypeAbsoluteSize

font size in pixels scaled by SCALE (AttrInt)

AttrTypeGravity

base text gravity (AttrInt)

AttrTypeGravityHint

gravity hint (AttrInt)

AttrTypeFontFeatures

OpenType font features (AttrString). Since 1.38

AttrTypeForegroundAlpha

foreground alpha (AttrInt). Since 1.38

AttrTypeBackgroundAlpha

background alpha (AttrInt). Since 1.38

AnotherAttrType Int

Catch-all for unknown values

BidiType

data BidiType Source #

Deprecated: (Since version 1.44)Use fribidi for this information

The BidiType type represents the bidirectional character type of a Unicode character as specified by the <ulink url="http://www.unicode.org/reports/tr9/">Unicode bidirectional algorithm</ulink>.

Since: 1.22

Constructors

BidiTypeL

Left-to-Right

BidiTypeLre

Left-to-Right Embedding

BidiTypeLro

Left-to-Right Override

BidiTypeR

Right-to-Left

BidiTypeAl

Right-to-Left Arabic

BidiTypeRle

Right-to-Left Embedding

BidiTypeRlo

Right-to-Left Override

BidiTypePdf

Pop Directional Format

BidiTypeEn

European Number

BidiTypeEs

European Number Separator

BidiTypeEt

European Number Terminator

BidiTypeAn

Arabic Number

BidiTypeCs

Common Number Separator

BidiTypeNsm

Nonspacing Mark

BidiTypeBn

Boundary Neutral

BidiTypeB

Paragraph Separator

BidiTypeS

Segment Separator

BidiTypeWs

Whitespace

BidiTypeOn

Other Neutrals

AnotherBidiType Int

Catch-all for unknown values

CoverageLevel

data CoverageLevel Source #

Used to indicate how well a font can represent a particular Unicode character point for a particular script.

Constructors

CoverageLevelNone

The character is not representable with the font.

CoverageLevelFallback

The character is represented in a way that may be comprehensible but is not the correct graphical form. For instance, a Hangul character represented as a a sequence of Jamos, or a Latin transliteration of a Cyrillic word.

CoverageLevelApproximate

The character is represented as basically the correct graphical form, but with a stylistic variant inappropriate for the current script.

CoverageLevelExact

The character is represented as the correct graphical form.

AnotherCoverageLevel Int

Catch-all for unknown values

Direction

data Direction Source #

The Direction type represents a direction in the Unicode bidirectional algorithm; not every value in this enumeration makes sense for every usage of Direction; for example, the return value of unicharDirection and findBaseDir cannot be DirectionWeakLtr or DirectionWeakRtl, since every character is either neutral or has a strong direction; on the other hand DirectionNeutral doesn't make sense to pass to itemizeWithBaseDir.

The DirectionTtbLtr, DirectionTtbRtl values come from an earlier interpretation of this enumeration as the writing direction of a block of text and are no longer used; See Gravity for how vertical text is handled in Pango.

If you are interested in text direction, you should really use fribidi directly. PangoDirection is only retained because it is used in some public apis.

Constructors

DirectionLtr

A strong left-to-right direction

DirectionRtl

A strong right-to-left direction

DirectionTtbLtr

Deprecated value; treated the same as DirectionRtl.

DirectionTtbRtl

Deprecated value; treated the same as DirectionLtr

DirectionWeakLtr

A weak left-to-right direction

DirectionWeakRtl

A weak right-to-left direction

DirectionNeutral

No direction specified

AnotherDirection Int

Catch-all for unknown values

EllipsizeMode

data EllipsizeMode Source #

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

EllipsizeModeNone

No ellipsization

EllipsizeModeStart

Omit characters at the start of the text

EllipsizeModeMiddle

Omit characters in the middle of the text

EllipsizeModeEnd

Omit characters at the end of the text

AnotherEllipsizeMode Int

Catch-all for unknown values

Gravity

data Gravity Source #

The Gravity type represents the orientation of glyphs in a segment of text. 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 Gravity. Not every value in this enumeration makes sense for every usage of Gravity; for example, GravityAuto only can be passed to contextSetBaseGravity and can only be returned by contextGetBaseGravity.

See also: GravityHint

Since: 1.16

Constructors

GravitySouth

Glyphs stand upright (default)

GravityEast

Glyphs are rotated 90 degrees clockwise

GravityNorth

Glyphs are upside-down

GravityWest

Glyphs are rotated 90 degrees counter-clockwise

GravityAuto

Gravity is resolved from the context matrix

AnotherGravity Int

Catch-all for unknown values

Instances
Enum Gravity Source # 
Instance details

Defined in GI.Pango.Enums

Eq Gravity Source # 
Instance details

Defined in GI.Pango.Enums

Methods

(==) :: Gravity -> Gravity -> Bool #

(/=) :: Gravity -> Gravity -> Bool #

Ord Gravity Source # 
Instance details

Defined in GI.Pango.Enums

Show Gravity Source # 
Instance details

Defined in GI.Pango.Enums

BoxedEnum Gravity Source # 
Instance details

Defined in GI.Pango.Enums

GravityHint

data GravityHint Source #

The GravityHint defines how horizontal scripts should behave in a vertical context. That is, English excerpt in a vertical paragraph for example.

See Gravity.

Since: 1.16

Constructors

GravityHintNatural

scripts will take their natural gravity based on the base gravity and the script. This is the default.

GravityHintStrong

always use the base gravity set, regardless of the script.

GravityHintLine

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.

AnotherGravityHint Int

Catch-all for unknown values

RenderPart

data RenderPart Source #

RenderPart defines different items to render for such purposes as setting colors.

Since: 1.8

Constructors

RenderPartForeground

the text itself

RenderPartBackground

the area behind the text

RenderPartUnderline

underlines

RenderPartStrikethrough

strikethrough lines

AnotherRenderPart Int

Catch-all for unknown values

Script

data Script Source #

The Script enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. Note that new types may be added in the future. Applications should be ready to handle unknown values. This enumeration is interchangeable with UnicodeScript. See <ulink url="http://www.unicode.org/reports/tr24/">Unicode Standard Annex 24: Script names</ulink>.

Constructors

ScriptInvalidCode

a value never returned from scriptForUnichar

ScriptCommon

a character used by multiple different scripts

ScriptInherited

a mark glyph that takes its script from the base glyph to which it is attached

ScriptArabic

Arabic

ScriptArmenian

Armenian

ScriptBengali

Bengali

ScriptBopomofo

Bopomofo

ScriptCherokee

Cherokee

ScriptCoptic

Coptic

ScriptCyrillic

Cyrillic

ScriptDeseret

Deseret

ScriptDevanagari

Devanagari

ScriptEthiopic

Ethiopic

ScriptGeorgian

Georgian

ScriptGothic

Gothic

ScriptGreek

Greek

ScriptGujarati

Gujarati

ScriptGurmukhi

Gurmukhi

ScriptHan

Han

ScriptHangul

Hangul

ScriptHebrew

Hebrew

ScriptHiragana

Hiragana

ScriptKannada

Kannada

ScriptKatakana

Katakana

ScriptKhmer

Khmer

ScriptLao

Lao

ScriptLatin

Latin

ScriptMalayalam

Malayalam

ScriptMongolian

Mongolian

ScriptMyanmar

Myanmar

ScriptOgham

Ogham

ScriptOldItalic

Old Italic

ScriptOriya

Oriya

ScriptRunic

Runic

ScriptSinhala

Sinhala

ScriptSyriac

Syriac

ScriptTamil

Tamil

ScriptTelugu

Telugu

ScriptThaana

Thaana

ScriptThai

Thai

ScriptTibetan

Tibetan

ScriptCanadianAboriginal

Canadian Aboriginal

ScriptYi

Yi

ScriptTagalog

Tagalog

ScriptHanunoo

Hanunoo

ScriptBuhid

Buhid

ScriptTagbanwa

Tagbanwa

ScriptBraille

Braille

ScriptCypriot

Cypriot

ScriptLimbu

Limbu

ScriptOsmanya

Osmanya

ScriptShavian

Shavian

ScriptLinearB

Linear B

ScriptTaiLe

Tai Le

ScriptUgaritic

Ugaritic

ScriptNewTaiLue

New Tai Lue. Since 1.10

ScriptBuginese

Buginese. Since 1.10

ScriptGlagolitic

Glagolitic. Since 1.10

ScriptTifinagh

Tifinagh. Since 1.10

ScriptSylotiNagri

Syloti Nagri. Since 1.10

ScriptOldPersian

Old Persian. Since 1.10

ScriptKharoshthi

Kharoshthi. Since 1.10

ScriptUnknown

an unassigned code point. Since 1.14

ScriptBalinese

Balinese. Since 1.14

ScriptCuneiform

Cuneiform. Since 1.14

ScriptPhoenician

Phoenician. Since 1.14

ScriptPhagsPa

Phags-pa. Since 1.14

ScriptNko

N'Ko. Since 1.14

ScriptKayahLi

Kayah Li. Since 1.20.1

ScriptLepcha

Lepcha. Since 1.20.1

ScriptRejang

Rejang. Since 1.20.1

ScriptSundanese

Sundanese. Since 1.20.1

ScriptSaurashtra

Saurashtra. Since 1.20.1

ScriptCham

Cham. Since 1.20.1

ScriptOlChiki

Ol Chiki. Since 1.20.1

ScriptVai

Vai. Since 1.20.1

ScriptCarian

Carian. Since 1.20.1

ScriptLycian

Lycian. Since 1.20.1

ScriptLydian

Lydian. Since 1.20.1

ScriptBatak

Batak. Since 1.32

ScriptBrahmi

Brahmi. Since 1.32

ScriptMandaic

Mandaic. Since 1.32

ScriptChakma

Chakma. Since: 1.32

ScriptMeroiticCursive

Meroitic Cursive. Since: 1.32

ScriptMeroiticHieroglyphs

Meroitic Hieroglyphs. Since: 1.32

ScriptMiao

Miao. Since: 1.32

ScriptSharada

Sharada. Since: 1.32

ScriptSoraSompeng

Sora Sompeng. Since: 1.32

ScriptTakri

Takri. Since: 1.32

ScriptBassaVah

Bassa. Since: 1.40

ScriptCaucasianAlbanian

Caucasian Albanian. Since: 1.40

ScriptDuployan

Duployan. Since: 1.40

ScriptElbasan

Elbasan. Since: 1.40

ScriptGrantha

Grantha. Since: 1.40

ScriptKhojki

Kjohki. Since: 1.40

ScriptKhudawadi

Khudawadi, Sindhi. Since: 1.40

ScriptLinearA

Linear A. Since: 1.40

ScriptMahajani

Mahajani. Since: 1.40

ScriptManichaean

Manichaean. Since: 1.40

ScriptMendeKikakui

Mende Kikakui. Since: 1.40

ScriptModi

Modi. Since: 1.40

ScriptMro

Mro. Since: 1.40

ScriptNabataean

Nabataean. Since: 1.40

ScriptOldNorthArabian

Old North Arabian. Since: 1.40

ScriptOldPermic

Old Permic. Since: 1.40

ScriptPahawhHmong

Pahawh Hmong. Since: 1.40

ScriptPalmyrene

Palmyrene. Since: 1.40

ScriptPauCinHau

Pau Cin Hau. Since: 1.40

ScriptPsalterPahlavi

Psalter Pahlavi. Since: 1.40

ScriptSiddham

Siddham. Since: 1.40

ScriptTirhuta

Tirhuta. Since: 1.40

ScriptWarangCiti

Warang Citi. Since: 1.40

ScriptAhom

Ahom. Since: 1.40

ScriptAnatolianHieroglyphs

Anatolian Hieroglyphs. Since: 1.40

ScriptHatran

Hatran. Since: 1.40

ScriptMultani

Multani. Since: 1.40

ScriptOldHungarian

Old Hungarian. Since: 1.40

ScriptSignwriting

Signwriting. Since: 1.40

AnotherScript Int

Catch-all for unknown values

Instances
Enum Script Source # 
Instance details

Defined in GI.Pango.Enums

Eq Script Source # 
Instance details

Defined in GI.Pango.Enums

Methods

(==) :: Script -> Script -> Bool #

(/=) :: Script -> Script -> Bool #

Ord Script Source # 
Instance details

Defined in GI.Pango.Enums

Show Script Source # 
Instance details

Defined in GI.Pango.Enums

BoxedEnum Script Source # 
Instance details

Defined in GI.Pango.Enums

Stretch

data Stretch Source #

An enumeration specifying the width of the font relative to other designs within a family.

Constructors

StretchUltraCondensed

ultra condensed width

StretchExtraCondensed

extra condensed width

StretchCondensed

condensed width

StretchSemiCondensed

semi condensed width

StretchNormal

the normal width

StretchSemiExpanded

semi expanded width

StretchExpanded

expanded width

StretchExtraExpanded

extra expanded width

StretchUltraExpanded

ultra expanded width

AnotherStretch Int

Catch-all for unknown values

Instances
Enum Stretch Source # 
Instance details

Defined in GI.Pango.Enums

Eq Stretch Source # 
Instance details

Defined in GI.Pango.Enums

Methods

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

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

Ord Stretch Source # 
Instance details

Defined in GI.Pango.Enums

Show Stretch Source # 
Instance details

Defined in GI.Pango.Enums

BoxedEnum Stretch Source # 
Instance details

Defined in GI.Pango.Enums

Style

data Style Source #

An enumeration specifying the various slant styles possible for a font.

Constructors

StyleNormal

the font is upright.

StyleOblique

the font is slanted, but in a roman style.

StyleItalic

the font is slanted in an italic style.

AnotherStyle Int

Catch-all for unknown values

Instances
Enum Style Source # 
Instance details

Defined in GI.Pango.Enums

Eq Style Source # 
Instance details

Defined in GI.Pango.Enums

Methods

(==) :: Style -> Style -> Bool #

(/=) :: Style -> Style -> Bool #

Ord Style Source # 
Instance details

Defined in GI.Pango.Enums

Methods

compare :: Style -> Style -> Ordering #

(<) :: Style -> Style -> Bool #

(<=) :: Style -> Style -> Bool #

(>) :: Style -> Style -> Bool #

(>=) :: Style -> Style -> Bool #

max :: Style -> Style -> Style #

min :: Style -> Style -> Style #

Show Style Source # 
Instance details

Defined in GI.Pango.Enums

Methods

showsPrec :: Int -> Style -> ShowS #

show :: Style -> String #

showList :: [Style] -> ShowS #

BoxedEnum Style Source # 
Instance details

Defined in GI.Pango.Enums

TabAlign

data TabAlign Source #

A TabAlign specifies where a tab stop appears relative to the text.

Constructors

TabAlignLeft

the tab stop appears to the left of the text.

AnotherTabAlign Int

Catch-all for unknown values

Underline

data Underline Source #

The Underline enumeration is used to specify whether text should be underlined, and if so, the type of underlining.

Constructors

UnderlineNone

no underline should be drawn

UnderlineSingle

a single underline should be drawn

UnderlineDouble

a double underline should be drawn

UnderlineLow

a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. UnderlineSingle should be used for extended portions of text.

UnderlineError

a wavy underline should be drawn below. This underline is typically used to indicate an error such as a possilble mispelling; in some cases a contrasting color may automatically be used. This type of underlining is available since Pango 1.4.

AnotherUnderline Int

Catch-all for unknown values

Variant

data Variant Source #

An enumeration specifying capitalization variant of the font.

Constructors

VariantNormal

A normal font.

VariantSmallCaps

A font with the lower case characters replaced by smaller variants of the capital characters.

AnotherVariant Int

Catch-all for unknown values

Instances
Enum Variant Source # 
Instance details

Defined in GI.Pango.Enums

Eq Variant Source # 
Instance details

Defined in GI.Pango.Enums

Methods

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

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

Ord Variant Source # 
Instance details

Defined in GI.Pango.Enums

Show Variant Source # 
Instance details

Defined in GI.Pango.Enums

BoxedEnum Variant Source # 
Instance details

Defined in GI.Pango.Enums

Weight

data Weight Source #

An enumeration specifying the weight (boldness) of a font. This is a numerical value ranging from 100 to 1000, but there are some predefined values:

Constructors

WeightThin

the thin weight (= 100; Since: 1.24)

WeightUltralight

the ultralight weight (= 200)

WeightLight

the light weight (= 300)

WeightSemilight

the semilight weight (= 350; Since: 1.36.7)

WeightBook

the book weight (= 380; Since: 1.24)

WeightNormal

the default weight (= 400)

WeightMedium

the normal weight (= 500; Since: 1.24)

WeightSemibold

the semibold weight (= 600)

WeightBold

the bold weight (= 700)

WeightUltrabold

the ultrabold weight (= 800)

WeightHeavy

the heavy weight (= 900)

WeightUltraheavy

the ultraheavy weight (= 1000; Since: 1.24)

AnotherWeight Int

Catch-all for unknown values

Instances
Enum Weight Source # 
Instance details

Defined in GI.Pango.Enums

Eq Weight Source # 
Instance details

Defined in GI.Pango.Enums

Methods

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

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

Ord Weight Source # 
Instance details

Defined in GI.Pango.Enums

Show Weight Source # 
Instance details

Defined in GI.Pango.Enums

BoxedEnum Weight Source # 
Instance details

Defined in GI.Pango.Enums

WrapMode

data WrapMode Source #

A WrapMode describes how to wrap the lines of a Layout to the desired width.

Constructors

WrapModeWord

wrap lines at word boundaries.

WrapModeChar

wrap lines at character boundaries.

WrapModeWordChar

wrap lines at word boundaries, but fall back to character boundaries if there is not enough space for a full word.

AnotherWrapMode Int

Catch-all for unknown values