-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Pango bindings
--   
--   Bindings for Pango, autogenerated by haskell-gi.
@package gi-pango
@version 1.0.30

-- | Build time configuration used during code generation.
module GI.Pango.Config

-- | Overrides used when generating these bindings.
overrides :: Text

-- | Modules in this package
modules :: [Text]

module GI.Pango.Constants

-- | A string literal containing the version of Pango available at
--   compile-time.
pattern VERSION_STRING :: Text

-- | The minor component of the version of Pango available at compile-time.
pattern VERSION_MINOR :: Int32

-- | The micro component of the version of Pango available at compile-time.
pattern VERSION_MICRO :: Int32

-- | The major component of the version of Pango available at compile-time.
pattern VERSION_MAJOR :: Int32

-- | The scale between dimensions used for Pango distances and device
--   units.
--   
--   The definition of device units is dependent on the output device; it
--   will typically be pixels for a screen, and points for a printer.
--   SCALE is currently 1024, but this may be changed in the future.
--   
--   When setting font sizes, device units are always considered to be
--   points (as in "12 point font"), rather than pixels.
pattern SCALE :: Int32

-- | Flag used in PangoGlyph to turn a gunichar value of
--   a valid Unicode character into an unknown-character glyph for that
--   gunichar.
--   
--   Such unknown-character glyphs may be rendered as a 'hex box'.
pattern GLYPH_UNKNOWN_FLAG :: Word32

-- | A PangoGlyph value for invalid input.
--   
--   PangoLayout produces one such glyph per invalid input UTF-8
--   byte and such a glyph is rendered as a crossed box.
--   
--   Note that this value is defined such that it has the
--   GLYPH_UNKNOWN_FLAG set.
--   
--   Since: 1.20
pattern GLYPH_INVALID_INPUT :: Word32

-- | A PangoGlyph value that indicates a zero-width empty glpyh.
--   
--   This is useful for example in shaper modules, to use as the glyph for
--   various zero-width Unicode characters (those passing
--   [funcisZeroWidth]).
pattern GLYPH_EMPTY :: Word32

-- | Value for endIndex in PangoAttribute that
--   indicates the end of the text.
--   
--   Since: 1.24
pattern ATTR_INDEX_TO_TEXT_END :: Word32

-- | Value for startIndex in PangoAttribute that
--   indicates the beginning of the text.
--   
--   Since: 1.24
pattern ATTR_INDEX_FROM_TEXT_BEGINNING :: Word32

-- | Whether to add a hyphen at the end of the run during shaping.
--   
--   Since: 1.44
pattern ANALYSIS_FLAG_NEED_HYPHEN :: Int32

-- | Whether this run holds ellipsized text.
--   
--   Since: 1.36.7
pattern ANALYSIS_FLAG_IS_ELLIPSIS :: Int32

-- | Whether the segment should be shifted to center around the baseline.
--   
--   This is mainly used in vertical writing directions.
--   
--   Since: 1.16
pattern ANALYSIS_FLAG_CENTERED_BASELINE :: Int32

module GI.Pango.Enums

-- | PangoAlignment describes how to align the lines of a
--   PangoLayout within the available space.
--   
--   If the PangoLayout is set to justify using
--   layoutSetJustify, this only affects partial lines.
--   
--   See layoutSetAutoDir for how text direction affects the
--   interpretation of PangoAlignment values.
data Alignment

-- | Put all available space on the right
AlignmentLeft :: Alignment

-- | Center the line within the available space
AlignmentCenter :: Alignment

-- | Put all available space on the left
AlignmentRight :: Alignment

-- | Catch-all for unknown values
AnotherAlignment :: Int -> Alignment

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

-- | does not happen
AttrTypeInvalid :: AttrType

-- | language (tAttrLanguage)
AttrTypeLanguage :: AttrType

-- | font family name list (tAttrString)
AttrTypeFamily :: AttrType

-- | font slant style (tAttrInt)
AttrTypeStyle :: AttrType

-- | font weight (tAttrInt)
AttrTypeWeight :: AttrType

-- | font variant (normal or small caps) (tAttrInt)
AttrTypeVariant :: AttrType

-- | font stretch (tAttrInt)
AttrTypeStretch :: AttrType

-- | font size in points scaled by SCALE (tAttrInt)
AttrTypeSize :: AttrType

-- | font description (tAttrFontDesc)
AttrTypeFontDesc :: AttrType

-- | foreground color (tAttrColor)
AttrTypeForeground :: AttrType

-- | background color (tAttrColor)
AttrTypeBackground :: AttrType

-- | whether the text has an underline (tAttrInt)
AttrTypeUnderline :: AttrType

-- | whether the text is struck-through (tAttrInt)
AttrTypeStrikethrough :: AttrType

-- | baseline displacement (tAttrInt)
AttrTypeRise :: AttrType

-- | shape (tAttrShape)
AttrTypeShape :: AttrType

-- | font size scale factor (tAttrFloat)
AttrTypeScale :: AttrType

-- | whether fallback is enabled (tAttrInt)
AttrTypeFallback :: AttrType

-- | letter spacing ([structpangoAttrInt])
AttrTypeLetterSpacing :: AttrType

-- | underline color (tAttrColor)
AttrTypeUnderlineColor :: AttrType

-- | strikethrough color (tAttrColor)
AttrTypeStrikethroughColor :: AttrType

-- | font size in pixels scaled by SCALE (tAttrInt)
AttrTypeAbsoluteSize :: AttrType

-- | base text gravity (tAttrInt)
AttrTypeGravity :: AttrType

-- | gravity hint (tAttrInt)
AttrTypeGravityHint :: AttrType

-- | OpenType font features (tAttrFontFeatures). Since 1.38
AttrTypeFontFeatures :: AttrType

-- | foreground alpha (tAttrInt). Since 1.38
AttrTypeForegroundAlpha :: AttrType

-- | background alpha (tAttrInt). Since 1.38
AttrTypeBackgroundAlpha :: AttrType

-- | whether breaks are allowed (tAttrInt). Since 1.44
AttrTypeAllowBreaks :: AttrType

-- | how to render invisible characters (tAttrInt). Since 1.44
AttrTypeShow :: AttrType

-- | whether to insert hyphens at intra-word line breaks (tAttrInt).
--   Since 1.44
AttrTypeInsertHyphens :: AttrType

-- | whether the text has an overline (tAttrInt). Since 1.46
AttrTypeOverline :: AttrType

-- | overline color (tAttrColor). Since 1.46
AttrTypeOverlineColor :: AttrType

-- | line height factor (tAttrFloat). Since: 1.50
AttrTypeLineHeight :: AttrType

-- | line height (tAttrInt). Since: 1.50
AttrTypeAbsoluteLineHeight :: AttrType

-- | No description available in the introspection data.
AttrTypeTextTransform :: AttrType

-- | override segmentation to classify the range of the attribute as a
--   single word (tAttrInt). Since 1.50
AttrTypeWord :: AttrType

-- | override segmentation to classify the range of the attribute as a
--   single sentence (tAttrInt). Since 1.50
AttrTypeSentence :: AttrType

-- | baseline displacement (tAttrInt). Since 1.50
AttrTypeBaselineShift :: AttrType

-- | font-relative size change (tAttrInt). Since 1.50
AttrTypeFontScale :: AttrType

-- | Catch-all for unknown values
AnotherAttrType :: Int -> AttrType

-- | An enumeration that affects baseline shifts between runs.
--   
--   Since: 1.50
data BaselineShift

-- | Leave the baseline unchanged
BaselineShiftNone :: BaselineShift

-- | Shift the baseline to the superscript position, relative to the
--   previous run
BaselineShiftSuperscript :: BaselineShift

-- | Shift the baseline to the subscript position, relative to the previous
--   run
BaselineShiftSubscript :: BaselineShift

-- | Catch-all for unknown values
AnotherBaselineShift :: Int -> BaselineShift

-- | PangoBidiType represents the bidirectional character type of
--   a Unicode character.
--   
--   The values in this enumeration are specified by the Unicode
--   bidirectional algorithm.
--   
--   Since: 1.22

-- | Deprecated: (Since version 1.44)Use fribidi for this
--   information
data BidiType

-- | Left-to-Right
BidiTypeL :: BidiType

-- | Left-to-Right Embedding
BidiTypeLre :: BidiType

-- | Left-to-Right Override
BidiTypeLro :: BidiType

-- | Right-to-Left
BidiTypeR :: BidiType

-- | Right-to-Left Arabic
BidiTypeAl :: BidiType

-- | Right-to-Left Embedding
BidiTypeRle :: BidiType

-- | Right-to-Left Override
BidiTypeRlo :: BidiType

-- | Pop Directional Format
BidiTypePdf :: BidiType

-- | European Number
BidiTypeEn :: BidiType

-- | European Number Separator
BidiTypeEs :: BidiType

-- | European Number Terminator
BidiTypeEt :: BidiType

-- | Arabic Number
BidiTypeAn :: BidiType

-- | Common Number Separator
BidiTypeCs :: BidiType

-- | Nonspacing Mark
BidiTypeNsm :: BidiType

-- | Boundary Neutral
BidiTypeBn :: BidiType

-- | Paragraph Separator
BidiTypeB :: BidiType

-- | Segment Separator
BidiTypeS :: BidiType

-- | Whitespace
BidiTypeWs :: BidiType

-- | Other Neutrals
BidiTypeOn :: BidiType

-- | Left-to-Right isolate. Since 1.48.6
BidiTypeLri :: BidiType

-- | Right-to-Left isolate. Since 1.48.6
BidiTypeRli :: BidiType

-- | First strong isolate. Since 1.48.6
BidiTypeFsi :: BidiType

-- | Pop directional isolate. Since 1.48.6
BidiTypePdi :: BidiType

-- | Catch-all for unknown values
AnotherBidiType :: Int -> BidiType

-- | PangoCoverageLevel is used to indicate how well a font can
--   represent a particular Unicode character for a particular script.
--   
--   Since 1.44, only CoverageLevelNone and
--   CoverageLevelExact will be returned.
data CoverageLevel

-- | The character is not representable with the font.
CoverageLevelNone :: CoverageLevel

-- | 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.
CoverageLevelFallback :: CoverageLevel

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

-- | The character is represented as the correct graphical form.
CoverageLevelExact :: CoverageLevel

-- | Catch-all for unknown values
AnotherCoverageLevel :: Int -> CoverageLevel

-- | PangoDirection represents a direction in the Unicode
--   bidirectional algorithm.
--   
--   Not every value in this enumeration makes sense for every usage of
--   PangoDirection; for example, the return value of
--   [funcunicharDirection] and
--   [funcfindBaseDir] cannot be
--   PANGO_DIRECTION_WEAK_LTR or
--   PANGO_DIRECTION_WEAK_RTL, since every character is either
--   neutral or has a strong direction; on the other hand
--   PANGO_DIRECTION_NEUTRAL doesn't make sense to pass to
--   [funcitemizeWithBaseDir].
--   
--   The PANGO_DIRECTION_TTB_LTR, PANGO_DIRECTION_TTB_RTL
--   values come from an earlier interpretation of this enumeration as the
--   writing direction of a block of text and are no longer used. See
--   PangoGravity 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.
data Direction

-- | A strong left-to-right direction
DirectionLtr :: Direction

-- | A strong right-to-left direction
DirectionRtl :: Direction

-- | Deprecated value; treated the same as PANGO_DIRECTION_RTL.
DirectionTtbLtr :: Direction

-- | Deprecated value; treated the same as PANGO_DIRECTION_LTR
DirectionTtbRtl :: Direction

-- | A weak left-to-right direction
DirectionWeakLtr :: Direction

-- | A weak right-to-left direction
DirectionWeakRtl :: Direction

-- | No direction specified
DirectionNeutral :: Direction

-- | Catch-all for unknown values
AnotherDirection :: Int -> Direction

-- | PangoEllipsizeMode describes what sort of ellipsization
--   should be applied to 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.
data EllipsizeMode

-- | No ellipsization
EllipsizeModeNone :: EllipsizeMode

-- | Omit characters at the start of the text
EllipsizeModeStart :: EllipsizeMode

-- | Omit characters in the middle of the text
EllipsizeModeMiddle :: EllipsizeMode

-- | Omit characters at the end of the text
EllipsizeModeEnd :: EllipsizeMode

-- | Catch-all for unknown values
AnotherEllipsizeMode :: Int -> EllipsizeMode

-- | Specifies whether a font should or should not have color glyphs.
--   
--   Since: 1.57
data FontColor

-- | The font should not have color glyphs
FontColorForbidden :: FontColor

-- | The font should have color glyphs
FontColorRequired :: FontColor

-- | The font may or may not use color
FontColorDontCare :: FontColor

-- | Catch-all for unknown values
AnotherFontColor :: Int -> FontColor

-- | An enumeration that affects font sizes for superscript and subscript
--   positioning and for (emulated) Small Caps.
--   
--   Since: 1.50
data FontScale

-- | Leave the font size unchanged
FontScaleNone :: FontScale

-- | Change the font to a size suitable for superscripts
FontScaleSuperscript :: FontScale

-- | Change the font to a size suitable for subscripts
FontScaleSubscript :: FontScale

-- | Change the font to a size suitable for Small Caps
FontScaleSmallCaps :: FontScale

-- | Catch-all for unknown values
AnotherFontScale :: Int -> FontScale

-- | PangoGravity 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 Matrix,
--   and then glyph orientation is controlled using PangoGravity.
--   
--   Not every value in this enumeration makes sense for every usage of
--   PangoGravity; for example, GravityAuto only can be
--   passed to contextSetBaseGravity and can only be returned by
--   contextGetBaseGravity.
--   
--   See also: GravityHint
--   
--   Since: 1.16
data Gravity

-- | Glyphs stand upright (default) <img align="right" valign="center"
--   src="m-south.png">
GravitySouth :: Gravity

-- | Glyphs are rotated 90 degrees counter-clockwise. <img align="right"
--   valign="center" src="m-east.png">
GravityEast :: Gravity

-- | Glyphs are upside-down. <img align="right" valign="cener"
--   src="m-north.png">
GravityNorth :: Gravity

-- | Glyphs are rotated 90 degrees clockwise. <img align="right"
--   valign="center" src="m-west.png">
GravityWest :: Gravity

-- | Gravity is resolved from the context matrix
GravityAuto :: Gravity

-- | Catch-all for unknown values
AnotherGravity :: Int -> Gravity

-- | PangoGravityHint defines how horizontal scripts should behave
--   in a vertical context.
--   
--   That is, English excerpts in a vertical paragraph for example.
--   
--   See also Gravity
--   
--   Since: 1.16
data GravityHint

-- | scripts will take their natural gravity based on the base gravity and
--   the script. This is the default.
GravityHintNatural :: GravityHint

-- | always use the base gravity set, regardless of the script.
GravityHintStrong :: GravityHint

-- | 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.
GravityHintLine :: GravityHint

-- | Catch-all for unknown values
AnotherGravityHint :: Int -> GravityHint

-- | Errors that can be returned by layoutDeserialize.
--   
--   Since: 1.50
data LayoutDeserializeError

-- | Unspecified error
LayoutDeserializeErrorInvalid :: LayoutDeserializeError

-- | A JSon value could not be interpreted
LayoutDeserializeErrorInvalidValue :: LayoutDeserializeError

-- | A required JSon member was not found
LayoutDeserializeErrorMissingValue :: LayoutDeserializeError

-- | Catch-all for unknown values
AnotherLayoutDeserializeError :: Int -> LayoutDeserializeError

-- | Catch exceptions of type LayoutDeserializeError. This is a
--   specialized version of catchGErrorJustDomain.
catchLayoutDeserializeError :: IO a -> (LayoutDeserializeError -> GErrorMessage -> IO a) -> IO a

-- | Handle exceptions of type LayoutDeserializeError. This is a
--   specialized version of handleGErrorJustDomain.
handleLayoutDeserializeError :: (LayoutDeserializeError -> GErrorMessage -> IO a) -> IO a -> IO a

-- | The PangoOverline enumeration is used to specify whether text
--   should be overlined, and if so, the type of line.
--   
--   Since: 1.46
data Overline

-- | no overline should be drawn
OverlineNone :: Overline

-- | Draw a single line above the ink extents of the text being underlined.
OverlineSingle :: Overline

-- | Catch-all for unknown values
AnotherOverline :: Int -> Overline

-- | PangoRenderPart defines different items to render for such
--   purposes as setting colors.
--   
--   Since: 1.8
data RenderPart

-- | the text itself
RenderPartForeground :: RenderPart

-- | the area behind the text
RenderPartBackground :: RenderPart

-- | underlines
RenderPartUnderline :: RenderPart

-- | strikethrough lines
RenderPartStrikethrough :: RenderPart

-- | overlines
RenderPartOverline :: RenderPart

-- | Catch-all for unknown values
AnotherRenderPart :: Int -> RenderPart

-- | The PangoScript enumeration identifies different writing
--   systems.
--   
--   The values correspond to the names as defined in the Unicode standard.
--   See Unicode Standard Annex 24: Script names
--   
--   Note that this enumeration is deprecated and will not be updated to
--   include values in newer versions of the Unicode standard. Applications
--   should use the UnicodeScript enumeration instead, whose values
--   are interchangeable with PangoScript.
data Script

-- | a value never returned from scriptForUnichar
ScriptInvalidCode :: Script

-- | a character used by multiple different scripts
ScriptCommon :: Script

-- | a mark glyph that takes its script from the base glyph to which it is
--   attached
ScriptInherited :: Script

-- | Arabic
ScriptArabic :: Script

-- | Armenian
ScriptArmenian :: Script

-- | Bengali
ScriptBengali :: Script

-- | Bopomofo
ScriptBopomofo :: Script

-- | Cherokee
ScriptCherokee :: Script

-- | Coptic
ScriptCoptic :: Script

-- | Cyrillic
ScriptCyrillic :: Script

-- | Deseret
ScriptDeseret :: Script

-- | Devanagari
ScriptDevanagari :: Script

-- | Ethiopic
ScriptEthiopic :: Script

-- | Georgian
ScriptGeorgian :: Script

-- | Gothic
ScriptGothic :: Script

-- | Greek
ScriptGreek :: Script

-- | Gujarati
ScriptGujarati :: Script

-- | Gurmukhi
ScriptGurmukhi :: Script

-- | Han
ScriptHan :: Script

-- | Hangul
ScriptHangul :: Script

-- | Hebrew
ScriptHebrew :: Script

-- | Hiragana
ScriptHiragana :: Script

-- | Kannada
ScriptKannada :: Script

-- | Katakana
ScriptKatakana :: Script

-- | Khmer
ScriptKhmer :: Script

-- | Lao
ScriptLao :: Script

-- | Latin
ScriptLatin :: Script

-- | Malayalam
ScriptMalayalam :: Script

-- | Mongolian
ScriptMongolian :: Script

-- | Myanmar
ScriptMyanmar :: Script

-- | Ogham
ScriptOgham :: Script

-- | Old Italic
ScriptOldItalic :: Script

-- | Oriya
ScriptOriya :: Script

-- | Runic
ScriptRunic :: Script

-- | Sinhala
ScriptSinhala :: Script

-- | Syriac
ScriptSyriac :: Script

-- | Tamil
ScriptTamil :: Script

-- | Telugu
ScriptTelugu :: Script

-- | Thaana
ScriptThaana :: Script

-- | Thai
ScriptThai :: Script

-- | Tibetan
ScriptTibetan :: Script

-- | Canadian Aboriginal
ScriptCanadianAboriginal :: Script

-- | Yi
ScriptYi :: Script

-- | Tagalog
ScriptTagalog :: Script

-- | Hanunoo
ScriptHanunoo :: Script

-- | Buhid
ScriptBuhid :: Script

-- | Tagbanwa
ScriptTagbanwa :: Script

-- | Braille
ScriptBraille :: Script

-- | Cypriot
ScriptCypriot :: Script

-- | Limbu
ScriptLimbu :: Script

-- | Osmanya
ScriptOsmanya :: Script

-- | Shavian
ScriptShavian :: Script

-- | Linear B
ScriptLinearB :: Script

-- | Tai Le
ScriptTaiLe :: Script

-- | Ugaritic
ScriptUgaritic :: Script

-- | New Tai Lue. Since 1.10
ScriptNewTaiLue :: Script

-- | Buginese. Since 1.10
ScriptBuginese :: Script

-- | Glagolitic. Since 1.10
ScriptGlagolitic :: Script

-- | Tifinagh. Since 1.10
ScriptTifinagh :: Script

-- | Syloti Nagri. Since 1.10
ScriptSylotiNagri :: Script

-- | Old Persian. Since 1.10
ScriptOldPersian :: Script

-- | Kharoshthi. Since 1.10
ScriptKharoshthi :: Script

-- | an unassigned code point. Since 1.14
ScriptUnknown :: Script

-- | Balinese. Since 1.14
ScriptBalinese :: Script

-- | Cuneiform. Since 1.14
ScriptCuneiform :: Script

-- | Phoenician. Since 1.14
ScriptPhoenician :: Script

-- | Phags-pa. Since 1.14
ScriptPhagsPa :: Script

-- | N'Ko. Since 1.14
ScriptNko :: Script

-- | Kayah Li. Since 1.20.1
ScriptKayahLi :: Script

-- | Lepcha. Since 1.20.1
ScriptLepcha :: Script

-- | Rejang. Since 1.20.1
ScriptRejang :: Script

-- | Sundanese. Since 1.20.1
ScriptSundanese :: Script

-- | Saurashtra. Since 1.20.1
ScriptSaurashtra :: Script

-- | Cham. Since 1.20.1
ScriptCham :: Script

-- | Ol Chiki. Since 1.20.1
ScriptOlChiki :: Script

-- | Vai. Since 1.20.1
ScriptVai :: Script

-- | Carian. Since 1.20.1
ScriptCarian :: Script

-- | Lycian. Since 1.20.1
ScriptLycian :: Script

-- | Lydian. Since 1.20.1
ScriptLydian :: Script

-- | Batak. Since 1.32
ScriptBatak :: Script

-- | Brahmi. Since 1.32
ScriptBrahmi :: Script

-- | Mandaic. Since 1.32
ScriptMandaic :: Script

-- | Chakma. Since: 1.32
ScriptChakma :: Script

-- | Meroitic Cursive. Since: 1.32
ScriptMeroiticCursive :: Script

-- | Meroitic Hieroglyphs. Since: 1.32
ScriptMeroiticHieroglyphs :: Script

-- | Miao. Since: 1.32
ScriptMiao :: Script

-- | Sharada. Since: 1.32
ScriptSharada :: Script

-- | Sora Sompeng. Since: 1.32
ScriptSoraSompeng :: Script

-- | Takri. Since: 1.32
ScriptTakri :: Script

-- | Bassa. Since: 1.40
ScriptBassaVah :: Script

-- | Caucasian Albanian. Since: 1.40
ScriptCaucasianAlbanian :: Script

-- | Duployan. Since: 1.40
ScriptDuployan :: Script

-- | Elbasan. Since: 1.40
ScriptElbasan :: Script

-- | Grantha. Since: 1.40
ScriptGrantha :: Script

-- | Kjohki. Since: 1.40
ScriptKhojki :: Script

-- | Khudawadi, Sindhi. Since: 1.40
ScriptKhudawadi :: Script

-- | Linear A. Since: 1.40
ScriptLinearA :: Script

-- | Mahajani. Since: 1.40
ScriptMahajani :: Script

-- | Manichaean. Since: 1.40
ScriptManichaean :: Script

-- | Mende Kikakui. Since: 1.40
ScriptMendeKikakui :: Script

-- | Modi. Since: 1.40
ScriptModi :: Script

-- | Mro. Since: 1.40
ScriptMro :: Script

-- | Nabataean. Since: 1.40
ScriptNabataean :: Script

-- | Old North Arabian. Since: 1.40
ScriptOldNorthArabian :: Script

-- | Old Permic. Since: 1.40
ScriptOldPermic :: Script

-- | Pahawh Hmong. Since: 1.40
ScriptPahawhHmong :: Script

-- | Palmyrene. Since: 1.40
ScriptPalmyrene :: Script

-- | Pau Cin Hau. Since: 1.40
ScriptPauCinHau :: Script

-- | Psalter Pahlavi. Since: 1.40
ScriptPsalterPahlavi :: Script

-- | Siddham. Since: 1.40
ScriptSiddham :: Script

-- | Tirhuta. Since: 1.40
ScriptTirhuta :: Script

-- | Warang Citi. Since: 1.40
ScriptWarangCiti :: Script

-- | Ahom. Since: 1.40
ScriptAhom :: Script

-- | Anatolian Hieroglyphs. Since: 1.40
ScriptAnatolianHieroglyphs :: Script

-- | Hatran. Since: 1.40
ScriptHatran :: Script

-- | Multani. Since: 1.40
ScriptMultani :: Script

-- | Old Hungarian. Since: 1.40
ScriptOldHungarian :: Script

-- | Signwriting. Since: 1.40
ScriptSignwriting :: Script

-- | Catch-all for unknown values
AnotherScript :: Int -> Script

-- | An enumeration specifying the width of the font relative to other
--   designs within a family.
data Stretch

-- | ultra condensed width
StretchUltraCondensed :: Stretch

-- | extra condensed width
StretchExtraCondensed :: Stretch

-- | condensed width
StretchCondensed :: Stretch

-- | semi condensed width
StretchSemiCondensed :: Stretch

-- | the normal width
StretchNormal :: Stretch

-- | semi expanded width
StretchSemiExpanded :: Stretch

-- | expanded width
StretchExpanded :: Stretch

-- | extra expanded width
StretchExtraExpanded :: Stretch

-- | ultra expanded width
StretchUltraExpanded :: Stretch

-- | Catch-all for unknown values
AnotherStretch :: Int -> Stretch

-- | An enumeration specifying the various slant styles possible for a
--   font.
data Style

-- | the font is upright.
StyleNormal :: Style

-- | the font is slanted, but in a roman style.
StyleOblique :: Style

-- | the font is slanted in an italic style.
StyleItalic :: Style

-- | Catch-all for unknown values
AnotherStyle :: Int -> Style

-- | PangoTabAlign specifies where the text appears relative to
--   the tab stop position.
data TabAlign

-- | the text appears to the right of the tab stop position
TabAlignLeft :: TabAlign

-- | the text appears to the left of the tab stop position until the
--   available space is filled. Since: 1.50
TabAlignRight :: TabAlign

-- | the text is centered at the tab stop position until the available
--   space is filled. Since: 1.50
TabAlignCenter :: TabAlign

-- | text before the first occurrence of the decimal point character
--   appears to the left of the tab stop position (until the available
--   space is filled), the rest to the right. Since: 1.50
TabAlignDecimal :: TabAlign

-- | Catch-all for unknown values
AnotherTabAlign :: Int -> TabAlign

-- | An enumeration that affects how Pango treats characters during
--   shaping.
--   
--   Since: 1.50
data TextTransform

-- | Leave text unchanged
TextTransformNone :: TextTransform

-- | Display letters and numbers as lowercase
TextTransformLowercase :: TextTransform

-- | Display letters and numbers as uppercase
TextTransformUppercase :: TextTransform

-- | Display the first character of a word in titlecase
TextTransformCapitalize :: TextTransform

-- | Catch-all for unknown values
AnotherTextTransform :: Int -> TextTransform

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

-- | no underline should be drawn
UnderlineNone :: Underline

-- | a single underline should be drawn
UnderlineSingle :: Underline

-- | a double underline should be drawn
UnderlineDouble :: Underline

-- | 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.
UnderlineLow :: Underline

-- | an underline indicating an error should be drawn below. The exact
--   style of rendering is up to the PangoRenderer in use, but
--   typical styles include wavy or dotted lines. This underline is
--   typically used to indicate an error such as a possible mispelling; in
--   some cases a contrasting color may automatically be used. This type of
--   underlining is available since Pango 1.4.
UnderlineError :: Underline

-- | Like pANGOUNDERLINESINGLE, but drawn continuously
--   across multiple runs. This type of underlining is available since
--   Pango 1.46.
UnderlineSingleLine :: Underline

-- | Like pANGOUNDERLINEDOUBLE, but drawn continuously
--   across multiple runs. This type of underlining is available since
--   Pango 1.46.
UnderlineDoubleLine :: Underline

-- | Like pANGOUNDERLINEERROR, but drawn continuously
--   across multiple runs. This type of underlining is available since
--   Pango 1.46.
UnderlineErrorLine :: Underline

-- | Catch-all for unknown values
AnotherUnderline :: Int -> Underline

-- | An enumeration specifying capitalization variant of the font.
data Variant

-- | A normal font.
VariantNormal :: Variant

-- | A font with the lower case characters replaced by smaller variants of
--   the capital characters.
VariantSmallCaps :: Variant

-- | A font with all characters replaced by smaller variants of the capital
--   characters. Since: 1.50
VariantAllSmallCaps :: Variant

-- | A font with the lower case characters replaced by smaller variants of
--   the capital characters. Petite Caps can be even smaller than Small
--   Caps. Since: 1.50
VariantPetiteCaps :: Variant

-- | A font with all characters replaced by smaller variants of the capital
--   characters. Petite Caps can be even smaller than Small Caps. Since:
--   1.50
VariantAllPetiteCaps :: Variant

-- | A font with the upper case characters replaced by smaller variants of
--   the capital letters. Since: 1.50
VariantUnicase :: Variant

-- | A font with capital letters that are more suitable for all-uppercase
--   titles. Since: 1.50
VariantTitleCaps :: Variant

-- | Catch-all for unknown values
AnotherVariant :: Int -> Variant

-- | An enumeration specifying the weight (boldness) of a font.
--   
--   Weight is specified as a numeric value ranging from 100 to 1000. This
--   enumeration simply provides some common, predefined values.
data Weight

-- | the thin weight (= 100) Since: 1.24
WeightThin :: Weight

-- | the ultralight weight (= 200)
WeightUltralight :: Weight

-- | the light weight (= 300)
WeightLight :: Weight

-- | the semilight weight (= 350) Since: 1.36.7
WeightSemilight :: Weight

-- | the book weight (= 380) Since: 1.24)
WeightBook :: Weight

-- | the default weight (= 400)
WeightNormal :: Weight

-- | the medium weight (= 500) Since: 1.24
WeightMedium :: Weight

-- | the semibold weight (= 600)
WeightSemibold :: Weight

-- | the bold weight (= 700)
WeightBold :: Weight

-- | the ultrabold weight (= 800)
WeightUltrabold :: Weight

-- | the heavy weight (= 900)
WeightHeavy :: Weight

-- | the ultraheavy weight (= 1000) Since: 1.24
WeightUltraheavy :: Weight

-- | Catch-all for unknown values
AnotherWeight :: Int -> Weight

-- | PangoWrapMode describes how to wrap the lines of a
--   PangoLayout to the desired width.
--   
--   For pANGOWRAPWORD, Pango uses break opportunities that
--   are determined by the Unicode line breaking algorithm. For
--   pANGOWRAPCHAR, Pango allows breaking at grapheme
--   boundaries that are determined by the Unicode text segmentation
--   algorithm.
data WrapMode

-- | wrap lines at word boundaries.
WrapModeWord :: WrapMode

-- | wrap lines at character boundaries.
WrapModeChar :: WrapMode

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

-- | do not wrap.
--   
--   Since: 1.56
WrapModeNone :: WrapMode

-- | Catch-all for unknown values
AnotherWrapMode :: Int -> WrapMode
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Alignment
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.AttrType
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.BaselineShift
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.BidiType
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.CoverageLevel
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Direction
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.EllipsizeMode
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.FontColor
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.FontScale
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Gravity
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.GravityHint
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.LayoutDeserializeError
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Overline
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.RenderPart
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Script
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Stretch
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Style
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.TabAlign
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.TextTransform
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Underline
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Variant
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.Weight
instance Data.GI.Base.BasicTypes.BoxedEnum GI.Pango.Enums.WrapMode
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Alignment
instance GHC.Internal.Enum.Enum GI.Pango.Enums.AttrType
instance GHC.Internal.Enum.Enum GI.Pango.Enums.BaselineShift
instance GHC.Internal.Enum.Enum GI.Pango.Enums.BidiType
instance GHC.Internal.Enum.Enum GI.Pango.Enums.CoverageLevel
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Direction
instance GHC.Internal.Enum.Enum GI.Pango.Enums.EllipsizeMode
instance GHC.Internal.Enum.Enum GI.Pango.Enums.FontColor
instance GHC.Internal.Enum.Enum GI.Pango.Enums.FontScale
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Gravity
instance GHC.Internal.Enum.Enum GI.Pango.Enums.GravityHint
instance GHC.Internal.Enum.Enum GI.Pango.Enums.LayoutDeserializeError
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Overline
instance GHC.Internal.Enum.Enum GI.Pango.Enums.RenderPart
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Script
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Stretch
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Style
instance GHC.Internal.Enum.Enum GI.Pango.Enums.TabAlign
instance GHC.Internal.Enum.Enum GI.Pango.Enums.TextTransform
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Underline
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Variant
instance GHC.Internal.Enum.Enum GI.Pango.Enums.Weight
instance GHC.Internal.Enum.Enum GI.Pango.Enums.WrapMode
instance GHC.Classes.Eq GI.Pango.Enums.Alignment
instance GHC.Classes.Eq GI.Pango.Enums.AttrType
instance GHC.Classes.Eq GI.Pango.Enums.BaselineShift
instance GHC.Classes.Eq GI.Pango.Enums.BidiType
instance GHC.Classes.Eq GI.Pango.Enums.CoverageLevel
instance GHC.Classes.Eq GI.Pango.Enums.Direction
instance GHC.Classes.Eq GI.Pango.Enums.EllipsizeMode
instance GHC.Classes.Eq GI.Pango.Enums.FontColor
instance GHC.Classes.Eq GI.Pango.Enums.FontScale
instance GHC.Classes.Eq GI.Pango.Enums.Gravity
instance GHC.Classes.Eq GI.Pango.Enums.GravityHint
instance GHC.Classes.Eq GI.Pango.Enums.LayoutDeserializeError
instance GHC.Classes.Eq GI.Pango.Enums.Overline
instance GHC.Classes.Eq GI.Pango.Enums.RenderPart
instance GHC.Classes.Eq GI.Pango.Enums.Script
instance GHC.Classes.Eq GI.Pango.Enums.Stretch
instance GHC.Classes.Eq GI.Pango.Enums.Style
instance GHC.Classes.Eq GI.Pango.Enums.TabAlign
instance GHC.Classes.Eq GI.Pango.Enums.TextTransform
instance GHC.Classes.Eq GI.Pango.Enums.Underline
instance GHC.Classes.Eq GI.Pango.Enums.Variant
instance GHC.Classes.Eq GI.Pango.Enums.Weight
instance GHC.Classes.Eq GI.Pango.Enums.WrapMode
instance Data.GI.Base.GError.GErrorClass GI.Pango.Enums.LayoutDeserializeError
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Alignment
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.AttrType
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.BaselineShift
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.BidiType
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.CoverageLevel
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Direction
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.EllipsizeMode
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.FontColor
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.FontScale
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Gravity
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.GravityHint
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.LayoutDeserializeError
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Overline
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.RenderPart
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Script
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Stretch
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Style
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.TabAlign
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.TextTransform
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Underline
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Variant
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.Weight
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Enums.WrapMode
instance GHC.Classes.Ord GI.Pango.Enums.Alignment
instance GHC.Classes.Ord GI.Pango.Enums.AttrType
instance GHC.Classes.Ord GI.Pango.Enums.BaselineShift
instance GHC.Classes.Ord GI.Pango.Enums.BidiType
instance GHC.Classes.Ord GI.Pango.Enums.CoverageLevel
instance GHC.Classes.Ord GI.Pango.Enums.Direction
instance GHC.Classes.Ord GI.Pango.Enums.EllipsizeMode
instance GHC.Classes.Ord GI.Pango.Enums.FontColor
instance GHC.Classes.Ord GI.Pango.Enums.FontScale
instance GHC.Classes.Ord GI.Pango.Enums.Gravity
instance GHC.Classes.Ord GI.Pango.Enums.GravityHint
instance GHC.Classes.Ord GI.Pango.Enums.LayoutDeserializeError
instance GHC.Classes.Ord GI.Pango.Enums.Overline
instance GHC.Classes.Ord GI.Pango.Enums.RenderPart
instance GHC.Classes.Ord GI.Pango.Enums.Script
instance GHC.Classes.Ord GI.Pango.Enums.Stretch
instance GHC.Classes.Ord GI.Pango.Enums.Style
instance GHC.Classes.Ord GI.Pango.Enums.TabAlign
instance GHC.Classes.Ord GI.Pango.Enums.TextTransform
instance GHC.Classes.Ord GI.Pango.Enums.Underline
instance GHC.Classes.Ord GI.Pango.Enums.Variant
instance GHC.Classes.Ord GI.Pango.Enums.Weight
instance GHC.Classes.Ord GI.Pango.Enums.WrapMode
instance GHC.Internal.Show.Show GI.Pango.Enums.Alignment
instance GHC.Internal.Show.Show GI.Pango.Enums.AttrType
instance GHC.Internal.Show.Show GI.Pango.Enums.BaselineShift
instance GHC.Internal.Show.Show GI.Pango.Enums.BidiType
instance GHC.Internal.Show.Show GI.Pango.Enums.CoverageLevel
instance GHC.Internal.Show.Show GI.Pango.Enums.Direction
instance GHC.Internal.Show.Show GI.Pango.Enums.EllipsizeMode
instance GHC.Internal.Show.Show GI.Pango.Enums.FontColor
instance GHC.Internal.Show.Show GI.Pango.Enums.FontScale
instance GHC.Internal.Show.Show GI.Pango.Enums.Gravity
instance GHC.Internal.Show.Show GI.Pango.Enums.GravityHint
instance GHC.Internal.Show.Show GI.Pango.Enums.LayoutDeserializeError
instance GHC.Internal.Show.Show GI.Pango.Enums.Overline
instance GHC.Internal.Show.Show GI.Pango.Enums.RenderPart
instance GHC.Internal.Show.Show GI.Pango.Enums.Script
instance GHC.Internal.Show.Show GI.Pango.Enums.Stretch
instance GHC.Internal.Show.Show GI.Pango.Enums.Style
instance GHC.Internal.Show.Show GI.Pango.Enums.TabAlign
instance GHC.Internal.Show.Show GI.Pango.Enums.TextTransform
instance GHC.Internal.Show.Show GI.Pango.Enums.Underline
instance GHC.Internal.Show.Show GI.Pango.Enums.Variant
instance GHC.Internal.Show.Show GI.Pango.Enums.Weight
instance GHC.Internal.Show.Show GI.Pango.Enums.WrapMode
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Alignment
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.AttrType
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.BaselineShift
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.BidiType
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.CoverageLevel
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Direction
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.EllipsizeMode
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.FontColor
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.FontScale
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Gravity
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.GravityHint
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.LayoutDeserializeError
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Overline
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.RenderPart
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Script
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Stretch
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Style
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.TabAlign
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.TextTransform
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Underline
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Variant
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.Weight
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Enums.WrapMode

module GI.Pango.Flags

-- | The bits in a PangoFontMask correspond to the set fields in a
--   PangoFontDescription.
data FontMask

-- | the font family is specified.
FontMaskFamily :: FontMask

-- | the font style is specified.
FontMaskStyle :: FontMask

-- | the font variant is specified.
FontMaskVariant :: FontMask

-- | the font weight is specified.
FontMaskWeight :: FontMask

-- | the font stretch is specified.
FontMaskStretch :: FontMask

-- | the font size is specified.
FontMaskSize :: FontMask

-- | The font gravity is specified.
--   
--   Since: 1.16
FontMaskGravity :: FontMask

-- | OpenType font variations are specified.
--   
--   Since: 1.42
FontMaskVariations :: FontMask

-- | OpenType font features are specified.
--   
--   Since: 1.56
FontMaskFeatures :: FontMask

-- | Font color is specified.
--   
--   Since: 1.57
FontMaskColor :: FontMask

-- | Catch-all for unknown values
AnotherFontMask :: Int -> FontMask

-- | Flags that influence the behavior of layoutDeserialize.
--   
--   New members may be added to this enumeration over time.
--   
--   Since: 1.50
data LayoutDeserializeFlags

-- | Default behavior
LayoutDeserializeFlagsDefault :: LayoutDeserializeFlags

-- | Apply context information from the serialization to the
--   PangoContext
LayoutDeserializeFlagsContext :: LayoutDeserializeFlags

-- | Catch-all for unknown values
AnotherLayoutDeserializeFlags :: Int -> LayoutDeserializeFlags

-- | Flags that influence the behavior of layoutSerialize.
--   
--   New members may be added to this enumeration over time.
--   
--   Since: 1.50
data LayoutSerializeFlags

-- | Default behavior
LayoutSerializeFlagsDefault :: LayoutSerializeFlags

-- | Include context information
LayoutSerializeFlagsContext :: LayoutSerializeFlags

-- | Include information about the formatted output
LayoutSerializeFlagsOutput :: LayoutSerializeFlags

-- | Catch-all for unknown values
AnotherLayoutSerializeFlags :: Int -> LayoutSerializeFlags

-- | Flags influencing the shaping process.
--   
--   PangoShapeFlags can be passed to shapeWithFlags.
--   
--   Since: 1.44
data ShapeFlags

-- | Default value
ShapeFlagsNone :: ShapeFlags

-- | Round glyph positions and widths to whole device units This option
--   should be set if the target renderer can't do subpixel positioning of
--   glyphs
ShapeFlagsRoundPositions :: ShapeFlags

-- | Catch-all for unknown values
AnotherShapeFlags :: Int -> ShapeFlags

-- | These flags affect how Pango treats characters that are normally not
--   visible in the output.
--   
--   Since: 1.44
data ShowFlags

-- | No special treatment for invisible characters
ShowFlagsNone :: ShowFlags

-- | Render spaces, tabs and newlines visibly
ShowFlagsSpaces :: ShowFlags

-- | Render line breaks visibly
ShowFlagsLineBreaks :: ShowFlags

-- | Render default-ignorable Unicode characters visibly
ShowFlagsIgnorables :: ShowFlags

-- | Catch-all for unknown values
AnotherShowFlags :: Int -> ShowFlags
instance Data.GI.Base.BasicTypes.BoxedFlags GI.Pango.Flags.FontMask
instance Data.GI.Base.BasicTypes.BoxedFlags GI.Pango.Flags.LayoutDeserializeFlags
instance Data.GI.Base.BasicTypes.BoxedFlags GI.Pango.Flags.LayoutSerializeFlags
instance Data.GI.Base.BasicTypes.BoxedFlags GI.Pango.Flags.ShapeFlags
instance Data.GI.Base.BasicTypes.BoxedFlags GI.Pango.Flags.ShowFlags
instance GHC.Internal.Enum.Enum GI.Pango.Flags.FontMask
instance GHC.Internal.Enum.Enum GI.Pango.Flags.LayoutDeserializeFlags
instance GHC.Internal.Enum.Enum GI.Pango.Flags.LayoutSerializeFlags
instance GHC.Internal.Enum.Enum GI.Pango.Flags.ShapeFlags
instance GHC.Internal.Enum.Enum GI.Pango.Flags.ShowFlags
instance GHC.Classes.Eq GI.Pango.Flags.FontMask
instance GHC.Classes.Eq GI.Pango.Flags.LayoutDeserializeFlags
instance GHC.Classes.Eq GI.Pango.Flags.LayoutSerializeFlags
instance GHC.Classes.Eq GI.Pango.Flags.ShapeFlags
instance GHC.Classes.Eq GI.Pango.Flags.ShowFlags
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Flags.FontMask
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Flags.LayoutDeserializeFlags
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Flags.LayoutSerializeFlags
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Flags.ShapeFlags
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Flags.ShowFlags
instance Data.GI.Base.BasicTypes.IsGFlag GI.Pango.Flags.FontMask
instance Data.GI.Base.BasicTypes.IsGFlag GI.Pango.Flags.LayoutDeserializeFlags
instance Data.GI.Base.BasicTypes.IsGFlag GI.Pango.Flags.LayoutSerializeFlags
instance Data.GI.Base.BasicTypes.IsGFlag GI.Pango.Flags.ShapeFlags
instance Data.GI.Base.BasicTypes.IsGFlag GI.Pango.Flags.ShowFlags
instance GHC.Classes.Ord GI.Pango.Flags.FontMask
instance GHC.Classes.Ord GI.Pango.Flags.LayoutDeserializeFlags
instance GHC.Classes.Ord GI.Pango.Flags.LayoutSerializeFlags
instance GHC.Classes.Ord GI.Pango.Flags.ShapeFlags
instance GHC.Classes.Ord GI.Pango.Flags.ShowFlags
instance GHC.Internal.Show.Show GI.Pango.Flags.FontMask
instance GHC.Internal.Show.Show GI.Pango.Flags.LayoutDeserializeFlags
instance GHC.Internal.Show.Show GI.Pango.Flags.LayoutSerializeFlags
instance GHC.Internal.Show.Show GI.Pango.Flags.ShapeFlags
instance GHC.Internal.Show.Show GI.Pango.Flags.ShowFlags
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Flags.FontMask
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Flags.LayoutDeserializeFlags
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Flags.LayoutSerializeFlags
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Flags.ShapeFlags
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Flags.ShowFlags

-- | A PangoCoverage structure is a map from Unicode characters to
--   CoverageLevel values.
--   
--   It is often necessary in Pango to determine if a particular font can
--   represent a particular character, and also how well it can represent
--   that character. The PangoCoverage is a data structure that is
--   used to represent that information. It is an opaque structure with no
--   public fields.
module GI.Pango.Objects.Coverage

-- | Memory-managed wrapper type.
newtype Coverage
Coverage :: ManagedPtr Coverage -> Coverage

-- | Type class for types which can be safely cast to Coverage, for
--   instance with toCoverage.
class (GObject o, IsDescendantOf Coverage o) => IsCoverage o

-- | Cast to Coverage, for types for which this is known to be safe.
--   For general casts, use castTo.
toCoverage :: (MonadIO m, IsCoverage o) => o -> m Coverage

-- | Copy an existing PangoCoverage.
coverageCopy :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m Coverage

-- | Convert data generated from coverageToBytes back to a
--   PangoCoverage.

-- | Deprecated: (Since version 1.44)This returns Nothing
coverageFromBytes :: (HasCallStack, MonadIO m) => ByteString -> m (Maybe Coverage)

-- | Determine whether a particular index is covered by
--   coverage.
coverageGet :: (HasCallStack, MonadIO m, IsCoverage a) => a -> Int32 -> m CoverageLevel

-- | Set the coverage for each index in coverage to be the
--   max (better) value of the current coverage for the index and the
--   coverage for the corresponding index in other.

-- | Deprecated: (Since version 1.44)This function does nothing
coverageMax :: (HasCallStack, MonadIO m, IsCoverage a, IsCoverage b) => a -> b -> m ()

-- | Create a new PangoCoverage
coverageNew :: (HasCallStack, MonadIO m) => m Coverage

-- | Increase the reference count on the PangoCoverage by one.

-- | Deprecated: (Since version 1.52)Use g_object_ref instead
coverageRef :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m Coverage

-- | Modify a particular index within coverage
coverageSet :: (HasCallStack, MonadIO m, IsCoverage a) => a -> Int32 -> CoverageLevel -> m ()

-- | Convert a PangoCoverage structure into a flat binary format.

-- | Deprecated: (Since version 1.44)This returns Nothing
coverageToBytes :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m ByteString

-- | Decrease the reference count on the PangoCoverage by one.
--   
--   If the result is zero, free the coverage and all associated memory.

-- | Deprecated: (Since version 1.52)Use g_object_unref instead
coverageUnref :: (HasCallStack, MonadIO m, IsCoverage a) => a -> m ()
instance GHC.Classes.Eq GI.Pango.Objects.Coverage.Coverage
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Coverage.Coverage
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Coverage.Coverage
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Coverage.Coverage o) => GI.Pango.Objects.Coverage.IsCoverage o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Coverage.Coverage)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Coverage.Coverage
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Coverage.Coverage

-- | The PangoColor structure is used to represent a color in an
--   uncalibrated RGB color-space.
module GI.Pango.Structs.Color

-- | Memory-managed wrapper type.
newtype Color
Color :: ManagedPtr Color -> Color

-- | Construct a Color struct initialized to zero.
newZeroColor :: MonadIO m => m Color

-- | Creates a copy of src.
--   
--   The copy should be freed with colorFree. Primarily used by
--   language bindings, not that useful otherwise (since colors can just be
--   copied by assignment in C).
colorCopy :: (HasCallStack, MonadIO m) => Maybe Color -> m (Maybe Color)

-- | Frees a color allocated by colorCopy.
colorFree :: (HasCallStack, MonadIO m) => Maybe Color -> m ()

-- | Fill in the fields of a color from a string specification.
--   
--   The string can either one of a large set of standard names. (Taken
--   from the CSS Color specification, or it can be a value in the
--   form #rgb, #rrggbb, #rrrgggbbb or
--   #rrrrggggbbbb, where r, g and b
--   are hex digits of the red, green, and blue components of the color,
--   respectively. (White in the four forms is #fff,
--   #ffffff, #fffffffff and #ffffffffffff.)
colorParse :: (HasCallStack, MonadIO m) => Maybe Color -> Text -> m Bool

-- | Fill in the fields of a color from a string specification.
--   
--   The string can either one of a large set of standard names. (Taken
--   from the CSS Color specification, or it can be a hexadecimal
--   value in the form #rgb, #rrggbb, #rrrgggbbb
--   or #rrrrggggbbbb where r, g and b
--   are hex digits of the red, green, and blue components of the color,
--   respectively. (White in the four forms is #fff,
--   #ffffff, #fffffffff and #ffffffffffff.)
--   
--   Additionally, parse strings of the form #rgba,
--   #rrggbbaa, #rrrrggggbbbbaaaa, if
--   alpha is not Nothing, and set
--   alpha to the value specified by the hex digits for
--   a. If no alpha component is found in spec,
--   alpha is set to 0xffff (for a solid color).
--   
--   Since: 1.46
colorParseWithAlpha :: (HasCallStack, MonadIO m) => Maybe Color -> Text -> m (Bool, Word16)

-- | Returns a textual specification of color.
--   
--   The string is in the hexadecimal form #rrrrggggbbbb, where
--   r, g and b are hex digits representing the
--   red, green, and blue components respectively.
--   
--   Since: 1.16
colorToString :: (HasCallStack, MonadIO m) => Color -> m Text

-- | Get the value of the “blue” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get color #blue
--   
getColorBlue :: MonadIO m => Color -> m Word16

-- | Set the value of the “blue” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set color [ #blue := value ]
--   
setColorBlue :: MonadIO m => Color -> Word16 -> m ()

-- | Get the value of the “green” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get color #green
--   
getColorGreen :: MonadIO m => Color -> m Word16

-- | Set the value of the “green” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set color [ #green := value ]
--   
setColorGreen :: MonadIO m => Color -> Word16 -> m ()

-- | Get the value of the “red” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get color #red
--   
getColorRed :: MonadIO m => Color -> m Word16

-- | Set the value of the “red” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set color [ #red := value ]
--   
setColorRed :: MonadIO m => Color -> Word16 -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.Color.Color tag
instance GHC.Classes.Eq GI.Pango.Structs.Color.Color
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.Color.Color
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.Color.Color
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.Color.Color)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Color.Color
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.Color.Color

-- | A PangoFontDescription describes a font in an
--   implementation-independent manner.
--   
--   PangoFontDescription structures are used both to list what
--   fonts are available on the system and also for specifying the
--   characteristics of a font to load.
module GI.Pango.Structs.FontDescription

-- | Memory-managed wrapper type.
newtype FontDescription
FontDescription :: ManagedPtr FontDescription -> FontDescription

-- | Determines if the style attributes of newMatch are a
--   closer match for desc than those of
--   oldMatch are, or if oldMatch is
--   Nothing, determines if newMatch is a match at
--   all.
--   
--   Approximate matching is done for weight and style; other style
--   attributes must match exactly. Style attributes are all attributes
--   other than family and size-related attributes. Approximate matching
--   for style considers StyleOblique and StyleItalic as
--   matches, but not as good a match as when the styles are equal.
--   
--   Note that oldMatch must match desc.
fontDescriptionBetterMatch :: (HasCallStack, MonadIO m) => FontDescription -> Maybe FontDescription -> FontDescription -> m Bool

-- | Make a copy of a PangoFontDescription.
fontDescriptionCopy :: (HasCallStack, MonadIO m) => Maybe FontDescription -> m (Maybe FontDescription)

-- | Make a copy of a PangoFontDescription, but don't duplicate
--   allocated fields.
--   
--   This is like fontDescriptionCopy, but only a shallow copy is
--   made of the family name and other allocated fields. The result can
--   only be used until desc is modified or freed. This is
--   meant to be used when the copy is only needed temporarily.
fontDescriptionCopyStatic :: (HasCallStack, MonadIO m) => Maybe FontDescription -> m (Maybe FontDescription)

-- | Compares two font descriptions for equality.
--   
--   Two font descriptions are considered equal if the fonts they describe
--   are provably identical. This means that their masks do not have to
--   match, as long as other fields are all the same. (Two font
--   descriptions may result in identical fonts being loaded, but still
--   compare False.)
fontDescriptionEqual :: (HasCallStack, MonadIO m) => FontDescription -> FontDescription -> m Bool

-- | Frees a font description.
fontDescriptionFree :: (HasCallStack, MonadIO m) => Maybe FontDescription -> m ()

-- | Creates a new font description from a string representation.
--   
--   The string must have the form
--   
--   
--   
- FAMILY-LIST [STYLE-OPTIONS] [SIZE] [VARIATIONS]
--   [FEATURES]
--   
--   
--   where FAMILY-LIST is a comma-separated list of families optionally
--   terminated by a comma, STYLE_OPTIONS is a whitespace-separated list of
--   words where each word describes one of style, variant, weight,
--   stretch, or gravity, and SIZE is a decimal number (size in points) or
--   optionally followed by the unit modifier "px" for absolute size.
--   
--   The following words are understood as styles: "Normal", "Roman",
--   "Oblique", "Italic".
--   
--   The following words are understood as variants: "Small-Caps",
--   "All-Small-Caps", "Petite-Caps", "All-Petite-Caps", "Unicase",
--   "Title-Caps".
--   
--   The following words are understood as weights: "Thin", "Ultra-Light",
--   "Extra-Light", "Light", "Semi-Light", "Demi-Light", "Book", "Regular",
--   "Medium", "Semi-Bold", "Demi-Bold", "Bold", "Ultra-Bold",
--   "Extra-Bold", "Heavy", "Black", "Ultra-Black", "Extra-Black".
--   
--   The following words are understood as stretch values:
--   "Ultra-Condensed", "Extra-Condensed", "Condensed", "Semi-Condensed",
--   "Semi-Expanded", "Expanded", "Extra-Expanded", "Ultra-Expanded".
--   
--   The following words are understood as gravity values: "Not-Rotated",
--   "South", "Upside-Down", "North", "Rotated-Left", "East",
--   "Rotated-Right", "West".
--   
--   The following words are understood as color values: "With-Color",
--   "Without-Color".
--   
--   VARIATIONS is a comma-separated list of font variations of the form
--   @‍axis1=value,axis2=value,...
--   
--   FEATURES is a comma-separated list of font features of the form
--   #‍feature1=value,feature2=value,... The =value part can be ommitted if
--   the value is 1.
--   
--   Any one of the options may be absent. If FAMILY-LIST is absent, then
--   the family_name field of the resulting font description will be
--   initialized to Nothing. If STYLE-OPTIONS is missing, then all
--   style options will be set to the default values. If SIZE is missing,
--   the size in the resulting font description will be set to 0.
--   
--   A typical example:
--   
--   Cantarell Italic Light 15 @‍wght=200 #‍tnum=1
fontDescriptionFromString :: (HasCallStack, MonadIO m) => Text -> m FontDescription

-- | Returns the color field of the font description.
--   
--   This field determines whether the font description should match fonts
--   that have color glyphs, or fonts that don't.
--   
--   Since: 1.57
fontDescriptionGetColor :: (HasCallStack, MonadIO m) => FontDescription -> m FontColor

-- | Gets the family name field of a font description.
--   
--   See fontDescriptionSetFamily.
fontDescriptionGetFamily :: (HasCallStack, MonadIO m) => FontDescription -> m (Maybe Text)

-- | Gets the features field of a font description.
--   
--   See fontDescriptionSetFeatures.
--   
--   Since: 1.56
fontDescriptionGetFeatures :: (HasCallStack, MonadIO m) => FontDescription -> m (Maybe Text)

-- | Gets the gravity field of a font description.
--   
--   See fontDescriptionSetGravity.
--   
--   Since: 1.16
fontDescriptionGetGravity :: (HasCallStack, MonadIO m) => FontDescription -> m Gravity

-- | Determines which fields in a font description have been set.
fontDescriptionGetSetFields :: (HasCallStack, MonadIO m) => FontDescription -> m [FontMask]

-- | Gets the size field of a font description.
--   
--   See fontDescriptionSetSize.
fontDescriptionGetSize :: (HasCallStack, MonadIO m) => FontDescription -> m Int32

-- | Determines whether the size of the font is in points (not absolute) or
--   device units (absolute).
--   
--   See fontDescriptionSetSize and
--   fontDescriptionSetAbsoluteSize.
--   
--   Since: 1.8
fontDescriptionGetSizeIsAbsolute :: (HasCallStack, MonadIO m) => FontDescription -> m Bool

-- | Gets the stretch field of a font description.
--   
--   See fontDescriptionSetStretch.
fontDescriptionGetStretch :: (HasCallStack, MonadIO m) => FontDescription -> m Stretch

-- | Gets the style field of a PangoFontDescription.
--   
--   See fontDescriptionSetStyle.
fontDescriptionGetStyle :: (HasCallStack, MonadIO m) => FontDescription -> m Style

-- | Gets the variant field of a PangoFontDescription.
--   
--   See fontDescriptionSetVariant.
fontDescriptionGetVariant :: (HasCallStack, MonadIO m) => FontDescription -> m Variant

-- | Gets the variations field of a font description.
--   
--   See fontDescriptionSetVariations.
--   
--   Since: 1.42
fontDescriptionGetVariations :: (HasCallStack, MonadIO m) => FontDescription -> m (Maybe Text)

-- | Gets the weight field of a font description.
--   
--   See fontDescriptionSetWeight.
fontDescriptionGetWeight :: (HasCallStack, MonadIO m) => FontDescription -> m Weight

-- | Computes a hash of a PangoFontDescription structure.
--   
--   This is suitable to be used, for example, as an argument to
--   g_hash_table_new(). The hash value is independent of
--   desc->mask.
fontDescriptionHash :: (HasCallStack, MonadIO m) => FontDescription -> m Word32

-- | Merges the fields that are set in descToMerge into the
--   fields in desc.
--   
--   If replaceExisting is False, only fields in
--   desc that are not already set are affected. If
--   True, then fields that are already set will be replaced as
--   well.
--   
--   If descToMerge is Nothing, this function
--   performs nothing.
fontDescriptionMerge :: (HasCallStack, MonadIO m) => FontDescription -> Maybe FontDescription -> Bool -> m ()

-- | Merges the fields that are set in descToMerge into the
--   fields in desc, without copying allocated fields.
--   
--   This is like fontDescriptionMerge, but only a shallow copy is
--   made of the family name and other allocated fields.
--   desc can only be used until
--   descToMerge is modified or freed. This is meant to be
--   used when the merged font description is only needed temporarily.
fontDescriptionMergeStatic :: (HasCallStack, MonadIO m) => FontDescription -> FontDescription -> Bool -> m ()

-- | Creates a new font description structure with all fields unset.
fontDescriptionNew :: (HasCallStack, MonadIO m) => m FontDescription

-- | Sets the size field of a font description, in device units.
--   
--   This is mutually exclusive with fontDescriptionSetSize which
--   sets the font size in points.
--   
--   Since: 1.8
fontDescriptionSetAbsoluteSize :: (HasCallStack, MonadIO m) => FontDescription -> Double -> m ()

-- | Sets the color field of a font description.
--   
--   This field determines whether the font description should match fonts
--   that have color glyphs, or fonts that don't.
--   
--   Since: 1.57
fontDescriptionSetColor :: (HasCallStack, MonadIO m) => FontDescription -> FontColor -> m ()

-- | Sets the family name field of a font description.
--   
--   The family name represents a family of related font styles, and will
--   resolve to a particular PangoFontFamily. In some uses of
--   PangoFontDescription, it is also possible to use a comma
--   separated list of family names for this field.
fontDescriptionSetFamily :: (HasCallStack, MonadIO m) => FontDescription -> Text -> m ()

-- | Sets the family name field of a font description, without copying the
--   string.
--   
--   This is like fontDescriptionSetFamily, except that no copy of
--   family is made. The caller must make sure that the
--   string passed in stays around until desc has been
--   freed or the name is set again. This function can be used if
--   family is a static string such as a C string literal,
--   or if desc is only needed temporarily.
fontDescriptionSetFamilyStatic :: (HasCallStack, MonadIO m) => FontDescription -> Text -> m ()

-- | Sets the features field of a font description.
--   
--   OpenType font features allow to enable or disable certain optional
--   features of a font, such as tabular numbers.
--   
--   The format of the features string is comma-separated list of feature
--   assignments, with each assignment being one of these forms:
--   
--   FEATURE=n
--   
--   where FEATURE must be a 4 character tag that identifies and OpenType
--   feature, and n an integer (depending on the feature, the allowed
--   values may be 0, 1 or bigger numbers). Unknown features are ignored.
--   
--   Note that font features set in this way are enabled for the entire
--   text that is using the font, which is not appropriate for all OpenType
--   features. The intended use case is to select character variations
--   (features cv01 - c99), style sets (ss01 - ss20) and the like.
--   
--   Pango does not currently have a way to find supported OpenType
--   features of a font. Both harfbuzz and freetype have API for this. See
--   for example hb_ot_layout_table_get_feature_tags.
--   
--   Features that are not supported by the font are silently ignored.
--   
--   Since: 1.56
fontDescriptionSetFeatures :: (HasCallStack, MonadIO m) => FontDescription -> Maybe Text -> m ()

-- | Sets the features field of a font description.
--   
--   This is like fontDescriptionSetFeatures, except that no copy of
--   featuresis made. The caller must make sure that the
--   string passed in stays around until desc has been
--   freed or the name is set again. This function can be used if
--   features is a static string such as a C string
--   literal, or if desc is only needed temporarily.
--   
--   Since: 1.56
fontDescriptionSetFeaturesStatic :: (HasCallStack, MonadIO m) => FontDescription -> Text -> m ()

-- | 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.
--   
--   Since: 1.16
fontDescriptionSetGravity :: (HasCallStack, MonadIO m) => FontDescription -> Gravity -> m ()

-- | Sets the size field of a font description in fractional points.
--   
--   This is mutually exclusive with fontDescriptionSetAbsoluteSize.
fontDescriptionSetSize :: (HasCallStack, MonadIO m) => FontDescription -> Int32 -> m ()

-- | Sets the stretch field of a font description.
--   
--   The Stretch field specifies how narrow or wide the font should
--   be.
fontDescriptionSetStretch :: (HasCallStack, MonadIO m) => FontDescription -> Stretch -> m ()

-- | Sets the style field of a PangoFontDescription.
--   
--   The Style enumeration describes whether the font is slanted and
--   the manner in which it is slanted; it can be either
--   StyleNormal, StyleItalic, or StyleOblique.
--   
--   Most fonts will either have a italic style or an oblique style, but
--   not both, and font matching in Pango will match italic specifications
--   with oblique fonts and vice-versa if an exact match is not found.
fontDescriptionSetStyle :: (HasCallStack, MonadIO m) => FontDescription -> Style -> m ()

-- | Sets the variant field of a font description.
--   
--   The Variant can either be VariantNormal or
--   VariantSmallCaps.
fontDescriptionSetVariant :: (HasCallStack, MonadIO m) => FontDescription -> Variant -> m ()

-- | Sets the variations field of a font description.
--   
--   OpenType font variations allow to select a font instance by specifying
--   values for a number of axes, such as width or weight.
--   
--   The format of the variations string is
--   
--   AXIS1=VALUE,AXIS2=VALUE...
--   
--   with each AXIS a 4 character tag that identifies a font axis, and each
--   VALUE a floating point number. Unknown axes are ignored, and values
--   are clamped to their allowed range.
--   
--   Pango does not currently have a way to find supported axes of a font.
--   Both harfbuzz and freetype have API for this. See for example
--   hb_ot_var_get_axis_infos.
--   
--   Since: 1.42
fontDescriptionSetVariations :: (HasCallStack, MonadIO m) => FontDescription -> Maybe Text -> m ()

-- | Sets the variations field of a font description.
--   
--   This is like fontDescriptionSetVariations, except that no copy
--   of variations is made. The caller must make sure that
--   the string passed in stays around until desc has been
--   freed or the name is set again. This function can be used if
--   variations is a static string such as a C string
--   literal, or if desc is only needed temporarily.
--   
--   Since: 1.42
fontDescriptionSetVariationsStatic :: (HasCallStack, MonadIO m) => FontDescription -> Text -> m ()

-- | Sets the weight field of a font description.
--   
--   The weight field specifies how bold or light the font should be. In
--   addition to the values of the Weight enumeration, other
--   intermediate numeric values are possible.
fontDescriptionSetWeight :: (HasCallStack, MonadIO m) => FontDescription -> Weight -> m ()

-- | Creates a filename representation of a font description.
--   
--   The filename is identical to the result from calling
--   fontDescriptionToString, but with underscores instead of
--   characters that are untypical in filenames, and in lower case only.
fontDescriptionToFilename :: (HasCallStack, MonadIO m) => FontDescription -> m (Maybe Text)

-- | Creates a string representation of a font description.
--   
--   See fontDescriptionFromString for a description of the format
--   of the string representation. The family list in the string
--   description will only have a terminating comma if the last word of the
--   list is a valid style option.
fontDescriptionToString :: (HasCallStack, MonadIO m) => FontDescription -> m Text

-- | Unsets some of the fields in a PangoFontDescription.
--   
--   The unset fields will get back to their default values.
fontDescriptionUnsetFields :: (HasCallStack, MonadIO m) => FontDescription -> [FontMask] -> m ()
instance GHC.Classes.Eq GI.Pango.Structs.FontDescription.FontDescription
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.FontDescription.FontDescription
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.FontDescription.FontDescription
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.FontDescription.FontDescription)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.FontDescription.FontDescription
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.FontDescription.FontDescription

-- | A PangoFontFamily is used to represent a family of related
--   font faces.
--   
--   The font faces in a family share a common design, but differ in slant,
--   weight, width or other aspects.
module GI.Pango.Objects.FontFamily

-- | Memory-managed wrapper type.
newtype FontFamily
FontFamily :: ManagedPtr FontFamily -> FontFamily

-- | Type class for types which can be safely cast to FontFamily,
--   for instance with toFontFamily.
class (GObject o, IsDescendantOf FontFamily o) => IsFontFamily o

-- | Cast to FontFamily, for types for which this is known to be
--   safe. For general casts, use castTo.
toFontFamily :: (MonadIO m, IsFontFamily o) => o -> m FontFamily

-- | Gets the PangoFontFace of family with the
--   given name.
--   
--   Since: 1.46
fontFamilyGetFace :: (HasCallStack, MonadIO m, IsFontFamily a) => a -> Maybe Text -> m (Maybe FontFace)

-- | Gets the name of the family.
--   
--   The name is unique among all fonts for the font backend and can be
--   used in a PangoFontDescription to specify that a face from
--   this family is desired.
fontFamilyGetName :: (HasCallStack, MonadIO m, IsFontFamily a) => a -> m Text

-- | A monospace font is a font designed for text display where the the
--   characters form a regular grid.
--   
--   For Western languages this would mean that the advance width of all
--   characters are the same, but this categorization also includes Asian
--   fonts which include double-width characters: characters that occupy
--   two grid cells. unicharIswide returns a result that indicates
--   whether a character is typically double-width in a monospace font.
--   
--   The best way to find out the grid-cell size is to call
--   fontMetricsGetApproximateDigitWidth, since the results of
--   fontMetricsGetApproximateCharWidth may be affected by
--   double-width characters.
--   
--   Since: 1.4
fontFamilyIsMonospace :: (HasCallStack, MonadIO m, IsFontFamily a) => a -> m Bool

-- | A variable font is a font which has axes that can be modified to
--   produce different faces.
--   
--   Such axes are also known as _variations_; see
--   fontDescriptionSetVariations for more information.
--   
--   Since: 1.44
fontFamilyIsVariable :: (HasCallStack, MonadIO m, IsFontFamily a) => a -> m Bool

-- | Lists the different font faces that make up family.
--   
--   The faces in a family share a common design, but differ in slant,
--   weight, width and other aspects.
--   
--   Note that the returned faces are not in any particular order, and
--   multiple faces may have the same name or characteristics.
--   
--   PangoFontFamily also implemented the ListModel
--   interface for enumerating faces.
fontFamilyListFaces :: (HasCallStack, MonadIO m, IsFontFamily a) => a -> m [FontFace]

-- | Get the value of the “is-monospace” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontFamily #isMonospace
--   
getFontFamilyIsMonospace :: (MonadIO m, IsFontFamily o) => o -> m Bool

-- | Get the value of the “is-variable” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontFamily #isVariable
--   
getFontFamilyIsVariable :: (MonadIO m, IsFontFamily o) => o -> m Bool

-- | Get the value of the “item-type” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontFamily #itemType
--   
getFontFamilyItemType :: (MonadIO m, IsFontFamily o) => o -> m GType

-- | Get the value of the “n-items” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontFamily #nItems
--   
getFontFamilyNItems :: (MonadIO m, IsFontFamily o) => o -> m Word32

-- | Get the value of the “name” property. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get fontFamily #name
--   
getFontFamilyName :: (MonadIO m, IsFontFamily o) => o -> m Text
instance GHC.Classes.Eq GI.Pango.Objects.FontFamily.FontFamily
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.FontFamily.FontFamily
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.FontFamily.FontFamily
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.FontFamily.FontFamily o) => GI.Pango.Objects.FontFamily.IsFontFamily o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.FontFamily.FontFamily)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.FontFamily.FontFamily
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.FontFamily.FontFamily

-- | A PangoFontFace is used to represent a group of fonts with
--   the same family, slant, weight, and width, but varying sizes.
module GI.Pango.Objects.FontFace

-- | Memory-managed wrapper type.
newtype FontFace
FontFace :: ManagedPtr FontFace -> FontFace

-- | Type class for types which can be safely cast to FontFace, for
--   instance with toFontFace.
class (GObject o, IsDescendantOf FontFace o) => IsFontFace o

-- | Cast to FontFace, for types for which this is known to be safe.
--   For general casts, use castTo.
toFontFace :: (MonadIO m, IsFontFace o) => o -> m FontFace

-- | Returns a font description that matches the face.
--   
--   The resulting font description will have the family, style, variant,
--   weight and stretch of the face, but its size field will be unset.
fontFaceDescribe :: (HasCallStack, MonadIO m, IsFontFace a) => a -> m FontDescription

-- | Gets a name representing the style of this face.
--   
--   Note that a font family may contain multiple faces with the same name
--   (e.g. a variable and a non-variable face for the same style).
fontFaceGetFaceName :: (HasCallStack, MonadIO m, IsFontFace a) => a -> m Text

-- | Gets the PangoFontFamily that face belongs
--   to.
--   
--   Since: 1.46
fontFaceGetFamily :: (HasCallStack, MonadIO m, IsFontFace a) => a -> m FontFamily

-- | Returns whether a PangoFontFace is synthesized.
--   
--   This will be the case if the underlying font rendering engine creates
--   this face from another face, by shearing, emboldening, lightening or
--   modifying it in some other way.
--   
--   Since: 1.18
fontFaceIsSynthesized :: (HasCallStack, MonadIO m, IsFontFace a) => a -> m Bool

-- | List the available sizes for a font.
--   
--   This is only applicable to bitmap fonts. For scalable fonts, stores
--   Nothing at the location pointed to by sizes and
--   0 at the location pointed to by nSizes. The sizes
--   returned are in Pango units and are sorted in ascending order.
--   
--   Since: 1.4
fontFaceListSizes :: (HasCallStack, MonadIO m, IsFontFace a) => a -> m (Maybe [Int32])
instance GHC.Classes.Eq GI.Pango.Objects.FontFace.FontFace
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.FontFace.FontFace
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.FontFace.FontFace
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.FontFace.FontFace o) => GI.Pango.Objects.FontFace.IsFontFace o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.FontFace.FontFace)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.FontFace.FontFace
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.FontFace.FontFace

-- | A PangoFontMetrics structure holds the overall metric
--   information for a font.
--   
--   The information in a PangoFontMetrics structure may be
--   restricted to a script. The fields of this structure are private to
--   implementations of a font backend. See the documentation of the
--   corresponding getters for documentation of their meaning.
--   
--   For an overview of the most important metrics, see:
--   
--   <picture> <source srcset="fontmetrics-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Font metrics"
--   src="fontmetrics-light.png"> </picture>
module GI.Pango.Structs.FontMetrics

-- | Memory-managed wrapper type.
newtype FontMetrics
FontMetrics :: ManagedPtr FontMetrics -> FontMetrics

-- | Construct a FontMetrics struct initialized to zero.
newZeroFontMetrics :: MonadIO m => m FontMetrics

-- | Gets the approximate character width for a font metrics structure.
--   
--   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.
fontMetricsGetApproximateCharWidth :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the approximate digit width for a font metrics structure.
--   
--   This is merely a representative value useful, for example, for
--   determining the initial size for a window. Actual digits in text can
--   be wider or narrower than this, though this value is generally
--   somewhat more accurate than the result of
--   fontMetricsGetApproximateCharWidth for digits.
fontMetricsGetApproximateDigitWidth :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the ascent from a font metrics structure.
--   
--   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.)
fontMetricsGetAscent :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the descent from a font metrics structure.
--   
--   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.)
fontMetricsGetDescent :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the line height from a font metrics structure.
--   
--   The line height is the recommended distance between successive
--   baselines in wrapped text using this font.
--   
--   If the line height is not available, 0 is returned.
--   
--   Since: 1.44
fontMetricsGetHeight :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the suggested position to draw the strikethrough.
--   
--   The value returned is the distance *above* the baseline of the top of
--   the strikethrough.
--   
--   Since: 1.6
fontMetricsGetStrikethroughPosition :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the suggested thickness to draw for the strikethrough.
--   
--   Since: 1.6
fontMetricsGetStrikethroughThickness :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets 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.
--   
--   Since: 1.6
fontMetricsGetUnderlinePosition :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Gets the suggested thickness to draw for the underline.
--   
--   Since: 1.6
fontMetricsGetUnderlineThickness :: (HasCallStack, MonadIO m) => FontMetrics -> m Int32

-- | Increase the reference count of a font metrics structure by one.
fontMetricsRef :: (HasCallStack, MonadIO m) => Maybe FontMetrics -> m (Maybe FontMetrics)

-- | Decrease the reference count of a font metrics structure by one.
--   
--   If the result is zero, frees the structure and any associated memory.
fontMetricsUnref :: (HasCallStack, MonadIO m) => Maybe FontMetrics -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.FontMetrics.FontMetrics tag
instance GHC.Classes.Eq GI.Pango.Structs.FontMetrics.FontMetrics
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.FontMetrics.FontMetrics
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.FontMetrics.FontMetrics
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.FontMetrics.FontMetrics)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.FontMetrics.FontMetrics
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.FontMetrics.FontMetrics

-- | The PangoGlyphGeometry structure contains width and
--   positioning information for a single glyph.
--   
--   Note that width is not guaranteed to be the same as
--   the glyph extents. Kerning and other positioning applied during
--   shaping will affect both the width and the
--   xOffset for the glyphs in the glyph string that
--   results from shaping.
--   
--   The information in this struct is intended for rendering the glyphs,
--   as follows:
--   
--   
--   
- Assume the current point is (x, y)
--   
- Render the current glyph at (x + x_offset, y + y_offset),
--   
- Advance the current point to (x + width, y)
--   
- Render the next glyph
--   
module GI.Pango.Structs.GlyphGeometry

-- | Memory-managed wrapper type.
newtype GlyphGeometry
GlyphGeometry :: ManagedPtr GlyphGeometry -> GlyphGeometry

-- | Construct a GlyphGeometry struct initialized to zero.
newZeroGlyphGeometry :: MonadIO m => m GlyphGeometry

-- | Get the value of the “width” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get glyphGeometry #width
--   
getGlyphGeometryWidth :: MonadIO m => GlyphGeometry -> m Int32

-- | Set the value of the “width” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set glyphGeometry [ #width := value ]
--   
setGlyphGeometryWidth :: MonadIO m => GlyphGeometry -> Int32 -> m ()

-- | Get the value of the “x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphGeometry #xOffset
--   
getGlyphGeometryXOffset :: MonadIO m => GlyphGeometry -> m Int32

-- | Set the value of the “x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphGeometry [ #xOffset := value ]
--   
setGlyphGeometryXOffset :: MonadIO m => GlyphGeometry -> Int32 -> m ()

-- | Get the value of the “y_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphGeometry #yOffset
--   
getGlyphGeometryYOffset :: MonadIO m => GlyphGeometry -> m Int32

-- | Set the value of the “y_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphGeometry [ #yOffset := value ]
--   
setGlyphGeometryYOffset :: MonadIO m => GlyphGeometry -> Int32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.GlyphGeometry.GlyphGeometry
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.GlyphGeometry.GlyphGeometry
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphGeometry.GlyphGeometry tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphGeometry.GlyphGeometry
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphGeometry.GlyphGeometry

-- | A PangoGlyphVisAttr structure communicates information
--   between the shaping and rendering phases.
--   
--   Currently, it contains cluster start and color information. More
--   attributes may be added in the future.
--   
--   Clusters are stored in visual order, within the cluster, glyphs are
--   always ordered in logical order, since visual order is meaningless;
--   that is, in Arabic text, accent glyphs follow the glyphs for the base
--   character.
module GI.Pango.Structs.GlyphVisAttr

-- | Memory-managed wrapper type.
newtype GlyphVisAttr
GlyphVisAttr :: ManagedPtr GlyphVisAttr -> GlyphVisAttr

-- | Construct a GlyphVisAttr struct initialized to zero.
newZeroGlyphVisAttr :: MonadIO m => m GlyphVisAttr

-- | Get the value of the “is_cluster_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphVisAttr #isClusterStart
--   
getGlyphVisAttrIsClusterStart :: MonadIO m => GlyphVisAttr -> m Word32

-- | Set the value of the “is_cluster_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphVisAttr [ #isClusterStart := value ]
--   
setGlyphVisAttrIsClusterStart :: MonadIO m => GlyphVisAttr -> Word32 -> m ()

-- | Get the value of the “is_color” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphVisAttr #isColor
--   
getGlyphVisAttrIsColor :: MonadIO m => GlyphVisAttr -> m Word32

-- | Set the value of the “is_color” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphVisAttr [ #isColor := value ]
--   
setGlyphVisAttrIsColor :: MonadIO m => GlyphVisAttr -> Word32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.GlyphVisAttr.GlyphVisAttr
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.GlyphVisAttr.GlyphVisAttr
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphVisAttr.GlyphVisAttr tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphVisAttr.GlyphVisAttr
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphVisAttr.GlyphVisAttr

-- | A PangoGlyphInfo structure represents a single glyph with
--   positioning information and visual attributes.
module GI.Pango.Structs.GlyphInfo

-- | Memory-managed wrapper type.
newtype GlyphInfo
GlyphInfo :: ManagedPtr GlyphInfo -> GlyphInfo

-- | Construct a GlyphInfo struct initialized to zero.
newZeroGlyphInfo :: MonadIO m => m GlyphInfo

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get glyphInfo #attr
--   
getGlyphInfoAttr :: MonadIO m => GlyphInfo -> m GlyphVisAttr

-- | Get the value of the “geometry” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphInfo #geometry
--   
getGlyphInfoGeometry :: MonadIO m => GlyphInfo -> m GlyphGeometry

-- | Get the value of the “glyph” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get glyphInfo #glyph
--   
getGlyphInfoGlyph :: MonadIO m => GlyphInfo -> m Word32

-- | Set the value of the “glyph” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set glyphInfo [ #glyph := value ]
--   
setGlyphInfoGlyph :: MonadIO m => GlyphInfo -> Word32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.GlyphInfo.GlyphInfo
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.GlyphInfo.GlyphInfo
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphInfo.GlyphInfo tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphInfo.GlyphInfo
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphInfo.GlyphInfo

-- | The PangoLanguage structure is used to represent a language.
--   
--   PangoLanguage pointers can be efficiently copied and compared
--   with each other.
module GI.Pango.Structs.Language

-- | Memory-managed wrapper type.
newtype Language
Language :: ManagedPtr Language -> Language

-- | Convert a language tag to a PangoLanguage.
--   
--   The language tag must be in a RFC-3066 format. PangoLanguage
--   pointers can be efficiently copied (copy the pointer) and compared
--   with other language tags (compare the pointer.)
--   
--   This function first canonicalizes the string by converting it to
--   lowercase, mapping '_' to '-', and stripping all characters other than
--   letters and '-'.
--   
--   Use languageGetDefault if you want to get the
--   PangoLanguage for the current locale of the process.
languageFromString :: (HasCallStack, MonadIO m) => Maybe Text -> m (Maybe Language)

-- | Returns the PangoLanguage for the current locale of the
--   process.
--   
--   On Unix systems, this is the return value is derived from
--   setlocale (LC_CTYPE, NULL), and the user can affect this
--   through the environment variables LC_ALL, LC_CTYPE or LANG (checked in
--   that order). The locale string typically is in the form lang_COUNTRY,
--   where lang is an ISO-639 language code, and COUNTRY is an ISO-3166
--   country code. For instance, sv_FI for Swedish as written in Finland or
--   pt_BR for Portuguese as written in Brazil.
--   
--   On Windows, the C library does not use any such environment variables,
--   and setting them won't affect the behavior of functions like
--   ctime(). The user sets the locale through the Regional
--   Options in the Control Panel. The C library (in the
--   setlocale() function) does not use country and
--   language codes, but country and language names spelled out in English.
--   However, this function does check the above environment variables, and
--   does return a Unix-style locale string based on either said
--   environment variables or the thread's current locale.
--   
--   Your application should call setlocale(LC_ALL, "") for the
--   user settings to take effect. GTK does this in its initialization
--   functions automatically (by calling gtk_set_locale()).
--   See the setlocale() manpage for more details.
--   
--   Note that the default language can change over the life of an
--   application.
--   
--   Also note that this function will not do the right thing if you use
--   per-thread locales with uselocale(). In that case, you
--   should just call languageFromString yourself.
--   
--   Since: 1.16
languageGetDefault :: (HasCallStack, MonadIO m) => m Language

-- | Returns the list of languages that the user prefers.
--   
--   The list is specified by the PANGO_LANGUAGE or
--   LANGUAGE environment variables, in order of preference. Note
--   that this list does not necessarily include the language returned by
--   languageGetDefault.
--   
--   When choosing language-specific resources, such as the sample text
--   returned by languageGetSampleString, you should first try the
--   default language, followed by the languages returned by this function.
--   
--   Since: 1.48
languageGetPreferred :: (HasCallStack, MonadIO m) => m (Maybe [Language])

-- | Get a string that is representative of the characters needed to render
--   a particular language.
--   
--   The sample text may be a pangram, but is not necessarily. It is chosen
--   to be demonstrative of normal text in the language, as well as
--   exposing font feature requirements unique to the language. It is
--   suitable for use as sample text in a font selection dialog.
--   
--   If language is Nothing, the default language as
--   found by languageGetDefault is used.
--   
--   If Pango does not have a sample string for language,
--   the classic "The quick brown fox..." is returned. This can be detected
--   by comparing the returned pointer value to that returned for
--   (non-existent) language code "xx". That is, compare to:
--   
--   
--   pango_language_get_sample_string (pango_language_from_string ("xx"))
--   
languageGetSampleString :: (HasCallStack, MonadIO m) => Maybe Language -> m Text

-- | Determines the scripts used to to write language.
--   
--   If nothing is known about the language tag language,
--   or if language is Nothing, then Nothing
--   is returned. The list of scripts returned starts with the script that
--   the language uses most and continues to the one it uses least.
--   
--   The value numScript points at will be set to the
--   number of scripts in the returned array (or zero if Nothing is
--   returned).
--   
--   Most languages use only one script for writing, but there are some
--   that use two (Latin and Cyrillic for example), and a few use three
--   (Japanese for example). Applications should not make any assumptions
--   on the maximum number of scripts returned though, except that it is
--   positive if the return value is not Nothing, and it is a small
--   number.
--   
--   The languageIncludesScript function uses this function
--   internally.
--   
--   Note: while the return value is declared as PangoScript, the
--   returned values are from the GUnicodeScript enumeration,
--   which may have more values. Callers need to handle unknown values.
--   
--   Since: 1.22
languageGetScripts :: (HasCallStack, MonadIO m) => Maybe Language -> m (Maybe [Script])

-- | Determines if script is one of the scripts used to
--   write language.
--   
--   The returned value is conservative; if nothing is known about the
--   language tag language, True will be returned,
--   since, as far as Pango knows, script might be used to
--   write language.
--   
--   This routine is used in Pango's itemization process when determining
--   if a supplied language tag is relevant to a particular section of
--   text. It probably is not useful for applications in most
--   circumstances.
--   
--   This function uses languageGetScripts internally.
--   
--   Since: 1.4
languageIncludesScript :: (HasCallStack, MonadIO m) => Maybe Language -> Script -> m Bool

-- | Checks if a language tag matches one of the elements in a list of
--   language ranges.
--   
--   A language tag is considered to match a range in the list if the range
--   is '*', the range is exactly the tag, or the range is a prefix of the
--   tag, and the character after it in the tag is '-'.
languageMatches :: (HasCallStack, MonadIO m) => Maybe Language -> Text -> m Bool

-- | Gets the RFC-3066 format string representing the given language tag.
--   
--   Returns (transfer none): a string representing the language tag
languageToString :: (HasCallStack, MonadIO m) => Language -> m Text
instance GHC.Classes.Eq GI.Pango.Structs.Language.Language
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.Language.Language
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.Language.Language
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.Language.Language)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Language.Language
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.Language.Language

-- | The PangoLogAttr structure stores information about the
--   attributes of a single character.
module GI.Pango.Structs.LogAttr

-- | Memory-managed wrapper type.
newtype LogAttr
LogAttr :: ManagedPtr LogAttr -> LogAttr

-- | Construct a LogAttr struct initialized to zero.
newZeroLogAttr :: MonadIO m => m LogAttr

-- | Get the value of the “backspace_deletes_character” field.
--   When overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #backspaceDeletesCharacter
--   
getLogAttrBackspaceDeletesCharacter :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “backspace_deletes_character” field.
--   When overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #backspaceDeletesCharacter := value ]
--   
setLogAttrBackspaceDeletesCharacter :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “break_inserts_hyphen” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #breakInsertsHyphen
--   
getLogAttrBreakInsertsHyphen :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “break_inserts_hyphen” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #breakInsertsHyphen := value ]
--   
setLogAttrBreakInsertsHyphen :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “break_removes_preceding” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #breakRemovesPreceding
--   
getLogAttrBreakRemovesPreceding :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “break_removes_preceding” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #breakRemovesPreceding := value ]
--   
setLogAttrBreakRemovesPreceding :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_char_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isCharBreak
--   
getLogAttrIsCharBreak :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_char_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isCharBreak := value ]
--   
setLogAttrIsCharBreak :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_cursor_position” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isCursorPosition
--   
getLogAttrIsCursorPosition :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_cursor_position” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isCursorPosition := value ]
--   
setLogAttrIsCursorPosition :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_expandable_space” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isExpandableSpace
--   
getLogAttrIsExpandableSpace :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_expandable_space” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isExpandableSpace := value ]
--   
setLogAttrIsExpandableSpace :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_line_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isLineBreak
--   
getLogAttrIsLineBreak :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_line_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isLineBreak := value ]
--   
setLogAttrIsLineBreak :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_mandatory_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isMandatoryBreak
--   
getLogAttrIsMandatoryBreak :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_mandatory_break” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isMandatoryBreak := value ]
--   
setLogAttrIsMandatoryBreak :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_sentence_boundary” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isSentenceBoundary
--   
getLogAttrIsSentenceBoundary :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_sentence_boundary” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isSentenceBoundary := value ]
--   
setLogAttrIsSentenceBoundary :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_sentence_end” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isSentenceEnd
--   
getLogAttrIsSentenceEnd :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_sentence_end” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isSentenceEnd := value ]
--   
setLogAttrIsSentenceEnd :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_sentence_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isSentenceStart
--   
getLogAttrIsSentenceStart :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_sentence_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isSentenceStart := value ]
--   
setLogAttrIsSentenceStart :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_white” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isWhite
--   
getLogAttrIsWhite :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_white” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isWhite := value ]
--   
setLogAttrIsWhite :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_word_boundary” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isWordBoundary
--   
getLogAttrIsWordBoundary :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_word_boundary” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isWordBoundary := value ]
--   
setLogAttrIsWordBoundary :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_word_end” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isWordEnd
--   
getLogAttrIsWordEnd :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_word_end” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isWordEnd := value ]
--   
setLogAttrIsWordEnd :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “is_word_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #isWordStart
--   
getLogAttrIsWordStart :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “is_word_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #isWordStart := value ]
--   
setLogAttrIsWordStart :: MonadIO m => LogAttr -> Word32 -> m ()

-- | Get the value of the “reserved” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get logAttr #reserved
--   
getLogAttrReserved :: MonadIO m => LogAttr -> m Word32

-- | Set the value of the “reserved” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set logAttr [ #reserved := value ]
--   
setLogAttrReserved :: MonadIO m => LogAttr -> Word32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.LogAttr.LogAttr
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.LogAttr.LogAttr
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.LogAttr.LogAttr tag
instance GHC.Classes.Eq GI.Pango.Structs.LogAttr.LogAttr
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.LogAttr.LogAttr

-- | The PangoRectangle structure represents a rectangle.
--   
--   PangoRectangle is frequently used to represent the logical or
--   ink extents of a single glyph or section of text. (See, for instance,
--   fontGetGlyphExtents.)
module GI.Pango.Structs.Rectangle

-- | Memory-managed wrapper type.
newtype Rectangle
Rectangle :: ManagedPtr Rectangle -> Rectangle

-- | Construct a Rectangle struct initialized to zero.
newZeroRectangle :: MonadIO m => m Rectangle

-- | Get the value of the “height” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get rectangle #height
--   
getRectangleHeight :: MonadIO m => Rectangle -> m Int32

-- | Set the value of the “height” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set rectangle [ #height := value ]
--   
setRectangleHeight :: MonadIO m => Rectangle -> Int32 -> m ()

-- | Get the value of the “width” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get rectangle #width
--   
getRectangleWidth :: MonadIO m => Rectangle -> m Int32

-- | Set the value of the “width” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set rectangle [ #width := value ]
--   
setRectangleWidth :: MonadIO m => Rectangle -> Int32 -> m ()

-- | Get the value of the “x” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get rectangle #x
--   
getRectangleX :: MonadIO m => Rectangle -> m Int32

-- | Set the value of the “x” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set rectangle [ #x := value ]
--   
setRectangleX :: MonadIO m => Rectangle -> Int32 -> m ()

-- | Get the value of the “y” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get rectangle #y
--   
getRectangleY :: MonadIO m => Rectangle -> m Int32

-- | Set the value of the “y” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set rectangle [ #y := value ]
--   
setRectangleY :: MonadIO m => Rectangle -> Int32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.Rectangle.Rectangle
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.Rectangle.Rectangle
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.Rectangle.Rectangle tag
instance GHC.Classes.Eq GI.Pango.Structs.Rectangle.Rectangle
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Rectangle.Rectangle

-- | A PangoMatrix specifies a transformation between user-space
--   and device coordinates.
--   
--   The transformation is given by
--   
--   
--   x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0;
--   y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0;
--   
--   
--   Since: 1.6
module GI.Pango.Structs.Matrix

-- | Memory-managed wrapper type.
newtype Matrix
Matrix :: ManagedPtr Matrix -> Matrix

-- | Construct a Matrix struct initialized to zero.
newZeroMatrix :: MonadIO m => m Matrix

-- | Changes the transformation represented by matrix to be
--   the transformation given by first applying transformation given by
--   newMatrix then applying the original transformation.
--   
--   Since: 1.6
matrixConcat :: (HasCallStack, MonadIO m) => Matrix -> Matrix -> m ()

-- | Copies a PangoMatrix.
--   
--   Since: 1.6
matrixCopy :: (HasCallStack, MonadIO m) => Maybe Matrix -> m (Maybe Matrix)

-- | Free a PangoMatrix.
--   
--   Since: 1.6
matrixFree :: (HasCallStack, MonadIO m) => Maybe Matrix -> m ()

-- | Returns the scale factor of a matrix on the height of the font.
--   
--   That is, the scale factor in the direction perpendicular to the vector
--   that the X coordinate is mapped to. If the scale in the X coordinate
--   is needed as well, use matrixGetFontScaleFactors.
--   
--   Since: 1.12
matrixGetFontScaleFactor :: (HasCallStack, MonadIO m) => Maybe Matrix -> m Double

-- | Calculates the scale factor of a matrix on the width and height of the
--   font.
--   
--   That is, xscale is the scale factor in the direction
--   of the X coordinate, and yscale is the scale factor in
--   the direction perpendicular to the vector that the X coordinate is
--   mapped to.
--   
--   Note that output numbers will always be non-negative.
--   
--   Since: 1.38
matrixGetFontScaleFactors :: (HasCallStack, MonadIO m) => Maybe Matrix -> m (Double, Double)

-- | Gets the slant ratio of a matrix.
--   
--   For a simple shear matrix in the form:
--   
--   1 λ 0 1
--   
--   this is simply λ.
--   
--   Since: 1.50
matrixGetSlantRatio :: (HasCallStack, MonadIO m) => Matrix -> m Double

-- | Changes the transformation represented by matrix to be
--   the transformation given by first rotating by degrees
--   degrees counter-clockwise then applying the original transformation.
--   
--   Since: 1.6
matrixRotate :: (HasCallStack, MonadIO m) => Matrix -> Double -> m ()

-- | Changes the transformation represented by matrix to be
--   the transformation given by first scaling by sx in the
--   X direction and sy in the Y direction then applying
--   the original transformation.
--   
--   Since: 1.6
matrixScale :: (HasCallStack, MonadIO m) => Matrix -> Double -> Double -> m ()

-- | Transforms the distance vector (dx,dy)
--   by matrix.
--   
--   This is similar to matrixTransformPoint, except that the
--   translation components of the transformation are ignored. The
--   calculation of the returned vector is as follows:
--   
--   
--   dx2 = dx1 * xx + dy1 * xy;
--   dy2 = dx1 * yx + dy1 * yy;
--   
--   
--   Affine transformations are position invariant, so the same vector
--   always transforms to the same vector. If
--   (x1,y1) transforms to
--   (x2,y2) then
--   (x1+dx1,y1+dy1)
--   will transform to
--   (x1+dx2,y1+dy2)
--   for all values of x1 and x2.
--   
--   Since: 1.16
matrixTransformDistance :: (HasCallStack, MonadIO m) => Maybe Matrix -> Double -> Double -> m (Double, Double)

-- | First transforms the rect using
--   matrix, then calculates the bounding box of the
--   transformed rectangle.
--   
--   This function is useful for example when you want to draw a rotated
--   pangoLayout to an image buffer, and want to know how
--   large the image should be and how much you should shift the layout
--   when rendering.
--   
--   For better accuracy, you should use matrixTransformRectangle on
--   original rectangle in Pango units and convert to pixels afterward
--   using [funcextentsToPixels]'s first argument.
--   
--   Since: 1.16
matrixTransformPixelRectangle :: (HasCallStack, MonadIO m) => Maybe Matrix -> Maybe Rectangle -> m ()

-- | Transforms the point (x, y) by
--   matrix.
--   
--   Since: 1.16
matrixTransformPoint :: (HasCallStack, MonadIO m) => Maybe Matrix -> Double -> Double -> m (Double, Double)

-- | Changes the transformation represented by matrix to be
--   the transformation given by first translating by (tx,
--   ty) then applying the original transformation.
--   
--   Since: 1.6
matrixTranslate :: (HasCallStack, MonadIO m) => Matrix -> Double -> Double -> m ()

-- | Get the value of the “x0” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #x0
--   
getMatrixX0 :: MonadIO m => Matrix -> m Double

-- | Set the value of the “x0” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #x0 := value ]
--   
setMatrixX0 :: MonadIO m => Matrix -> Double -> m ()

-- | Get the value of the “xx” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #xx
--   
getMatrixXx :: MonadIO m => Matrix -> m Double

-- | Set the value of the “xx” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #xx := value ]
--   
setMatrixXx :: MonadIO m => Matrix -> Double -> m ()

-- | Get the value of the “xy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #xy
--   
getMatrixXy :: MonadIO m => Matrix -> m Double

-- | Set the value of the “xy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #xy := value ]
--   
setMatrixXy :: MonadIO m => Matrix -> Double -> m ()

-- | Get the value of the “y0” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #y0
--   
getMatrixY0 :: MonadIO m => Matrix -> m Double

-- | Set the value of the “y0” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #y0 := value ]
--   
setMatrixY0 :: MonadIO m => Matrix -> Double -> m ()

-- | Get the value of the “yx” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #yx
--   
getMatrixYx :: MonadIO m => Matrix -> m Double

-- | Set the value of the “yx” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #yx := value ]
--   
setMatrixYx :: MonadIO m => Matrix -> Double -> m ()

-- | Get the value of the “yy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get matrix #yy
--   
getMatrixYy :: MonadIO m => Matrix -> m Double

-- | Set the value of the “yy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set matrix [ #yy := value ]
--   
setMatrixYy :: MonadIO m => Matrix -> Double -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.Matrix.Matrix tag
instance GHC.Classes.Eq GI.Pango.Structs.Matrix.Matrix
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.Matrix.Matrix
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.Matrix.Matrix
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.Matrix.Matrix)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Matrix.Matrix
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.Matrix.Matrix

module GI.Pango.Callbacks

-- | No description available in the introspection data.
type AttrClassCopyFieldCallback = Attribute -> IO Attribute

-- | Type for the callback on the (unwrapped) C side.
type C_AttrClassCopyFieldCallback = Ptr Attribute -> IO Ptr Attribute

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_AttrClassCopyFieldCallback :: (HasCallStack, MonadIO m) => FunPtr C_AttrClassCopyFieldCallback -> Attribute -> m Attribute

-- | Wrap the callback into a GClosure.
genClosure_AttrClassCopyFieldCallback :: MonadIO m => AttrClassCopyFieldCallback -> m (GClosure C_AttrClassCopyFieldCallback)

-- | Generate a function pointer callable from C code, from a
--   C_AttrClassCopyFieldCallback.
mk_AttrClassCopyFieldCallback :: C_AttrClassCopyFieldCallback -> IO (FunPtr C_AttrClassCopyFieldCallback)

-- | A convenience synonym for Nothing :: Maybe
--   AttrClassCopyFieldCallback.
noAttrClassCopyFieldCallback :: Maybe AttrClassCopyFieldCallback

-- | Wrap a AttrClassCopyFieldCallback into a
--   C_AttrClassCopyFieldCallback.
wrap_AttrClassCopyFieldCallback :: Maybe (Ptr (FunPtr C_AttrClassCopyFieldCallback)) -> AttrClassCopyFieldCallback -> C_AttrClassCopyFieldCallback

-- | No description available in the introspection data.
type AttrClassDestroyFieldCallback = Attribute -> IO ()

-- | Type for the callback on the (unwrapped) C side.
type C_AttrClassDestroyFieldCallback = Ptr Attribute -> IO ()

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_AttrClassDestroyFieldCallback :: (HasCallStack, MonadIO m) => FunPtr C_AttrClassDestroyFieldCallback -> Attribute -> m ()

-- | Wrap the callback into a GClosure.
genClosure_AttrClassDestroyFieldCallback :: MonadIO m => AttrClassDestroyFieldCallback -> m (GClosure C_AttrClassDestroyFieldCallback)

-- | Generate a function pointer callable from C code, from a
--   C_AttrClassDestroyFieldCallback.
mk_AttrClassDestroyFieldCallback :: C_AttrClassDestroyFieldCallback -> IO (FunPtr C_AttrClassDestroyFieldCallback)

-- | A convenience synonym for Nothing :: Maybe
--   AttrClassDestroyFieldCallback.
noAttrClassDestroyFieldCallback :: Maybe AttrClassDestroyFieldCallback

-- | Wrap a AttrClassDestroyFieldCallback into a
--   C_AttrClassDestroyFieldCallback.
wrap_AttrClassDestroyFieldCallback :: Maybe (Ptr (FunPtr C_AttrClassDestroyFieldCallback)) -> AttrClassDestroyFieldCallback -> C_AttrClassDestroyFieldCallback

-- | No description available in the introspection data.
type AttrClassEqualFieldCallback = Attribute -> Attribute -> IO Bool

-- | Type for the callback on the (unwrapped) C side.
type C_AttrClassEqualFieldCallback = Ptr Attribute -> Ptr Attribute -> IO CInt

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_AttrClassEqualFieldCallback :: (HasCallStack, MonadIO m) => FunPtr C_AttrClassEqualFieldCallback -> Attribute -> Attribute -> m Bool

-- | Wrap the callback into a GClosure.
genClosure_AttrClassEqualFieldCallback :: MonadIO m => AttrClassEqualFieldCallback -> m (GClosure C_AttrClassEqualFieldCallback)

-- | Generate a function pointer callable from C code, from a
--   C_AttrClassEqualFieldCallback.
mk_AttrClassEqualFieldCallback :: C_AttrClassEqualFieldCallback -> IO (FunPtr C_AttrClassEqualFieldCallback)

-- | A convenience synonym for Nothing :: Maybe
--   AttrClassEqualFieldCallback.
noAttrClassEqualFieldCallback :: Maybe AttrClassEqualFieldCallback

-- | Wrap a AttrClassEqualFieldCallback into a
--   C_AttrClassEqualFieldCallback.
wrap_AttrClassEqualFieldCallback :: Maybe (Ptr (FunPtr C_AttrClassEqualFieldCallback)) -> AttrClassEqualFieldCallback -> C_AttrClassEqualFieldCallback

-- | Type of a function that can duplicate user data for an attribute.
type AttrDataCopyFunc = IO Ptr ()

-- | Type of a function that can duplicate user data for an attribute.
type AttrDataCopyFunc_WithClosures = Ptr () -> IO Ptr ()

-- | Type for the callback on the (unwrapped) C side.
type C_AttrDataCopyFunc = Ptr () -> IO Ptr ()

-- | A simple wrapper that ignores the closure arguments.
drop_closures_AttrDataCopyFunc :: AttrDataCopyFunc -> AttrDataCopyFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_AttrDataCopyFunc :: (HasCallStack, MonadIO m) => FunPtr C_AttrDataCopyFunc -> Ptr () -> m (Ptr ())

-- | Wrap the callback into a GClosure.
genClosure_AttrDataCopyFunc :: MonadIO m => AttrDataCopyFunc -> m (GClosure C_AttrDataCopyFunc)

-- | Generate a function pointer callable from C code, from a
--   C_AttrDataCopyFunc.
mk_AttrDataCopyFunc :: C_AttrDataCopyFunc -> IO (FunPtr C_AttrDataCopyFunc)

-- | A convenience synonym for Nothing :: Maybe
--   AttrDataCopyFunc.
noAttrDataCopyFunc :: Maybe AttrDataCopyFunc

-- | A convenience synonym for Nothing :: Maybe
--   AttrDataCopyFunc_WithClosures.
noAttrDataCopyFunc_WithClosures :: Maybe AttrDataCopyFunc_WithClosures

-- | Wrap a AttrDataCopyFunc into a C_AttrDataCopyFunc.
wrap_AttrDataCopyFunc :: Maybe (Ptr (FunPtr C_AttrDataCopyFunc)) -> AttrDataCopyFunc_WithClosures -> C_AttrDataCopyFunc

-- | Type of a function filtering a list of attributes.
type AttrFilterFunc = Attribute -> IO Bool

-- | Type of a function filtering a list of attributes.
type AttrFilterFunc_WithClosures = Attribute -> Ptr () -> IO Bool

-- | Type for the callback on the (unwrapped) C side.
type C_AttrFilterFunc = Ptr Attribute -> Ptr () -> IO CInt

-- | A simple wrapper that ignores the closure arguments.
drop_closures_AttrFilterFunc :: AttrFilterFunc -> AttrFilterFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_AttrFilterFunc :: (HasCallStack, MonadIO m) => FunPtr C_AttrFilterFunc -> Attribute -> Ptr () -> m Bool

-- | Wrap the callback into a GClosure.
genClosure_AttrFilterFunc :: MonadIO m => AttrFilterFunc -> m (GClosure C_AttrFilterFunc)

-- | Generate a function pointer callable from C code, from a
--   C_AttrFilterFunc.
mk_AttrFilterFunc :: C_AttrFilterFunc -> IO (FunPtr C_AttrFilterFunc)

-- | A convenience synonym for Nothing :: Maybe
--   AttrFilterFunc.
noAttrFilterFunc :: Maybe AttrFilterFunc

-- | A convenience synonym for Nothing :: Maybe
--   AttrFilterFunc_WithClosures.
noAttrFilterFunc_WithClosures :: Maybe AttrFilterFunc_WithClosures

-- | Wrap a AttrFilterFunc into a C_AttrFilterFunc.
wrap_AttrFilterFunc :: Maybe (Ptr (FunPtr C_AttrFilterFunc)) -> AttrFilterFunc_WithClosures -> C_AttrFilterFunc

-- | Type for the callback on the (unwrapped) C side.
type C_FontsetForeachFunc = Ptr Fontset -> Ptr Font -> Ptr () -> IO CInt

-- | Callback used when enumerating fonts in a fontset.
--   
--   See fontsetForeach.
--   
--   Since: 1.4
type FontsetForeachFunc = Fontset -> Font -> IO Bool

-- | Callback used when enumerating fonts in a fontset.
--   
--   See fontsetForeach.
--   
--   Since: 1.4
type FontsetForeachFunc_WithClosures = Fontset -> Font -> Ptr () -> IO Bool

-- | A simple wrapper that ignores the closure arguments.
drop_closures_FontsetForeachFunc :: FontsetForeachFunc -> FontsetForeachFunc_WithClosures

-- | Given a pointer to a foreign C function, wrap it into a function
--   callable from Haskell.
dynamic_FontsetForeachFunc :: (HasCallStack, MonadIO m, IsFontset a, IsFont b) => FunPtr C_FontsetForeachFunc -> a -> b -> Ptr () -> m Bool

-- | Wrap the callback into a GClosure.
genClosure_FontsetForeachFunc :: MonadIO m => FontsetForeachFunc -> m (GClosure C_FontsetForeachFunc)

-- | Generate a function pointer callable from C code, from a
--   C_FontsetForeachFunc.
mk_FontsetForeachFunc :: C_FontsetForeachFunc -> IO (FunPtr C_FontsetForeachFunc)

-- | A convenience synonym for Nothing :: Maybe
--   FontsetForeachFunc.
noFontsetForeachFunc :: Maybe FontsetForeachFunc

-- | A convenience synonym for Nothing :: Maybe
--   FontsetForeachFunc_WithClosures.
noFontsetForeachFunc_WithClosures :: Maybe FontsetForeachFunc_WithClosures

-- | Wrap a FontsetForeachFunc into a C_FontsetForeachFunc.
wrap_FontsetForeachFunc :: Maybe (Ptr (FunPtr C_FontsetForeachFunc)) -> FontsetForeachFunc_WithClosures -> C_FontsetForeachFunc

-- | The PangoItem structure stores information about a segment of
--   text.
--   
--   You typically obtain PangoItems by itemizing a piece of text
--   with [funcitemize].
module GI.Pango.Structs.Item

-- | Memory-managed wrapper type.
newtype Item
Item :: ManagedPtr Item -> Item

-- | Construct a Item struct initialized to zero.
newZeroItem :: MonadIO m => m Item

-- | Add attributes to a PangoItem.
--   
--   The idea is that you have attributes that don't affect itemization,
--   such as font features, so you filter them out using
--   attrListFilter, itemize your text, then reapply the attributes
--   to the resulting items using this function.
--   
--   The iter should be positioned before the range of the
--   item, and will be advanced past it. This function is meant to be
--   called in a loop over the items resulting from itemization, while
--   passing the iter to each call.
--   
--   Since: 1.44
itemApplyAttrs :: (HasCallStack, MonadIO m) => Item -> AttrIterator -> m ()

-- | Copy an existing PangoItem structure.
itemCopy :: (HasCallStack, MonadIO m) => Maybe Item -> m (Maybe Item)

-- | Free a PangoItem and all associated memory.
itemFree :: (HasCallStack, MonadIO m) => Maybe Item -> m ()

-- | Returns the character offset of the item from the beginning of the
--   itemized text.
--   
--   If the item has not been obtained from Pango's itemization machinery,
--   then the character offset is not available. In that case, this
--   function returns -1.
--   
--   Since: 1.54
itemGetCharOffset :: (HasCallStack, MonadIO m) => Item -> m Int32

-- | Creates a new PangoItem structure initialized to default
--   values.
itemNew :: (HasCallStack, MonadIO m) => m Item

-- | Modifies orig to cover only the text after
--   splitIndex, and returns a new item that covers the
--   text before splitIndex that used to be in
--   orig.
--   
--   You can think of splitIndex as the length of the
--   returned item. splitIndex may not be 0, and it may not
--   be greater than or equal to the length of orig (that
--   is, there must be at least one byte assigned to each item, you can't
--   create a zero-length item). splitOffset is the length
--   of the first item in chars, and must be provided because the text used
--   to generate the item isn't available, so pango_item_split()
--   can't count the char length of the split items itself.
itemSplit :: (HasCallStack, MonadIO m) => Item -> Int32 -> Int32 -> m Item

-- | Get the value of the “analysis” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get item #analysis
--   
getItemAnalysis :: MonadIO m => Item -> m Analysis

-- | Get the value of the “length” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get item #length
--   
getItemLength :: MonadIO m => Item -> m Int32

-- | Set the value of the “length” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set item [ #length := value ]
--   
setItemLength :: MonadIO m => Item -> Int32 -> m ()

-- | Get the value of the “num_chars” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get item #numChars
--   
getItemNumChars :: MonadIO m => Item -> m Int32

-- | Set the value of the “num_chars” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set item [ #numChars := value ]
--   
setItemNumChars :: MonadIO m => Item -> Int32 -> m ()

-- | Get the value of the “offset” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get item #offset
--   
getItemOffset :: MonadIO m => Item -> m Int32

-- | Set the value of the “offset” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set item [ #offset := value ]
--   
setItemOffset :: MonadIO m => Item -> Int32 -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.Item.Item tag
instance GHC.Classes.Eq GI.Pango.Structs.Item.Item
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.Item.Item
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.Item.Item
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.Item.Item)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Item.Item
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.Item.Item

-- | A PangoGlyphString is used to store strings of glyphs with
--   geometry and visual attribute information.
--   
--   The storage for the glyph information is owned by the structure which
--   simplifies memory management.
module GI.Pango.Structs.GlyphString

-- | Memory-managed wrapper type.
newtype GlyphString
GlyphString :: ManagedPtr GlyphString -> GlyphString

-- | Construct a GlyphString struct initialized to zero.
newZeroGlyphString :: MonadIO m => m GlyphString

-- | Copy a glyph string and associated storage.
glyphStringCopy :: (HasCallStack, MonadIO m) => Maybe GlyphString -> m (Maybe GlyphString)

-- | Compute the logical and ink extents of a glyph string.
--   
--   See the documentation for fontGetGlyphExtents for details about
--   the interpretation of the rectangles.
--   
--   Examples of logical (red) and ink (green) rects:
--   
glyphStringExtents :: (HasCallStack, MonadIO m, IsFont a) => GlyphString -> a -> m (Rectangle, Rectangle)

-- | Computes the extents of a sub-portion of a glyph string.
--   
--   The extents are relative to the start of the glyph string range (the
--   origin of their coordinate system is at the start of the range, not at
--   the start of the entire glyph string).
glyphStringExtentsRange :: (HasCallStack, MonadIO m, IsFont a) => GlyphString -> Int32 -> Int32 -> a -> m (Rectangle, Rectangle)

-- | Free a glyph string and associated storage.
glyphStringFree :: (HasCallStack, MonadIO m) => Maybe GlyphString -> m ()

-- | Computes the logical width of the glyph string.
--   
--   This can also be computed using glyphStringExtents. However,
--   since this only computes the width, it's much faster. This is in fact
--   only a convenience function that computes the sum of
--   geometry.width for each glyph in the
--   glyphs.
--   
--   Since: 1.14
glyphStringGetWidth :: (HasCallStack, MonadIO m) => GlyphString -> m Int32

-- | Converts from character position to x position.
--   
--   The X position is measured from the left edge of the run. Character
--   positions are obtained using font metrics for ligatures where
--   available, and computed by dividing up each cluster into equal
--   portions, otherwise.
--   
--   <picture> <source srcset="glyphstring-positions-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Glyph positions"
--   src="glyphstring-positions-light.png"> </picture>
glyphStringIndexToX :: (HasCallStack, MonadIO m) => GlyphString -> Text -> Int32 -> Analysis -> Int32 -> Bool -> m Int32

-- | Converts from character position to x position.
--   
--   This variant of glyphStringIndexToX additionally accepts a
--   PangoLogAttr array. The grapheme boundary information in it
--   can be used to disambiguate positioning inside some complex clusters.
--   
--   Since: 1.50
glyphStringIndexToXFull :: (HasCallStack, MonadIO m) => GlyphString -> Text -> Int32 -> Analysis -> Maybe LogAttr -> Int32 -> Bool -> m Int32

-- | Create a new PangoGlyphString.
glyphStringNew :: (HasCallStack, MonadIO m) => m GlyphString

-- | Resize a glyph string to the given length.
glyphStringSetSize :: (HasCallStack, MonadIO m) => GlyphString -> Int32 -> m ()

-- | Convert from x offset to character position.
--   
--   Character positions are computed by dividing up each cluster into
--   equal portions. In scripts where positioning within a cluster is not
--   allowed (such as Thai), the returned value may not be a valid cursor
--   position; the caller must combine the result with the logical
--   attributes for the text to compute the valid cursor position.
glyphStringXToIndex :: (HasCallStack, MonadIO m) => GlyphString -> Text -> Int32 -> Analysis -> Int32 -> m (Int32, Int32)

-- | Get the value of the “log_clusters” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphString #logClusters
--   
getGlyphStringLogClusters :: MonadIO m => GlyphString -> m Int32

-- | Set the value of the “log_clusters” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphString [ #logClusters := value ]
--   
setGlyphStringLogClusters :: MonadIO m => GlyphString -> Int32 -> m ()

-- | Get the value of the “num_glyphs” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphString #numGlyphs
--   
getGlyphStringNumGlyphs :: MonadIO m => GlyphString -> m Int32

-- | Set the value of the “num_glyphs” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphString [ #numGlyphs := value ]
--   
setGlyphStringNumGlyphs :: MonadIO m => GlyphString -> Int32 -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphString.GlyphString tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphString.GlyphString
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.GlyphString.GlyphString
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.GlyphString.GlyphString
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.GlyphString.GlyphString)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphString.GlyphString
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.GlyphString.GlyphString

-- | A PangoGlyphItemIter is an iterator over the clusters in a
--   PangoGlyphItem.
--   
--   The *forward direction* of the iterator is the logical direction of
--   text. That is, with increasing startIndex and
--   startChar values. If glyphItem is
--   right-to-left (that is, if
--   glyph_item->item->analysis.level is odd), then
--   startGlyph decreases as the iterator moves forward.
--   Moreover, in right-to-left cases, startGlyph is
--   greater than endGlyph.
--   
--   An iterator should be initialized using either
--   glyphItemIterInitStart or glyphItemIterInitEnd, for
--   forward and backward iteration respectively, and walked over using any
--   desired mixture of glyphItemIterNextCluster and
--   glyphItemIterPrevCluster.
--   
--   A common idiom for doing a forward iteration over the clusters is:
--   
--   
--   PangoGlyphItemIter cluster_iter;
--   gboolean have_cluster;
--   
--   for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter,
--                                                         glyph_item, text);
--        have_cluster;
--        have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter))
--   {
--     ...
--   }
--   
--   
--   Note that text is the start of the text for layout,
--   which is then indexed by glyph_item->item->offset to
--   get to the text of glyphItem. The
--   startIndex and endIndex values can
--   directly index into text. The
--   startGlyph, endGlyph,
--   startChar, and endChar values however
--   are zero-based for the glyphItem. For each cluster,
--   the item pointed at by the start variables is included in the cluster
--   while the one pointed at by end variables is not.
--   
--   None of the members of a PangoGlyphItemIter should be
--   modified manually.
--   
--   Since: 1.22
module GI.Pango.Structs.GlyphItemIter

-- | Memory-managed wrapper type.
newtype GlyphItemIter
GlyphItemIter :: ManagedPtr GlyphItemIter -> GlyphItemIter

-- | Construct a GlyphItemIter struct initialized to zero.
newZeroGlyphItemIter :: MonadIO m => m GlyphItemIter

-- | Make a shallow copy of an existing PangoGlyphItemIter
--   structure.
--   
--   Since: 1.22
glyphItemIterCopy :: (HasCallStack, MonadIO m) => Maybe GlyphItemIter -> m (Maybe GlyphItemIter)

-- | Frees a PangoGlyphItemIter.
--   
--   Since: 1.22
glyphItemIterFree :: (HasCallStack, MonadIO m) => Maybe GlyphItemIter -> m ()

-- | Initializes a PangoGlyphItemIter structure to point to the
--   last cluster in a glyph item.
--   
--   See PangoGlyphItemIter for details of cluster orders.
--   
--   Since: 1.22
glyphItemIterInitEnd :: (HasCallStack, MonadIO m) => GlyphItemIter -> GlyphItem -> Text -> m Bool

-- | Initializes a PangoGlyphItemIter structure to point to the
--   first cluster in a glyph item.
--   
--   See PangoGlyphItemIter for details of cluster orders.
--   
--   Since: 1.22
glyphItemIterInitStart :: (HasCallStack, MonadIO m) => GlyphItemIter -> GlyphItem -> Text -> m Bool

-- | Advances the iterator to the next cluster in the glyph item.
--   
--   See PangoGlyphItemIter for details of cluster orders.
--   
--   Since: 1.22
glyphItemIterNextCluster :: (HasCallStack, MonadIO m) => GlyphItemIter -> m Bool

-- | Moves the iterator to the preceding cluster in the glyph item. See
--   PangoGlyphItemIter for details of cluster orders.
--   
--   Since: 1.22
glyphItemIterPrevCluster :: (HasCallStack, MonadIO m) => GlyphItemIter -> m Bool

-- | Get the value of the “end_char” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #endChar
--   
getGlyphItemIterEndChar :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “end_char” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #endChar := value ]
--   
setGlyphItemIterEndChar :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Get the value of the “end_glyph” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #endGlyph
--   
getGlyphItemIterEndGlyph :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “end_glyph” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #endGlyph := value ]
--   
setGlyphItemIterEndGlyph :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Get the value of the “end_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #endIndex
--   
getGlyphItemIterEndIndex :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “end_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #endIndex := value ]
--   
setGlyphItemIterEndIndex :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Set the value of the “glyph_item” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #glyphItem
--   
clearGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> m ()

-- | Get the value of the “glyph_item” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #glyphItem
--   
getGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> m (Maybe GlyphItem)

-- | Set the value of the “glyph_item” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #glyphItem := value ]
--   
setGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> Ptr GlyphItem -> m ()

-- | Get the value of the “start_char” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #startChar
--   
getGlyphItemIterStartChar :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “start_char” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #startChar := value ]
--   
setGlyphItemIterStartChar :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Get the value of the “start_glyph” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #startGlyph
--   
getGlyphItemIterStartGlyph :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “start_glyph” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #startGlyph := value ]
--   
setGlyphItemIterStartGlyph :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Get the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItemIter #startIndex
--   
getGlyphItemIterStartIndex :: MonadIO m => GlyphItemIter -> m Int32

-- | Set the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #startIndex := value ]
--   
setGlyphItemIterStartIndex :: MonadIO m => GlyphItemIter -> Int32 -> m ()

-- | Set the value of the “text” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #text
--   
clearGlyphItemIterText :: MonadIO m => GlyphItemIter -> m ()

-- | Get the value of the “text” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get glyphItemIter #text
--   
getGlyphItemIterText :: MonadIO m => GlyphItemIter -> m (Maybe Text)

-- | Set the value of the “text” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set glyphItemIter [ #text := value ]
--   
setGlyphItemIterText :: MonadIO m => GlyphItemIter -> CString -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphItemIter.GlyphItemIter tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphItemIter.GlyphItemIter
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.GlyphItemIter.GlyphItemIter
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.GlyphItemIter.GlyphItemIter
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.GlyphItemIter.GlyphItemIter)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphItemIter.GlyphItemIter
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.GlyphItemIter.GlyphItemIter

-- | A PangoGlyphItem is a pair of a PangoItem and the
--   glyphs resulting from shaping the items text.
--   
--   As an example of the usage of PangoGlyphItem, the results of
--   shaping text with PangoLayout is a list of
--   PangoLayoutLine, each of which contains a list of
--   PangoGlyphItem.
module GI.Pango.Structs.GlyphItem

-- | Memory-managed wrapper type.
newtype GlyphItem
GlyphItem :: ManagedPtr GlyphItem -> GlyphItem

-- | Construct a GlyphItem struct initialized to zero.
newZeroGlyphItem :: MonadIO m => m GlyphItem

-- | Splits a shaped item (PangoGlyphItem) into multiple items
--   based on an attribute list.
--   
--   The idea is that if you have attributes that don't affect shaping,
--   such as color or underline, to avoid affecting shaping, you filter
--   them out (attrListFilter), apply the shaping process and then
--   reapply them to the result using this function.
--   
--   All attributes that start or end inside a cluster are applied to that
--   cluster; for instance, if half of a cluster is underlined and the
--   other-half strikethrough, then the cluster will end up with both
--   underline and strikethrough attributes. In these cases, it may happen
--   that item->extra_attrs for some of the result items
--   can have multiple attributes of the same type.
--   
--   This function takes ownership of glyphItem; it will be
--   reused as one of the elements in the list.
--   
--   Since: 1.2
glyphItemApplyAttrs :: (HasCallStack, MonadIO m) => GlyphItem -> Text -> AttrList -> m [GlyphItem]

-- | Make a deep copy of an existing PangoGlyphItem structure.
--   
--   Since: 1.20
glyphItemCopy :: (HasCallStack, MonadIO m) => Maybe GlyphItem -> m (Maybe GlyphItem)

-- | Frees a PangoGlyphItem and resources to which it points.
--   
--   Since: 1.6
glyphItemFree :: (HasCallStack, MonadIO m) => Maybe GlyphItem -> m ()

-- | Adds spacing between the graphemes of glyphItem to
--   give the effect of typographic letter spacing.
--   
--   Since: 1.6
glyphItemLetterSpace :: (HasCallStack, MonadIO m) => GlyphItem -> Text -> [LogAttr] -> Int32 -> m ()

-- | Modifies orig to cover only the text after
--   splitIndex, and returns a new item that covers the
--   text before splitIndex that used to be in
--   orig.
--   
--   You can think of splitIndex as the length of the
--   returned item. splitIndex may not be 0, and it may not
--   be greater than or equal to the length of orig (that
--   is, there must be at least one byte assigned to each item, you can't
--   create a zero-length item).
--   
--   This function is similar in function to itemSplit (and uses it
--   internally.)
--   
--   Since: 1.2
glyphItemSplit :: (HasCallStack, MonadIO m) => GlyphItem -> Text -> Int32 -> m (Maybe GlyphItem)

-- | Get the value of the “end_x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItem #endXOffset
--   
getGlyphItemEndXOffset :: MonadIO m => GlyphItem -> m Int32

-- | Set the value of the “end_x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItem [ #endXOffset := value ]
--   
setGlyphItemEndXOffset :: MonadIO m => GlyphItem -> Int32 -> m ()

-- | Set the value of the “glyphs” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #glyphs
--   
clearGlyphItemGlyphs :: MonadIO m => GlyphItem -> m ()

-- | Get the value of the “glyphs” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get glyphItem #glyphs
--   
getGlyphItemGlyphs :: MonadIO m => GlyphItem -> m (Maybe GlyphString)

-- | Set the value of the “glyphs” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set glyphItem [ #glyphs := value ]
--   
setGlyphItemGlyphs :: MonadIO m => GlyphItem -> Ptr GlyphString -> m ()

-- | Set the value of the “item” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #item
--   
clearGlyphItemItem :: MonadIO m => GlyphItem -> m ()

-- | Get the value of the “item” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get glyphItem #item
--   
getGlyphItemItem :: MonadIO m => GlyphItem -> m (Maybe Item)

-- | Set the value of the “item” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set glyphItem [ #item := value ]
--   
setGlyphItemItem :: MonadIO m => GlyphItem -> Ptr Item -> m ()

-- | Get the value of the “start_x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItem #startXOffset
--   
getGlyphItemStartXOffset :: MonadIO m => GlyphItem -> m Int32

-- | Set the value of the “start_x_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItem [ #startXOffset := value ]
--   
setGlyphItemStartXOffset :: MonadIO m => GlyphItem -> Int32 -> m ()

-- | Get the value of the “y_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get glyphItem #yOffset
--   
getGlyphItemYOffset :: MonadIO m => GlyphItem -> m Int32

-- | Set the value of the “y_offset” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set glyphItem [ #yOffset := value ]
--   
setGlyphItemYOffset :: MonadIO m => GlyphItem -> Int32 -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.GlyphItem.GlyphItem tag
instance GHC.Classes.Eq GI.Pango.Structs.GlyphItem.GlyphItem
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.GlyphItem.GlyphItem
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.GlyphItem.GlyphItem
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.GlyphItem.GlyphItem)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.GlyphItem.GlyphItem
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.GlyphItem.GlyphItem

-- | The PangoAttribute structure represents the common portions
--   of all attributes.
--   
--   Particular types of attributes include this structure as their initial
--   portion. The common portion of the attribute holds the range to which
--   the value in the type-specific part of the attribute applies and
--   should be initialized using attributeInit. By default, an
--   attribute will have an all-inclusive range of
--   [0,G_MAXUINT].
module GI.Pango.Structs.Attribute

-- | Memory-managed wrapper type.
newtype Attribute
Attribute :: ManagedPtr Attribute -> Attribute

-- | Returns the attribute cast to PangoAttrColor.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsColor :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrColor)

-- | Returns the attribute cast to PangoAttrFloat.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsFloat :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrFloat)

-- | Returns the attribute cast to PangoAttrFontDesc.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsFontDesc :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrFontDesc)

-- | Returns the attribute cast to PangoAttrFontFeatures.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsFontFeatures :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrFontFeatures)

-- | Returns the attribute cast to PangoAttrInt.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsInt :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrInt)

-- | Returns the attribute cast to PangoAttrLanguage.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsLanguage :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrLanguage)

-- | Returns the attribute cast to PangoAttrShape.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsShape :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrShape)

-- | Returns the attribute cast to PangoAttrSize.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsSize :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrSize)

-- | Returns the attribute cast to PangoAttrString.
--   
--   This is mainly useful for language bindings.
--   
--   Since: 1.50
attributeAsString :: (HasCallStack, MonadIO m) => Attribute -> m (Maybe AttrString)

-- | Make a copy of an attribute.
attributeCopy :: (HasCallStack, MonadIO m) => Attribute -> m Attribute

-- | Destroy a PangoAttribute and free all associated memory.
attributeDestroy :: (HasCallStack, MonadIO m) => Attribute -> m ()

-- | Compare two attributes for equality.
--   
--   This compares only the actual value of the two attributes and not the
--   ranges that the attributes apply to.
attributeEqual :: (HasCallStack, MonadIO m) => Attribute -> Attribute -> m Bool

-- | Initializes attr's klass to klass,
--   it's start_index to ATTR_INDEX_FROM_TEXT_BEGINNING and
--   end_index to ATTR_INDEX_TO_TEXT_END such that the attribute
--   applies to the entire text by default.
--   
--   Since: 1.20
attributeInit :: (HasCallStack, MonadIO m) => Attribute -> AttrClass -> m ()

-- | Get the value of the “end_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attribute #endIndex
--   
getAttributeEndIndex :: MonadIO m => Attribute -> m Word32

-- | Set the value of the “end_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attribute [ #endIndex := value ]
--   
setAttributeEndIndex :: MonadIO m => Attribute -> Word32 -> m ()

-- | Set the value of the “klass” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #klass
--   
clearAttributeKlass :: MonadIO m => Attribute -> m ()

-- | Get the value of the “klass” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attribute #klass
--   
getAttributeKlass :: MonadIO m => Attribute -> m (Maybe AttrClass)

-- | Set the value of the “klass” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attribute [ #klass := value ]
--   
setAttributeKlass :: MonadIO m => Attribute -> Ptr AttrClass -> m ()

-- | Get the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attribute #startIndex
--   
getAttributeStartIndex :: MonadIO m => Attribute -> m Word32

-- | Set the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attribute [ #startIndex := value ]
--   
setAttributeStartIndex :: MonadIO m => Attribute -> Word32 -> m ()
instance GHC.Classes.Eq GI.Pango.Structs.Attribute.Attribute
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.Attribute.Attribute
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.Attribute.Attribute
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.Attribute.Attribute)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Attribute.Attribute
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.Attribute.Attribute

-- | The PangoAttrString structure is used to represent attributes
--   with a string value.
module GI.Pango.Structs.AttrString

-- | Memory-managed wrapper type.
newtype AttrString
AttrString :: ManagedPtr AttrString -> AttrString

-- | Construct a AttrString struct initialized to zero.
newZeroAttrString :: MonadIO m => m AttrString

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrString #attr
--   
getAttrStringAttr :: MonadIO m => AttrString -> m Attribute

-- | Set the value of the “value” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #value
--   
clearAttrStringValue :: MonadIO m => AttrString -> m ()

-- | Get the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrString #value
--   
getAttrStringValue :: MonadIO m => AttrString -> m (Maybe Text)

-- | Set the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrString [ #value := value ]
--   
setAttrStringValue :: MonadIO m => AttrString -> CString -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrString.AttrString
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrString.AttrString
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrString.AttrString tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrString.AttrString
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrString.AttrString

-- | The PangoAttrSize structure is used to represent attributes
--   which set font size.
module GI.Pango.Structs.AttrSize

-- | Memory-managed wrapper type.
newtype AttrSize
AttrSize :: ManagedPtr AttrSize -> AttrSize

-- | Construct a AttrSize struct initialized to zero.
newZeroAttrSize :: MonadIO m => m AttrSize

-- | Create a new font-size attribute in fractional points.
attrSizeNew :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Create a new font-size attribute in device units.
--   
--   Since: 1.8
attrSizeNewAbsolute :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Get the value of the “absolute” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrSize #absolute
--   
getAttrSizeAbsolute :: MonadIO m => AttrSize -> m Word32

-- | Set the value of the “absolute” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attrSize [ #absolute := value ]
--   
setAttrSizeAbsolute :: MonadIO m => AttrSize -> Word32 -> m ()

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrSize #attr
--   
getAttrSizeAttr :: MonadIO m => AttrSize -> m Attribute

-- | Get the value of the “size” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrSize #size
--   
getAttrSizeSize :: MonadIO m => AttrSize -> m Int32

-- | Set the value of the “size” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set attrSize [ #size := value ]
--   
setAttrSizeSize :: MonadIO m => AttrSize -> Int32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrSize.AttrSize
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrSize.AttrSize
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrSize.AttrSize tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrSize.AttrSize
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrSize.AttrSize

-- | The PangoAttrShape structure is used to represent attributes
--   which impose shape restrictions.
module GI.Pango.Structs.AttrShape

-- | Memory-managed wrapper type.
newtype AttrShape
AttrShape :: ManagedPtr AttrShape -> AttrShape

-- | Construct a AttrShape struct initialized to zero.
newZeroAttrShape :: MonadIO m => m AttrShape

-- | Create a new shape attribute.
--   
--   A shape is used to impose a particular ink and logical rectangle on
--   the result of shaping a particular glyph. This might be used, for
--   instance, for embedding a picture or a widget inside a
--   PangoLayout.
attrShapeNew :: (HasCallStack, MonadIO m) => Rectangle -> Rectangle -> m Attribute

-- | Creates a new shape attribute.
--   
--   Like attrShapeNew, but a user data pointer is also provided;
--   this pointer can be accessed when later rendering the glyph.
--   
--   Since: 1.8
attrShapeNewWithData :: (HasCallStack, MonadIO m) => Rectangle -> Rectangle -> Ptr () -> Maybe AttrDataCopyFunc -> Maybe DestroyNotify -> m Attribute

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrShape #attr
--   
getAttrShapeAttr :: MonadIO m => AttrShape -> m Attribute

-- | Set the value of the “copy_func” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #copyFunc
--   
clearAttrShapeCopyFunc :: MonadIO m => AttrShape -> m ()

-- | Get the value of the “copy_func” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrShape #copyFunc
--   
getAttrShapeCopyFunc :: MonadIO m => AttrShape -> m (Maybe AttrDataCopyFunc_WithClosures)

-- | Set the value of the “copy_func” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attrShape [ #copyFunc := value ]
--   
setAttrShapeCopyFunc :: MonadIO m => AttrShape -> FunPtr C_AttrDataCopyFunc -> m ()

-- | Set the value of the “data” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #data
--   
clearAttrShapeData :: MonadIO m => AttrShape -> m ()

-- | Get the value of the “data” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrShape #data
--   
getAttrShapeData :: MonadIO m => AttrShape -> m (Ptr ())

-- | Set the value of the “data” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set attrShape [ #data := value ]
--   
setAttrShapeData :: MonadIO m => AttrShape -> Ptr () -> m ()

-- | Set the value of the “destroy_func” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #destroyFunc
--   
clearAttrShapeDestroyFunc :: MonadIO m => AttrShape -> m ()

-- | Get the value of the “destroy_func” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrShape #destroyFunc
--   
getAttrShapeDestroyFunc :: MonadIO m => AttrShape -> m (Maybe DestroyNotify)

-- | Set the value of the “destroy_func” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attrShape [ #destroyFunc := value ]
--   
setAttrShapeDestroyFunc :: MonadIO m => AttrShape -> FunPtr C_DestroyNotify -> m ()

-- | Get the value of the “ink_rect” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrShape #inkRect
--   
getAttrShapeInkRect :: MonadIO m => AttrShape -> m Rectangle

-- | Get the value of the “logical_rect” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrShape #logicalRect
--   
getAttrShapeLogicalRect :: MonadIO m => AttrShape -> m Rectangle
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrShape.AttrShape
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrShape.AttrShape
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrShape.AttrShape tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrShape.AttrShape
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrShape.AttrShape

-- | A PangoAttrList represents a list of attributes that apply to
--   a section of text.
--   
--   The attributes in a PangoAttrList are, in general, allowed to
--   overlap in an arbitrary fashion. However, if the attributes are
--   manipulated only through attrListChange, the overlap between
--   properties will meet stricter criteria.
--   
--   Since the PangoAttrList structure is stored as a linear list,
--   it is not suitable for storing attributes for large amounts of text.
--   In general, you should not use a single PangoAttrList for
--   more than one paragraph of text.
module GI.Pango.Structs.AttrList

-- | Memory-managed wrapper type.
newtype AttrList
AttrList :: ManagedPtr AttrList -> AttrList

-- | Insert the given attribute into the PangoAttrList.
--   
--   It will replace any attributes of the same type on that segment and be
--   merged with any adjoining attributes that are identical.
--   
--   This function is slower than attrListInsert for creating an
--   attribute list in order (potentially much slower for large lists).
--   However, attrListInsert is not suitable for continually
--   changing a set of attributes since it never removes or combines
--   existing attributes.
attrListChange :: (HasCallStack, MonadIO m) => AttrList -> Attribute -> m ()

-- | Copy list and return an identical new list.
attrListCopy :: (HasCallStack, MonadIO m) => Maybe AttrList -> m (Maybe AttrList)

-- | Checks whether list and otherList
--   contain the same attributes and whether those attributes apply to the
--   same ranges.
--   
--   Beware that this will return wrong values if any list contains
--   duplicates.
--   
--   Since: 1.46
attrListEqual :: (HasCallStack, MonadIO m) => AttrList -> AttrList -> m Bool

-- | Given a PangoAttrList and callback function, removes any
--   elements of list for which func
--   returns True and inserts them into a new list.
--   
--   Since: 1.2
attrListFilter :: (HasCallStack, MonadIO m) => AttrList -> AttrFilterFunc -> m (Maybe AttrList)

-- | Deserializes a PangoAttrList from a string.
--   
--   This is the counterpart to attrListToString. See that functions
--   for details about the format.
--   
--   Since: 1.50
attrListFromString :: (HasCallStack, MonadIO m) => Text -> m (Maybe AttrList)

-- | Gets a list of all attributes in list.
--   
--   Since: 1.44
attrListGetAttributes :: (HasCallStack, MonadIO m) => AttrList -> m [Attribute]

-- | Create a iterator initialized to the beginning of the list.
--   
--   list must not be modified until this iterator is
--   freed.
attrListGetIterator :: (HasCallStack, MonadIO m) => AttrList -> m AttrIterator

-- | Insert the given attribute into the PangoAttrList.
--   
--   It will be inserted after all other attributes with a matching
--   startIndex.
attrListInsert :: (HasCallStack, MonadIO m) => AttrList -> Attribute -> m ()

-- | Insert the given attribute into the PangoAttrList.
--   
--   It will be inserted before all other attributes with a matching
--   startIndex.
attrListInsertBefore :: (HasCallStack, MonadIO m) => AttrList -> Attribute -> m ()

-- | Create a new empty attribute list with a reference count of one.
attrListNew :: (HasCallStack, MonadIO m) => m AttrList

-- | Increase the reference count of the given attribute list by one.
--   
--   Since: 1.10
attrListRef :: (HasCallStack, MonadIO m) => Maybe AttrList -> m AttrList

-- | This function opens up a hole in list, fills it in
--   with attributes from the left, and then merges other
--   on top of the hole.
--   
--   This operation is equivalent to stretching every attribute that
--   applies at position pos in list by an
--   amount len, and then calling attrListChange
--   with a copy of each attribute in other in sequence
--   (offset in position by pos, and limited in length to
--   len).
--   
--   This operation proves useful for, for instance, inserting a pre-edit
--   string in the middle of an edit buffer.
--   
--   For backwards compatibility, the function behaves differently when
--   len is 0. In this case, the attributes from
--   other are not imited to len, and are
--   just overlayed on top of list.
--   
--   This mode is useful for merging two lists of attributes together.
attrListSplice :: (HasCallStack, MonadIO m) => AttrList -> AttrList -> Int32 -> Int32 -> m ()

-- | Serializes a PangoAttrList to a string.
--   
--   In the resulting string, serialized attributes are separated by
--   newlines or commas. Individual attributes are serialized to a string
--   of the form
--   
--   
--   
- START END TYPE VALUE
--   
--   
--   Where START and END are the indices (with -1 being accepted in place
--   of MAXUINT), TYPE is the nickname of the attribute value type, e.g.
--   _weight_ or _stretch_, and the value is serialized according to its
--   type:
--   
--   Optionally, START and END can be omitted to indicate unlimited extent.
--   
--   
--   
- enum values as nick or numeric value
--   
- boolean values as _true_ or _false_
--   
- integers and floats as numbers
--   
- strings as string, optionally quoted
--   
- font features as quoted string
--   
- PangoLanguage as string
--   
- PangoFontDescription as serialized by
--   fontDescriptionToString, quoted
--   
- PangoColor as serialized by colorToString
--   
--   
--   Examples:
--   
--   0 10 foreground red, 5 15 weight bold, 0 200 font-desc "Sans 10"
--   
--   0 -1 weight 700 0 100 family Times
--   
--   weight bold
--   
--   To parse the returned value, use attrListFromString.
--   
--   Note that shape attributes can not be serialized.
--   
--   Since: 1.50
attrListToString :: (HasCallStack, MonadIO m) => AttrList -> m Text

-- | Decrease the reference count of the given attribute list by one.
--   
--   If the result is zero, free the attribute list and the attributes it
--   contains.
attrListUnref :: (HasCallStack, MonadIO m) => Maybe AttrList -> m ()

-- | Update indices of attributes in list for a change in
--   the text they refer to.
--   
--   The change that this function applies is removing
--   remove bytes at position pos and
--   inserting add bytes instead.
--   
--   Attributes that fall entirely in the (pos,
--   pos + remove) range are removed.
--   
--   Attributes that start or end inside the (pos,
--   pos + remove) range are shortened to
--   reflect the removal.
--   
--   Attributes start and end positions are updated if they are behind
--   pos + remove.
--   
--   Since: 1.44
attrListUpdate :: (HasCallStack, MonadIO m) => AttrList -> Int32 -> Int32 -> Int32 -> m ()
instance GHC.Classes.Eq GI.Pango.Structs.AttrList.AttrList
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.AttrList.AttrList
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.AttrList.AttrList
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.AttrList.AttrList)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrList.AttrList
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.AttrList.AttrList

-- | The PangoAttrLanguage structure is used to represent
--   attributes that are languages.
module GI.Pango.Structs.AttrLanguage

-- | Memory-managed wrapper type.
newtype AttrLanguage
AttrLanguage :: ManagedPtr AttrLanguage -> AttrLanguage

-- | Construct a AttrLanguage struct initialized to zero.
newZeroAttrLanguage :: MonadIO m => m AttrLanguage

-- | Create a new language tag attribute.
attrLanguageNew :: (HasCallStack, MonadIO m) => Language -> m Attribute

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrLanguage #attr
--   
getAttrLanguageAttr :: MonadIO m => AttrLanguage -> m Attribute

-- | Set the value of the “value” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #value
--   
clearAttrLanguageValue :: MonadIO m => AttrLanguage -> m ()

-- | Get the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrLanguage #value
--   
getAttrLanguageValue :: MonadIO m => AttrLanguage -> m (Maybe Language)

-- | Set the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrLanguage [ #value := value ]
--   
setAttrLanguageValue :: MonadIO m => AttrLanguage -> Ptr Language -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrLanguage.AttrLanguage
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrLanguage.AttrLanguage
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrLanguage.AttrLanguage tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrLanguage.AttrLanguage
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrLanguage.AttrLanguage

-- | A PangoAttrIterator is used to iterate through a
--   PangoAttrList.
--   
--   A new iterator is created with attrListGetIterator. Once the
--   iterator is created, it can be advanced through the style changes in
--   the text using attrIteratorNext. At each style change, the
--   range of the current style segment and the attributes currently in
--   effect can be queried.
module GI.Pango.Structs.AttrIterator

-- | Memory-managed wrapper type.
newtype AttrIterator
AttrIterator :: ManagedPtr AttrIterator -> AttrIterator

-- | Copy a PangoAttrIterator.
attrIteratorCopy :: (HasCallStack, MonadIO m) => AttrIterator -> m AttrIterator

-- | Destroy a PangoAttrIterator and free all associated memory.
attrIteratorDestroy :: (HasCallStack, MonadIO m) => AttrIterator -> m ()

-- | Find the current attribute of a particular type at the iterator
--   location.
--   
--   When multiple attributes of the same type overlap, the attribute whose
--   range starts closest to the current location is used.
attrIteratorGet :: (HasCallStack, MonadIO m) => AttrIterator -> AttrType -> m (Maybe Attribute)

-- | Gets a list of all attributes at the current position of the iterator.
--   
--   Since: 1.2
attrIteratorGetAttrs :: (HasCallStack, MonadIO m) => AttrIterator -> m [Attribute]

-- | Get the font and other attributes at the current iterator position.
attrIteratorGetFont :: (HasCallStack, MonadIO m) => AttrIterator -> FontDescription -> m (Maybe Language, [Attribute])

-- | Advance the iterator until the next change of style.
attrIteratorNext :: (HasCallStack, MonadIO m) => AttrIterator -> m Bool

-- | Get the range of the current segment.
--   
--   Note that the stored return values are signed, not unsigned like the
--   values in PangoAttribute. To deal with this API oversight,
--   stored return values that wouldn't fit into a signed integer are
--   clamped to G_MAXINT.
attrIteratorRange :: (HasCallStack, MonadIO m) => AttrIterator -> m (Int32, Int32)
instance GHC.Classes.Eq GI.Pango.Structs.AttrIterator.AttrIterator
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.AttrIterator.AttrIterator
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.AttrIterator.AttrIterator
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.AttrIterator.AttrIterator)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrIterator.AttrIterator
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.AttrIterator.AttrIterator

-- | The PangoAttrInt structure is used to represent attributes
--   with an integer or enumeration value.
module GI.Pango.Structs.AttrInt

-- | Memory-managed wrapper type.
newtype AttrInt
AttrInt :: ManagedPtr AttrInt -> AttrInt

-- | Construct a AttrInt struct initialized to zero.
newZeroAttrInt :: MonadIO m => m AttrInt

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrInt #attr
--   
getAttrIntAttr :: MonadIO m => AttrInt -> m Attribute

-- | Get the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrInt #value
--   
getAttrIntValue :: MonadIO m => AttrInt -> m Int32

-- | Set the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrInt [ #value := value ]
--   
setAttrIntValue :: MonadIO m => AttrInt -> Int32 -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrInt.AttrInt
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrInt.AttrInt
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrInt.AttrInt tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrInt.AttrInt
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrInt.AttrInt

-- | The PangoAttrFontFeatures structure is used to represent
--   OpenType font features as an attribute.
--   
--   Since: 1.38
module GI.Pango.Structs.AttrFontFeatures

-- | Memory-managed wrapper type.
newtype AttrFontFeatures
AttrFontFeatures :: ManagedPtr AttrFontFeatures -> AttrFontFeatures

-- | Construct a AttrFontFeatures struct initialized to zero.
newZeroAttrFontFeatures :: MonadIO m => m AttrFontFeatures

-- | Create a new font features tag attribute.
--   
--   You can use this attribute to select OpenType font features like
--   small-caps, alternative glyphs, ligatures, etc. for fonts that support
--   them.
--   
--   Since: 1.38
attrFontFeaturesNew :: (HasCallStack, MonadIO m) => Text -> m Attribute

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrFontFeatures #attr
--   
getAttrFontFeaturesAttr :: MonadIO m => AttrFontFeatures -> m Attribute

-- | Set the value of the “features” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #features
--   
clearAttrFontFeaturesFeatures :: MonadIO m => AttrFontFeatures -> m ()

-- | Get the value of the “features” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get attrFontFeatures #features
--   
getAttrFontFeaturesFeatures :: MonadIO m => AttrFontFeatures -> m (Maybe Text)

-- | Set the value of the “features” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set attrFontFeatures [ #features := value ]
--   
setAttrFontFeaturesFeatures :: MonadIO m => AttrFontFeatures -> CString -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrFontFeatures.AttrFontFeatures
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrFontFeatures.AttrFontFeatures
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrFontFeatures.AttrFontFeatures tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrFontFeatures.AttrFontFeatures
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrFontFeatures.AttrFontFeatures

-- | The PangoAttrFontDesc structure is used to store an attribute
--   that sets all aspects of the font description at once.
module GI.Pango.Structs.AttrFontDesc

-- | Memory-managed wrapper type.
newtype AttrFontDesc
AttrFontDesc :: ManagedPtr AttrFontDesc -> AttrFontDesc

-- | Construct a AttrFontDesc struct initialized to zero.
newZeroAttrFontDesc :: MonadIO m => m AttrFontDesc

-- | Create a new font description attribute.
--   
--   This attribute allows setting family, style, weight, variant, stretch,
--   and size simultaneously.
attrFontDescNew :: (HasCallStack, MonadIO m) => FontDescription -> m Attribute

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrFontDesc #attr
--   
getAttrFontDescAttr :: MonadIO m => AttrFontDesc -> m Attribute

-- | Set the value of the “desc” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #desc
--   
clearAttrFontDescDesc :: MonadIO m => AttrFontDesc -> m ()

-- | Get the value of the “desc” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrFontDesc #desc
--   
getAttrFontDescDesc :: MonadIO m => AttrFontDesc -> m (Maybe FontDescription)

-- | Set the value of the “desc” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set attrFontDesc [ #desc := value ]
--   
setAttrFontDescDesc :: MonadIO m => AttrFontDesc -> Ptr FontDescription -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrFontDesc.AttrFontDesc
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrFontDesc.AttrFontDesc
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrFontDesc.AttrFontDesc tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrFontDesc.AttrFontDesc
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrFontDesc.AttrFontDesc

-- | The PangoAttrFloat structure is used to represent attributes
--   with a float or double value.
module GI.Pango.Structs.AttrFloat

-- | Memory-managed wrapper type.
newtype AttrFloat
AttrFloat :: ManagedPtr AttrFloat -> AttrFloat

-- | Construct a AttrFloat struct initialized to zero.
newZeroAttrFloat :: MonadIO m => m AttrFloat

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrFloat #attr
--   
getAttrFloatAttr :: MonadIO m => AttrFloat -> m Attribute

-- | Get the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrFloat #value
--   
getAttrFloatValue :: MonadIO m => AttrFloat -> m Double

-- | Set the value of the “value” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrFloat [ #value := value ]
--   
setAttrFloatValue :: MonadIO m => AttrFloat -> Double -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrFloat.AttrFloat
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrFloat.AttrFloat
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrFloat.AttrFloat tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrFloat.AttrFloat
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrFloat.AttrFloat

-- | The PangoAttrColor structure is used to represent attributes
--   that are colors.
module GI.Pango.Structs.AttrColor

-- | Memory-managed wrapper type.
newtype AttrColor
AttrColor :: ManagedPtr AttrColor -> AttrColor

-- | Construct a AttrColor struct initialized to zero.
newZeroAttrColor :: MonadIO m => m AttrColor

-- | Get the value of the “attr” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrColor #attr
--   
getAttrColorAttr :: MonadIO m => AttrColor -> m Attribute

-- | Get the value of the “color” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrColor #color
--   
getAttrColorColor :: MonadIO m => AttrColor -> m Color
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrColor.AttrColor
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrColor.AttrColor
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrColor.AttrColor tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrColor.AttrColor
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrColor.AttrColor

-- | The PangoAttrClass structure stores the type and operations
--   for a particular type of attribute.
--   
--   The functions in this structure should not be called directly.
--   Instead, one should use the wrapper functions provided for
--   PangoAttribute.
module GI.Pango.Structs.AttrClass

-- | Memory-managed wrapper type.
newtype AttrClass
AttrClass :: ManagedPtr AttrClass -> AttrClass

-- | Construct a AttrClass struct initialized to zero.
newZeroAttrClass :: MonadIO m => m AttrClass

-- | Set the value of the “copy” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #copy
--   
clearAttrClassCopy :: MonadIO m => AttrClass -> m ()

-- | Get the value of the “copy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrClass #copy
--   
getAttrClassCopy :: MonadIO m => AttrClass -> m (Maybe AttrClassCopyFieldCallback)

-- | Set the value of the “copy” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set attrClass [ #copy := value ]
--   
setAttrClassCopy :: MonadIO m => AttrClass -> FunPtr C_AttrClassCopyFieldCallback -> m ()

-- | Set the value of the “destroy” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #destroy
--   
clearAttrClassDestroy :: MonadIO m => AttrClass -> m ()

-- | Get the value of the “destroy” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrClass #destroy
--   
getAttrClassDestroy :: MonadIO m => AttrClass -> m (Maybe AttrClassDestroyFieldCallback)

-- | Set the value of the “destroy” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrClass [ #destroy := value ]
--   
setAttrClassDestroy :: MonadIO m => AttrClass -> FunPtr C_AttrClassDestroyFieldCallback -> m ()

-- | Set the value of the “equal” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #equal
--   
clearAttrClassEqual :: MonadIO m => AttrClass -> m ()

-- | Get the value of the “equal” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get attrClass #equal
--   
getAttrClassEqual :: MonadIO m => AttrClass -> m (Maybe AttrClassEqualFieldCallback)

-- | Set the value of the “equal” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set attrClass [ #equal := value ]
--   
setAttrClassEqual :: MonadIO m => AttrClass -> FunPtr C_AttrClassEqualFieldCallback -> m ()

-- | Get the value of the “type” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get attrClass #type
--   
getAttrClassType :: MonadIO m => AttrClass -> m AttrType

-- | Set the value of the “type” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set attrClass [ #type := value ]
--   
setAttrClassType :: MonadIO m => AttrClass -> AttrType -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.AttrClass.AttrClass
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.AttrClass.AttrClass
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.AttrClass.AttrClass tag
instance GHC.Classes.Eq GI.Pango.Structs.AttrClass.AttrClass
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.AttrClass.AttrClass

-- | The PangoAnalysis structure stores information about the
--   properties of a segment of text.
module GI.Pango.Structs.Analysis

-- | Memory-managed wrapper type.
newtype Analysis
Analysis :: ManagedPtr Analysis -> Analysis

-- | Construct a Analysis struct initialized to zero.
newZeroAnalysis :: MonadIO m => m Analysis

-- | Set the value of the “extra_attrs” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #extraAttrs
--   
clearAnalysisExtraAttrs :: MonadIO m => Analysis -> m ()

-- | Get the value of the “extra_attrs” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get analysis #extraAttrs
--   
getAnalysisExtraAttrs :: MonadIO m => Analysis -> m [Ptr ()]

-- | Set the value of the “extra_attrs” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set analysis [ #extraAttrs := value ]
--   
setAnalysisExtraAttrs :: MonadIO m => Analysis -> Ptr (GSList (Ptr ())) -> m ()

-- | Get the value of the “flags” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get analysis #flags
--   
getAnalysisFlags :: MonadIO m => Analysis -> m Word8

-- | Set the value of the “flags” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set analysis [ #flags := value ]
--   
setAnalysisFlags :: MonadIO m => Analysis -> Word8 -> m ()

-- | Set the value of the “font” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #font
--   
clearAnalysisFont :: MonadIO m => Analysis -> m ()

-- | Get the value of the “font” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get analysis #font
--   
getAnalysisFont :: MonadIO m => Analysis -> m (Maybe Font)

-- | Set the value of the “font” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set analysis [ #font := value ]
--   
setAnalysisFont :: MonadIO m => Analysis -> Ptr Font -> m ()

-- | Get the value of the “gravity” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get analysis #gravity
--   
getAnalysisGravity :: MonadIO m => Analysis -> m Word8

-- | Set the value of the “gravity” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set analysis [ #gravity := value ]
--   
setAnalysisGravity :: MonadIO m => Analysis -> Word8 -> m ()

-- | Set the value of the “lang_engine” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #langEngine
--   
clearAnalysisLangEngine :: MonadIO m => Analysis -> m ()

-- | Get the value of the “lang_engine” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get analysis #langEngine
--   
getAnalysisLangEngine :: MonadIO m => Analysis -> m (Ptr ())

-- | Set the value of the “lang_engine” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set analysis [ #langEngine := value ]
--   
setAnalysisLangEngine :: MonadIO m => Analysis -> Ptr () -> m ()

-- | Set the value of the “language” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #language
--   
clearAnalysisLanguage :: MonadIO m => Analysis -> m ()

-- | Get the value of the “language” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get analysis #language
--   
getAnalysisLanguage :: MonadIO m => Analysis -> m (Maybe Language)

-- | Set the value of the “language” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set analysis [ #language := value ]
--   
setAnalysisLanguage :: MonadIO m => Analysis -> Ptr Language -> m ()

-- | Get the value of the “level” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get analysis #level
--   
getAnalysisLevel :: MonadIO m => Analysis -> m Word8

-- | Set the value of the “level” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set analysis [ #level := value ]
--   
setAnalysisLevel :: MonadIO m => Analysis -> Word8 -> m ()

-- | Get the value of the “script” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get analysis #script
--   
getAnalysisScript :: MonadIO m => Analysis -> m Word8

-- | Set the value of the “script” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set analysis [ #script := value ]
--   
setAnalysisScript :: MonadIO m => Analysis -> Word8 -> m ()

-- | Set the value of the “shape_engine” field to Nothing.
--   When overloading is enabled, this is equivalent to
--   
--   
--   clear #shapeEngine
--   
clearAnalysisShapeEngine :: MonadIO m => Analysis -> m ()

-- | Get the value of the “shape_engine” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get analysis #shapeEngine
--   
getAnalysisShapeEngine :: MonadIO m => Analysis -> m (Ptr ())

-- | Set the value of the “shape_engine” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set analysis [ #shapeEngine := value ]
--   
setAnalysisShapeEngine :: MonadIO m => Analysis -> Ptr () -> m ()
instance Data.GI.Base.BasicTypes.BoxedPtr GI.Pango.Structs.Analysis.Analysis
instance Data.GI.Base.BasicTypes.CallocPtr GI.Pango.Structs.Analysis.Analysis
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.Analysis.Analysis tag
instance GHC.Classes.Eq GI.Pango.Structs.Analysis.Analysis
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.Analysis.Analysis

-- | PangoFontsetSimple is a implementation of the abstract
--   PangoFontset base class as an array of fonts.
--   
--   When creating a PangoFontsetSimple, you have to provide the
--   array of fonts that make up the fontset.
module GI.Pango.Objects.FontsetSimple

-- | Memory-managed wrapper type.
newtype FontsetSimple
FontsetSimple :: ManagedPtr FontsetSimple -> FontsetSimple

-- | Type class for types which can be safely cast to FontsetSimple,
--   for instance with toFontsetSimple.
class (GObject o, IsDescendantOf FontsetSimple o) => IsFontsetSimple o

-- | Cast to FontsetSimple, for types for which this is known to be
--   safe. For general casts, use castTo.
toFontsetSimple :: (MonadIO m, IsFontsetSimple o) => o -> m FontsetSimple

-- | Adds a font to the fontset.
--   
--   The fontset takes ownership of font.
fontsetSimpleAppend :: (HasCallStack, MonadIO m, IsFontsetSimple a, IsFont b) => a -> b -> m ()

-- | Creates a new PangoFontsetSimple for the given language.
fontsetSimpleNew :: (HasCallStack, MonadIO m) => Language -> m FontsetSimple

-- | Returns the number of fonts in the fontset.
fontsetSimpleSize :: (HasCallStack, MonadIO m, IsFontsetSimple a) => a -> m Int32
instance GHC.Classes.Eq GI.Pango.Objects.FontsetSimple.FontsetSimple
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.FontsetSimple.FontsetSimple
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.FontsetSimple.FontsetSimple
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.FontsetSimple.FontsetSimple o) => GI.Pango.Objects.FontsetSimple.IsFontsetSimple o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.FontsetSimple.FontsetSimple)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.FontsetSimple.FontsetSimple
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.FontsetSimple.FontsetSimple

-- | A PangoFontset represents a set of PangoFont to use
--   when rendering text.
--   
--   A PangoFontset is the result of resolving a
--   PangoFontDescription against a particular
--   PangoContext. It has operations for finding the component
--   font for a particular Unicode character, and for finding a composite
--   set of metrics for the entire fontset.
module GI.Pango.Objects.Fontset

-- | Memory-managed wrapper type.
newtype Fontset
Fontset :: ManagedPtr Fontset -> Fontset

-- | Type class for types which can be safely cast to Fontset, for
--   instance with toFontset.
class (GObject o, IsDescendantOf Fontset o) => IsFontset o

-- | Cast to Fontset, for types for which this is known to be safe.
--   For general casts, use castTo.
toFontset :: (MonadIO m, IsFontset o) => o -> m Fontset

-- | Iterates through all the fonts in a fontset, calling
--   func for each one.
--   
--   If func returns True, that stops the iteration.
--   
--   Since: 1.4
fontsetForeach :: (HasCallStack, MonadIO m, IsFontset a) => a -> FontsetForeachFunc -> m ()

-- | Returns the font in the fontset that contains the best glyph for a
--   Unicode character.
fontsetGetFont :: (HasCallStack, MonadIO m, IsFontset a) => a -> Word32 -> m Font

-- | Get overall metric information for the fonts in the fontset.
fontsetGetMetrics :: (HasCallStack, MonadIO m, IsFontset a) => a -> m FontMetrics
instance GHC.Classes.Eq GI.Pango.Objects.Fontset.Fontset
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Fontset.Fontset
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Fontset.Fontset
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Fontset.Fontset o) => GI.Pango.Objects.Fontset.IsFontset o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Fontset.Fontset)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Fontset.Fontset
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Fontset.Fontset

-- | A PangoFontMap represents the set of fonts available for a
--   particular rendering system.
--   
--   This is a virtual object with implementations being specific to
--   particular rendering systems.
module GI.Pango.Objects.FontMap

-- | Memory-managed wrapper type.
newtype FontMap
FontMap :: ManagedPtr FontMap -> FontMap

-- | Type class for types which can be safely cast to FontMap, for
--   instance with toFontMap.
class (GObject o, IsDescendantOf FontMap o) => IsFontMap o

-- | Cast to FontMap, for types for which this is known to be safe.
--   For general casts, use castTo.
toFontMap :: (MonadIO m, IsFontMap o) => o -> m FontMap

-- | Loads a font file with one or more fonts into the
--   PangoFontMap.
--   
--   The added fonts will take precedence over preexisting fonts with the
--   same name.
--   
--   Since: 1.56
fontMapAddFontFile :: (HasCallStack, MonadIO m, IsFontMap a) => a -> [Char] -> m ()

-- | Forces a change in the fontmap, which will cause any
--   PangoContext using this fontmap to change.
--   
--   This function is only useful when implementing a new backend for
--   Pango, something applications won't do. Backends should call this
--   function if they have attached extra data to the fontmap and such data
--   is changed.
--   
--   Since: 1.34
fontMapChanged :: (HasCallStack, MonadIO m, IsFontMap a) => a -> m ()

-- | Creates a PangoContext connected to fontmap.
--   
--   This is equivalent to contextNew followed by
--   contextSetFontMap.
--   
--   If you are using Pango as part of a higher-level system, that system
--   may have it's own way of create a PangoContext. For instance,
--   the GTK toolkit has, among others,
--   gtk_widget_get_pango_context(). Use those instead.
--   
--   Since: 1.22
fontMapCreateContext :: (HasCallStack, MonadIO m, IsFontMap a) => a -> m Context

-- | Gets a font family by name.
--   
--   Since: 1.46
fontMapGetFamily :: (HasCallStack, MonadIO m, IsFontMap a) => a -> Text -> m FontFamily

-- | Returns the current serial number of fontmap.
--   
--   The serial number is initialized to an small number larger than zero
--   when a new fontmap is created and is increased whenever the fontmap is
--   changed. It may wrap, but will never have the value 0. Since it can
--   wrap, never compare it with "less than", always use "not equals".
--   
--   The fontmap can only be changed using backend-specific API, like
--   changing fontmap resolution.
--   
--   This can be used to automatically detect changes to a
--   PangoFontMap, like in PangoContext.
--   
--   Since: 1.32.4
fontMapGetSerial :: (HasCallStack, MonadIO m, IsFontMap a) => a -> m Word32

-- | List all families for a fontmap.
--   
--   Note that the returned families are not in any particular order.
--   
--   PangoFontMap also implemented the ListModel interface
--   for enumerating families.
fontMapListFamilies :: (HasCallStack, MonadIO m, IsFontMap a) => a -> m [FontFamily]

-- | Load the font in the fontmap that is the closest match for
--   desc.
fontMapLoadFont :: (HasCallStack, MonadIO m, IsFontMap a, IsContext b) => a -> b -> FontDescription -> m (Maybe Font)

-- | Load a set of fonts in the fontmap that can be used to render a font
--   matching desc.
fontMapLoadFontset :: (HasCallStack, MonadIO m, IsFontMap a, IsContext b) => a -> b -> FontDescription -> Language -> m (Maybe Fontset)

-- | Returns a new font that is like font, except that it
--   is scaled by scale, its backend-dependent
--   configuration (e.g. cairo font options) is replaced by the one in
--   context, and its variations are replaced by
--   variations.
--   
--   Note that the scaling here is meant to be linear, so this scaling can
--   be used to render a font on a hi-dpi display without changing its
--   optical size.
--   
--   Since: 1.52
fontMapReloadFont :: (HasCallStack, MonadIO m, IsFontMap a, IsFont b, IsContext c) => a -> b -> Double -> Maybe c -> Maybe Text -> m Font

-- | Get the value of the “item-type” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontMap #itemType
--   
getFontMapItemType :: (MonadIO m, IsFontMap o) => o -> m GType

-- | Get the value of the “n-items” property. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get fontMap #nItems
--   
getFontMapNItems :: (MonadIO m, IsFontMap o) => o -> m Word32
instance GHC.Classes.Eq GI.Pango.Objects.FontMap.FontMap
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.FontMap.FontMap
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.FontMap.FontMap
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.FontMap.FontMap o) => GI.Pango.Objects.FontMap.IsFontMap o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.FontMap.FontMap)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.FontMap.FontMap
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.FontMap.FontMap

-- | A PangoFont is used to represent a font in a
--   rendering-system-independent manner.
module GI.Pango.Objects.Font

-- | Memory-managed wrapper type.
newtype Font
Font :: ManagedPtr Font -> Font

-- | Type class for types which can be safely cast to Font, for
--   instance with toFont.
class (GObject o, IsDescendantOf Font o) => IsFont o

-- | Cast to Font, for types for which this is known to be safe. For
--   general casts, use castTo.
toFont :: (MonadIO m, IsFont o) => o -> m Font

-- | Returns a description of the font, with font size set in points.
--   
--   Use fontDescribeWithAbsoluteSize if you want the font size in
--   device units.
fontDescribe :: (HasCallStack, MonadIO m, IsFont a) => a -> m FontDescription

-- | Returns a description of the font, with absolute font size set in
--   device units.
--   
--   Use fontDescribe if you want the font size in points.
--   
--   Since: 1.14
fontDescribeWithAbsoluteSize :: (HasCallStack, MonadIO m, IsFont a) => a -> m FontDescription

-- | Frees an array of font descriptions.

-- | Deprecated: (Since version 1.56)Just use
--   pango_font_description_free in a loop
fontDescriptionsFree :: (HasCallStack, MonadIO m) => Maybe [FontDescription] -> m ()

-- | Loads data previously created via fontSerialize.
--   
--   For a discussion of the supported format, see that function.
--   
--   Note: to verify that the returned font is identical to the one that
--   was serialized, you can compare bytes to the result of
--   serializing the font again.
--   
--   Since: 1.50
fontDeserialize :: (HasCallStack, MonadIO m, IsContext a) => a -> Bytes -> m (Maybe Font)

-- | Computes the coverage map for a given font and language tag.
fontGetCoverage :: (HasCallStack, MonadIO m, IsFont a) => a -> Language -> m Coverage

-- | Gets the PangoFontFace to which font belongs.
--   
--   Note that this function can return NULL in cases where the
--   font outlives its font map.
--   
--   Since: 1.46
fontGetFace :: (HasCallStack, MonadIO m, IsFont a) => a -> m (Maybe FontFace)

-- | Obtain the OpenType features that are provided by the font.
--   
--   These are passed to the rendering system, together with features that
--   have been explicitly set via attributes.
--   
--   Note that this does not include OpenType features which the rendering
--   system enables by default.
--   
--   Since: 1.44
fontGetFeatures :: (HasCallStack, MonadIO m, IsFont a) => a -> [FeatureT] -> Word32 -> m ([FeatureT], Word32)

-- | Gets the font map for which the font was created.
--   
--   Note that the font maintains a *weak* reference to the font map, so if
--   all references to font map are dropped, the font map will be finalized
--   even if there are fonts created with the font map that are still
--   alive. In that case this function will return Nothing.
--   
--   It is the responsibility of the user to ensure that the font map is
--   kept alive. In most uses this is not an issue as a
--   PangoContext holds a reference to the font map.
--   
--   Since: 1.10
fontGetFontMap :: (HasCallStack, MonadIO m, IsFont a) => Maybe a -> m (Maybe FontMap)

-- | Gets the logical and ink extents of a glyph within a font.
--   
--   The coordinate system for each rectangle has its origin at the base
--   line and horizontal origin of the character with increasing
--   coordinates extending to the right and down. The macros
--   PANGO_ASCENT(), PANGO_DESCENT(),
--   PANGO_LBEARING(), and PANGO_RBEARING()
--   can be used to convert from the extents rectangle to more traditional
--   font metrics. The units of the rectangles are in 1/PANGO_SCALE of a
--   device unit.
--   
--   If font is Nothing, this function gracefully
--   sets some sane values in the output variables and returns.
fontGetGlyphExtents :: (HasCallStack, MonadIO m, IsFont a) => Maybe a -> Word32 -> m (Rectangle, Rectangle)

-- | Returns the languages that are supported by font.
--   
--   If the font backend does not provide this information, Nothing
--   is returned. For the fontconfig backend, this corresponds to the
--   FC_LANG member of the FcPattern.
--   
--   The returned array is only valid as long as the font and its fontmap
--   are valid.
--   
--   Since: 1.50
fontGetLanguages :: (HasCallStack, MonadIO m, IsFont a) => a -> m (Maybe [Language])

-- | Gets overall metric information for a font.
--   
--   Since the metrics may be substantially different for different
--   scripts, a language tag can be provided to indicate that the metrics
--   should be retrieved that correspond to the script(s) used by that
--   language.
--   
--   If font is Nothing, this function gracefully
--   sets some sane values in the output variables and returns.
fontGetMetrics :: (HasCallStack, MonadIO m, IsFont a) => Maybe a -> Maybe Language -> m FontMetrics

-- | Returns whether the font provides a glyph for this character.
--   
--   Since: 1.44
fontHasChar :: (HasCallStack, MonadIO m, IsFont a) => a -> Char -> m Bool

-- | Serializes the font in a way that can be uniquely
--   identified.
--   
--   There are no guarantees about the format of the output across
--   different versions of Pango.
--   
--   The intended use of this function is testing, benchmarking and
--   debugging. The format is not meant as a permanent storage format.
--   
--   To recreate a font from its serialized form, use
--   fontDeserialize.
--   
--   Since: 1.50
fontSerialize :: (HasCallStack, MonadIO m, IsFont a) => a -> m Bytes
instance GHC.Classes.Eq GI.Pango.Objects.Font.Font
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Font.Font
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Font.Font
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Font.Font o) => GI.Pango.Objects.Font.IsFont o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Font.Font)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Font.Font
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Font.Font

-- | A PangoContext stores global information used to control the
--   itemization process.
--   
--   The information stored by PangoContext includes the fontmap
--   used to look up fonts, and default values such as the default
--   language, default gravity, or default font.
--   
--   To obtain a PangoContext, use fontMapCreateContext.
module GI.Pango.Objects.Context

-- | Memory-managed wrapper type.
newtype Context
Context :: ManagedPtr Context -> Context

-- | Type class for types which can be safely cast to Context, for
--   instance with toContext.
class (GObject o, IsDescendantOf Context o) => IsContext o

-- | Cast to Context, for types for which this is known to be safe.
--   For general casts, use castTo.
toContext :: (MonadIO m, IsContext o) => o -> m Context

-- | Forces a change in the context, which will cause any
--   PangoLayout using this context to re-layout.
--   
--   This function is only useful when implementing a new backend for
--   Pango, something applications won't do. Backends should call this
--   function if they have attached extra data to the context and such data
--   is changed.
--   
--   Since: 1.32.4
contextChanged :: (HasCallStack, MonadIO m, IsContext a) => a -> m ()

-- | Retrieves the base direction for the context.
--   
--   See contextSetBaseDir.
contextGetBaseDir :: (HasCallStack, MonadIO m, IsContext a) => a -> m Direction

-- | Retrieves the base gravity for the context.
--   
--   See contextSetBaseGravity.
--   
--   Since: 1.16
contextGetBaseGravity :: (HasCallStack, MonadIO m, IsContext a) => a -> m Gravity

-- | Retrieve the default font description for the context.
contextGetFontDescription :: (HasCallStack, MonadIO m, IsContext a) => a -> m (Maybe FontDescription)

-- | Gets the PangoFontMap used to look up fonts for this context.
--   
--   Since: 1.6
contextGetFontMap :: (HasCallStack, MonadIO m, IsContext a) => a -> m (Maybe FontMap)

-- | Retrieves the gravity for the context.
--   
--   This is similar to contextGetBaseGravity, except for when the
--   base gravity is GravityAuto for which
--   Gravity.get_for_matrix() is used to return the
--   gravity from the current context matrix.
--   
--   Since: 1.16
contextGetGravity :: (HasCallStack, MonadIO m, IsContext a) => a -> m Gravity

-- | Retrieves the gravity hint for the context.
--   
--   See contextSetGravityHint for details.
--   
--   Since: 1.16
contextGetGravityHint :: (HasCallStack, MonadIO m, IsContext a) => a -> m GravityHint

-- | Retrieves the global language tag for the context.
contextGetLanguage :: (HasCallStack, MonadIO m, IsContext a) => a -> m Language

-- | Gets the transformation matrix that will be applied when rendering
--   with this context.
--   
--   See contextSetMatrix.
--   
--   Since: 1.6
contextGetMatrix :: (HasCallStack, MonadIO m, IsContext a) => a -> m (Maybe Matrix)

-- | Get overall metric information for a particular font description.
--   
--   Since the metrics may be substantially different for different
--   scripts, a language tag can be provided to indicate that the metrics
--   should be retrieved that correspond to the script(s) used by that
--   language.
--   
--   The PangoFontDescription is interpreted in the same way as by
--   [funcitemize], and the family name may be a comma
--   separated list of names. If characters from multiple of these families
--   would be used to render the string, then the returned fonts would be a
--   composite of the metrics for the fonts loaded for the individual
--   families.
contextGetMetrics :: (HasCallStack, MonadIO m, IsContext a) => a -> Maybe FontDescription -> Maybe Language -> m FontMetrics

-- | Returns whether font rendering with this context should round glyph
--   positions and widths.
--   
--   Since: 1.44
contextGetRoundGlyphPositions :: (HasCallStack, MonadIO m, IsContext a) => a -> m Bool

-- | Returns the current serial number of context.
--   
--   The serial number is initialized to an small number larger than zero
--   when a new context is created and is increased whenever the context is
--   changed using any of the setter functions, or the
--   PangoFontMap it uses to find fonts has changed. The serial
--   may wrap, but will never have the value 0. Since it can wrap, never
--   compare it with "less than", always use "not equals".
--   
--   This can be used to automatically detect changes to a
--   PangoContext, and is only useful when implementing objects
--   that need update when their PangoContext changes, like
--   PangoLayout.
--   
--   Since: 1.32.4
contextGetSerial :: (HasCallStack, MonadIO m, IsContext a) => a -> m Word32

-- | List all families for a context.
contextListFamilies :: (HasCallStack, MonadIO m, IsContext a) => a -> m [FontFamily]

-- | Loads the font in one of the fontmaps in the context that is the
--   closest match for desc.
contextLoadFont :: (HasCallStack, MonadIO m, IsContext a) => a -> FontDescription -> m (Maybe Font)

-- | Load a set of fonts in the context that can be used to render a font
--   matching desc.
contextLoadFontset :: (HasCallStack, MonadIO m, IsContext a) => a -> FontDescription -> Language -> m (Maybe Fontset)

-- | Creates a new PangoContext initialized to default values.
--   
--   This function is not particularly useful as it should always be
--   followed by a contextSetFontMap call, and the function
--   fontMapCreateContext does these two steps together and hence
--   users are recommended to use that.
--   
--   If you are using Pango as part of a higher-level system, that system
--   may have it's own way of create a PangoContext. For instance,
--   the GTK toolkit has, among others,
--   gtk_widget_get_pango_context(). Use those instead.
contextNew :: (HasCallStack, MonadIO m) => m Context

-- | Sets the base direction for the context.
--   
--   The base direction is used in applying the Unicode bidirectional
--   algorithm; if the direction is DirectionLtr or
--   DirectionRtl, then the value will be used as the paragraph
--   direction in the Unicode bidirectional algorithm. A value of
--   DirectionWeakLtr or DirectionWeakRtl is used only for
--   paragraphs that do not contain any strong characters themselves.
contextSetBaseDir :: (HasCallStack, MonadIO m, IsContext a) => a -> Direction -> m ()

-- | Sets the base gravity for the context.
--   
--   The base gravity is used in laying vertical text out.
--   
--   Since: 1.16
contextSetBaseGravity :: (HasCallStack, MonadIO m, IsContext a) => a -> Gravity -> m ()

-- | Set the default font description for the context
contextSetFontDescription :: (HasCallStack, MonadIO m, IsContext a) => a -> Maybe FontDescription -> m ()

-- | Sets the font map to be searched when fonts are looked-up in this
--   context.
--   
--   This is only for internal use by Pango backends, a
--   PangoContext obtained via one of the recommended methods
--   should already have a suitable font map.
contextSetFontMap :: (HasCallStack, MonadIO m, IsContext a, IsFontMap b) => a -> Maybe b -> m ()

-- | Sets the gravity hint for the context.
--   
--   The gravity hint is used in laying vertical text out, and is only
--   relevant if gravity of the context as returned by
--   contextGetGravity is set to GravityEast or
--   GravityWest.
--   
--   Since: 1.16
contextSetGravityHint :: (HasCallStack, MonadIO m, IsContext a) => a -> GravityHint -> m ()

-- | Sets the global language tag for the context.
--   
--   The default language for the locale of the running process can be
--   found using languageGetDefault.
contextSetLanguage :: (HasCallStack, MonadIO m, IsContext a) => a -> Maybe Language -> m ()

-- | Sets the transformation matrix that will be applied when rendering
--   with this context.
--   
--   Note that reported metrics are in the user space coordinates before
--   the application of the matrix, not device-space coordinates after the
--   application of the matrix. So, they don't scale with the matrix,
--   though they may change slightly for different matrices, depending on
--   how the text is fit to the pixel grid.
--   
--   Since: 1.6
contextSetMatrix :: (HasCallStack, MonadIO m, IsContext a) => a -> Maybe Matrix -> m ()

-- | Sets whether font rendering with this context should round glyph
--   positions and widths to integral positions, in device units.
--   
--   This is useful when the renderer can't handle subpixel positioning of
--   glyphs.
--   
--   The default value is to round glyph positions, to remain compatible
--   with previous Pango behavior.
--   
--   Since: 1.44
contextSetRoundGlyphPositions :: (HasCallStack, MonadIO m, IsContext a) => a -> Bool -> m ()
instance GHC.Classes.Eq GI.Pango.Objects.Context.Context
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Context.Context
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Context.Context
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Context.Context o) => GI.Pango.Objects.Context.IsContext o
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Context.Context)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Context.Context
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Context.Context

module GI.Pango.Functions

-- | Create a new allow-breaks attribute.
--   
--   If breaks are disabled, the range will be kept in a single run, as far
--   as possible.
--   
--   Since: 1.44
attrAllowBreaksNew :: (HasCallStack, MonadIO m) => Bool -> m Attribute

-- | Create a new background alpha attribute.
--   
--   Since: 1.38
attrBackgroundAlphaNew :: (HasCallStack, MonadIO m) => Word16 -> m Attribute

-- | Create a new background color attribute.
attrBackgroundNew :: (HasCallStack, MonadIO m) => Word16 -> Word16 -> Word16 -> m Attribute

-- | Create a new baseline displacement attribute.
--   
--   The effect of this attribute is to shift the baseline of a run,
--   relative to the run of preceding run.
--   
--   <picture> <source srcset="baseline-shift-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Baseline Shift"
--   src="baseline-shift-light.png"> </picture>
--   
--   Since: 1.50
attrBaselineShiftNew :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Apply customization from attributes to the breaks in
--   attrs.
--   
--   The line breaks are assumed to have been produced by
--   defaultBreak and tailorBreak.
--   
--   Since: 1.50
attrBreak :: (HasCallStack, MonadIO m) => Text -> Int32 -> AttrList -> Int32 -> [LogAttr] -> m [LogAttr]

-- | Create a new font fallback attribute.
--   
--   If fallback is disabled, characters will only be used from the closest
--   matching font on the system. No fallback will be done to other fonts
--   on the system that might contain the characters in the text.
--   
--   Since: 1.4
attrFallbackNew :: (HasCallStack, MonadIO m) => Bool -> m Attribute

-- | Create a new font family attribute.
attrFamilyNew :: (HasCallStack, MonadIO m) => Text -> m Attribute

-- | Create a new font scale attribute.
--   
--   The effect of this attribute is to change the font size of a run,
--   relative to the size of preceding run.
--   
--   Since: 1.50
attrFontScaleNew :: (HasCallStack, MonadIO m) => FontScale -> m Attribute

-- | Create a new foreground alpha attribute.
--   
--   Since: 1.38
attrForegroundAlphaNew :: (HasCallStack, MonadIO m) => Word16 -> m Attribute

-- | Create a new foreground color attribute.
attrForegroundNew :: (HasCallStack, MonadIO m) => Word16 -> Word16 -> Word16 -> m Attribute

-- | Create a new gravity hint attribute.
--   
--   Since: 1.16
attrGravityHintNew :: (HasCallStack, MonadIO m) => GravityHint -> m Attribute

-- | Create a new gravity attribute.
--   
--   Since: 1.16
attrGravityNew :: (HasCallStack, MonadIO m) => Gravity -> m Attribute

-- | Create a new insert-hyphens attribute.
--   
--   Pango will insert hyphens when breaking lines in the middle of a word.
--   This attribute can be used to suppress the hyphen.
--   
--   Since: 1.44
attrInsertHyphensNew :: (HasCallStack, MonadIO m) => Bool -> m Attribute

-- | Create a new letter-spacing attribute.
--   
--   Since: 1.6
attrLetterSpacingNew :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Modify the height of logical line extents by a factor.
--   
--   This affects the values returned by layoutLineGetExtents,
--   layoutLineGetPixelExtents and layoutIterGetLineExtents.
--   
--   Since: 1.50
attrLineHeightNew :: (HasCallStack, MonadIO m) => Double -> m Attribute

-- | Override the height of logical line extents to be
--   height.
--   
--   This affects the values returned by layoutLineGetExtents,
--   layoutLineGetPixelExtents and layoutIterGetLineExtents.
--   
--   Since: 1.50
attrLineHeightNewAbsolute :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Create a new overline color attribute.
--   
--   This attribute modifies the color of overlines. If not set, overlines
--   will use the foreground color.
--   
--   Since: 1.46
attrOverlineColorNew :: (HasCallStack, MonadIO m) => Word16 -> Word16 -> Word16 -> m Attribute

-- | Create a new overline-style attribute.
--   
--   Since: 1.46
attrOverlineNew :: (HasCallStack, MonadIO m) => Overline -> m Attribute

-- | Create a new baseline displacement attribute.
attrRiseNew :: (HasCallStack, MonadIO m) => Int32 -> m Attribute

-- | Create a new font size scale attribute.
--   
--   The base font for the affected text will have its size multiplied by
--   scaleFactor.
attrScaleNew :: (HasCallStack, MonadIO m) => Double -> m Attribute

-- | Marks the range of the attribute as a single sentence.
--   
--   Note that this may require adjustments to word and sentence
--   classification around the range.
--   
--   Since: 1.50
attrSentenceNew :: (HasCallStack, MonadIO m) => m Attribute

-- | Create a new attribute that influences how invisible characters are
--   rendered.
--   
--   Since: 1.44
attrShowNew :: (HasCallStack, MonadIO m) => [ShowFlags] -> m Attribute

-- | Create a new font stretch attribute.
attrStretchNew :: (HasCallStack, MonadIO m) => Stretch -> m Attribute

-- | Create a new strikethrough color attribute.
--   
--   This attribute modifies the color of strikethrough lines. If not set,
--   strikethrough lines will use the foreground color.
--   
--   Since: 1.8
attrStrikethroughColorNew :: (HasCallStack, MonadIO m) => Word16 -> Word16 -> Word16 -> m Attribute

-- | Create a new strike-through attribute.
attrStrikethroughNew :: (HasCallStack, MonadIO m) => Bool -> m Attribute

-- | Create a new font slant style attribute.
attrStyleNew :: (HasCallStack, MonadIO m) => Style -> m Attribute

-- | Create a new attribute that influences how characters are transformed
--   during shaping.
--   
--   Since: 1.50
attrTextTransformNew :: (HasCallStack, MonadIO m) => TextTransform -> m Attribute

-- | Create a new underline color attribute.
--   
--   This attribute modifies the color of underlines. If not set,
--   underlines will use the foreground color.
--   
--   Since: 1.8
attrUnderlineColorNew :: (HasCallStack, MonadIO m) => Word16 -> Word16 -> Word16 -> m Attribute

-- | Create a new underline-style attribute.
attrUnderlineNew :: (HasCallStack, MonadIO m) => Underline -> m Attribute

-- | Create a new font variant attribute (normal or small caps).
attrVariantNew :: (HasCallStack, MonadIO m) => Variant -> m Attribute

-- | Create a new font weight attribute.
attrWeightNew :: (HasCallStack, MonadIO m) => Weight -> m Attribute

-- | Marks the range of the attribute as a single word.
--   
--   Note that this may require adjustments to word and sentence
--   classification around the range.
--   
--   Since: 1.50
attrWordNew :: (HasCallStack, MonadIO m) => m Attribute

-- | Determines possible line, word, and character breaks for a string of
--   Unicode text with a single analysis.
--   
--   For most purposes you may want to use getLogAttrs.

-- | Deprecated: (Since version 1.44)Use
--   defaultBreak,tailorBreak and attrBreak.
break :: (HasCallStack, MonadIO m) => Text -> Int32 -> Analysis -> [LogAttr] -> m [LogAttr]

-- | This is the default break algorithm.
--   
--   It applies rules from the Unicode Line Breaking Algorithm
--   without language-specific tailoring, therefore the
--   analyis argument is unused and can be Nothing.
--   
--   See tailorBreak for language-specific breaks.
--   
--   See attrBreak for attribute-based customization.
defaultBreak :: (HasCallStack, MonadIO m) => Text -> Int32 -> Maybe Analysis -> [LogAttr] -> m [LogAttr]

-- | Searches a string the first character that has a strong direction,
--   according to the Unicode bidirectional algorithm.
--   
--   Since: 1.4
findBaseDir :: (HasCallStack, MonadIO m) => Text -> Int32 -> m Direction

-- | Locates a paragraph boundary in text.
--   
--   A boundary is caused by delimiter characters, such as a newline,
--   carriage return, carriage return-newline pair, or Unicode paragraph
--   separator character.
--   
--   The index of the run of delimiters is returned in
--   paragraphDelimiterIndex. The index of the start of the
--   next paragraph (index after all delimiters) is stored n
--   nextParagraphStart.
--   
--   If no delimiters are found, both
--   paragraphDelimiterIndex and
--   nextParagraphStart are filled with the length of
--   text (an index one off the end).
findParagraphBoundary :: (HasCallStack, MonadIO m) => Text -> Int32 -> m (Int32, Int32)

-- | Computes a PangoLogAttr for each character in
--   text.
--   
--   The attrs array must have one PangoLogAttr
--   for each position in text; if text
--   contains N characters, it has N+1 positions, including the last
--   position at the end of the text. text should be an
--   entire paragraph; logical attributes can't be computed without context
--   (for example you need to see spaces on either side of a word to know
--   the word is a word).
getLogAttrs :: (HasCallStack, MonadIO m) => Text -> Int32 -> Int32 -> Language -> [LogAttr] -> m [LogAttr]

-- | Returns the mirrored character of a Unicode character.
--   
--   Mirror characters are determined by the Unicode mirrored property.

-- | Deprecated: (Since version 1.30)Use unicharGetMirrorChar
--   instead;the docs for that function provide full details.
getMirrorChar :: (HasCallStack, MonadIO m) => Char -> m (Bool, Char)

-- | Checks if a character that should not be normally rendered.
--   
--   This includes all Unicode characters with "ZERO WIDTH" in their name,
--   as well as *bidi* formatting characters, and a few other ones.
--   
--   This is totally different from unicharIszerowidth and is at
--   best misnamed.
--   
--   Since: 1.10
isZeroWidth :: (HasCallStack, MonadIO m) => Char -> m Bool

-- | Breaks a piece of text into segments with consistent directional level
--   and font.
--   
--   Each byte of text will be contained in exactly one of
--   the items in the returned list; the generated list of items will be in
--   logical order (the start offsets of the items are ascending).
--   
--   cachedIter should be an iterator over
--   attrs currently positioned at a range before or
--   containing startIndex; cachedIter will
--   be advanced to the range covering the position just after
--   startIndex + length. (i.e. if
--   itemizing in a loop, just keep passing in the same
--   cachedIter).
itemize :: (HasCallStack, MonadIO m, IsContext a) => a -> Text -> Int32 -> Int32 -> AttrList -> Maybe AttrIterator -> m [Item]

-- | Like pango_itemize(), but with an explicitly specified base
--   direction.
--   
--   The base direction is used when computing bidirectional levels.
--   [funcitemize] gets the base direction from the
--   PangoContext (see contextSetBaseDir).
--   
--   Since: 1.4
itemizeWithBaseDir :: (HasCallStack, MonadIO m, IsContext a) => a -> Direction -> Text -> Int32 -> Int32 -> AttrList -> Maybe AttrIterator -> m [Item]

-- | Finishes parsing markup.
--   
--   After feeding a Pango markup parser some data with
--   markupParseContextParse, use this function to get the list of
--   attributes and text out of the markup. This function will not free
--   context, use markupParseContextFree to do so.
--   
--   Since: 1.31.0
markupParserFinish :: (HasCallStack, MonadIO m) => MarkupParseContext -> m (AttrList, Text, Char)

-- | Incrementally parses marked-up text to create a plain-text string and
--   an attribute list.
--   
--   See the Pango Markup docs for details about the supported
--   markup.
--   
--   If accelMarker is nonzero, the given character will
--   mark the character following it as an accelerator. For example,
--   accelMarker might be an ampersand or underscore. All
--   characters marked as an accelerator will receive a UnderlineLow
--   attribute, and the first character so marked will be returned in
--   accelChar, when calling
--   [funcmarkupParserFinish]. Two
--   accelMarker characters following each other produce a
--   single literal accelMarker character.
--   
--   To feed markup to the parser, use markupParseContextParse on
--   the returned MarkupParseContext. When done with feeding markup
--   to the parser, use [funcmarkupParserFinish] to get the
--   data out of it, and then use markupParseContextFree to free it.
--   
--   This function is designed for applications that read Pango markup from
--   streams. To simply parse a string containing Pango markup, the
--   parseMarkup API is recommended instead.
--   
--   Since: 1.31.0
markupParserNew :: (HasCallStack, MonadIO m) => Char -> m MarkupParseContext

-- | Parses an enum type and stores the result in value.
--   
--   If str does not match the nick name of any of the
--   possible values for the enum and is not an integer, False is
--   returned, a warning is issued if warn is True,
--   and a string representing the list of possible values is stored in
--   possibleValues. The list is slash-separated, eg.
--   "none/start/middle/end".
--   
--   If failed and possibleValues is not Nothing,
--   returned string should be freed using free.
--   
--   Since: 1.16

-- | Deprecated: (Since version 1.38)
parseEnum :: (HasCallStack, MonadIO m) => GType -> Maybe Text -> Bool -> m (Bool, Int32, Text)

-- | Parses marked-up text to create a plain-text string and an attribute
--   list.
--   
--   See the Pango Markup docs for details about the supported
--   markup.
--   
--   If accelMarker is nonzero, the given character will
--   mark the character following it as an accelerator. For example,
--   accelMarker might be an ampersand or underscore. All
--   characters marked as an accelerator will receive a UnderlineLow
--   attribute, and the first character so marked will be returned in
--   accelChar. Two accelMarker characters
--   following each other produce a single literal
--   accelMarker character.
--   
--   To parse a stream of pango markup incrementally, use
--   [funcmarkupParserNew].
--   
--   If any error happens, none of the output arguments are touched except
--   for error.
parseMarkup :: (HasCallStack, MonadIO m) => Text -> Int32 -> Char -> m (AttrList, Text, Char)

-- | Parses a font stretch.
--   
--   The allowed values are "ultra_condensed", "extra_condensed",
--   "condensed", "semi_condensed", "normal", "semi_expanded", "expanded",
--   "extra_expanded" and "ultra_expanded". Case variations are ignored and
--   the '_' characters may be omitted.
parseStretch :: (HasCallStack, MonadIO m) => Text -> Bool -> m (Bool, Stretch)

-- | Parses a font style.
--   
--   The allowed values are "normal", "italic" and "oblique", case
--   variations being ignored.
parseStyle :: (HasCallStack, MonadIO m) => Text -> Bool -> m (Bool, Style)

-- | Parses a font variant.
--   
--   The allowed values are "normal", "small-caps", "all-small-caps",
--   "petite-caps", "all-petite-caps", "unicase" and "title-caps", case
--   variations being ignored.
parseVariant :: (HasCallStack, MonadIO m) => Text -> Bool -> m (Bool, Variant)

-- | Parses a font weight.
--   
--   The allowed values are "heavy", "ultrabold", "bold", "normal",
--   "light", "ultraleight" and integers. Case variations are ignored.
parseWeight :: (HasCallStack, MonadIO m) => Text -> Bool -> m (Bool, Weight)

-- | Quantizes the thickness and position of a line to whole device pixels.
--   
--   This is typically used for underline or strikethrough. The purpose of
--   this function is to avoid such lines looking blurry.
--   
--   Care is taken to make sure thickness is at least one
--   pixel when this function returns, but returned
--   position may become zero as a result of rounding.
--   
--   Since: 1.12
quantizeLineGeometry :: (HasCallStack, MonadIO m) => Int32 -> Int32 -> m (Int32, Int32)

-- | Reads an entire line from a file into a buffer.
--   
--   Lines may be delimited with '\n', '\r', '\n\r', or '\r\n'. The
--   delimiter is not written into the buffer. Text after a '#' character
--   is treated as a comment and skipped. '\' can be used to escape a #
--   character. '\' proceeding a line delimiter combines adjacent lines. A
--   '\' proceeding any other character is ignored and written into the
--   output buffer unmodified.

-- | Deprecated: (Since version 1.38)
readLine :: (HasCallStack, MonadIO m) => Ptr () -> String -> m Int32

-- | Reorder items from logical order to visual order.
--   
--   The visual order is determined from the associated directional levels
--   of the items. The original list is unmodified.
--   
--   (Please open a bug if you use this function. It is not a particularly
--   convenient interface, and the code is duplicated elsewhere in Pango
--   for that reason.)
reorderItems :: (HasCallStack, MonadIO m) => [Item] -> m [Item]

-- | Scans an integer.
--   
--   Leading white space is skipped.

-- | Deprecated: (Since version 1.38)
scanInt :: (HasCallStack, MonadIO m) => Text -> m (Bool, Text, Int32)

-- | Scans a string into a GString buffer.
--   
--   The string may either be a sequence of non-white-space characters, or
--   a quoted string with '"'. Instead a quoted string, '\"' represents a
--   literal quote. Leading white space outside of quotes is skipped.

-- | Deprecated: (Since version 1.38)
scanString :: (HasCallStack, MonadIO m) => Text -> String -> m (Bool, Text)

-- | Scans a word into a GString buffer.
--   
--   A word consists of [A-Za-z_] followed by zero or more [A-Za-z_0-9].
--   Leading white space is skipped.

-- | Deprecated: (Since version 1.38)
scanWord :: (HasCallStack, MonadIO m) => Text -> String -> m (Bool, Text)

-- | Convert the characters in text into glyphs.
--   
--   Given a segment of text and the corresponding PangoAnalysis
--   structure returned from itemize, convert the characters into
--   glyphs. You may also pass in only a substring of the item from
--   itemize.
--   
--   It is recommended that you use shapeFull instead, since that
--   API allows for shaping interaction happening across text item
--   boundaries.
--   
--   Some aspects of hyphen insertion and text transformation (in
--   particular, capitalization) require log attrs, and thus can only be
--   handled by shapeItem.
--   
--   Note that the extra attributes in the analyis that is
--   returned from itemize have indices that are relative to the
--   entire paragraph, so you need to subtract the item offset from their
--   indices before calling shape.
shape :: (HasCallStack, MonadIO m) => Text -> Int32 -> Analysis -> m GlyphString

-- | Convert the characters in text into glyphs.
--   
--   Given a segment of text and the corresponding PangoAnalysis
--   structure returned from itemize, convert the characters into
--   glyphs. You may also pass in only a substring of the item from
--   itemize.
--   
--   This is similar to shape, except it also can optionally take
--   the full paragraph text as input, which will then be used to perform
--   certain cross-item shaping interactions. If you have access to the
--   broader text of which itemText is part of, provide the
--   broader text as paragraphText. If
--   paragraphText is Nothing, item text is used
--   instead.
--   
--   Some aspects of hyphen insertion and text transformation (in
--   particular, capitalization) require log attrs, and thus can only be
--   handled by shapeItem.
--   
--   Note that the extra attributes in the analyis that is
--   returned from itemize have indices that are relative to the
--   entire paragraph, so you do not pass the full paragraph text as
--   paragraphText, you need to subtract the item offset
--   from their indices before calling shapeFull.
--   
--   Since: 1.32
shapeFull :: (HasCallStack, MonadIO m) => Text -> Int32 -> Maybe Text -> Int32 -> Analysis -> m GlyphString

-- | Convert the characters in item into glyphs.
--   
--   This is similar to shapeWithFlags, except it takes a
--   PangoItem instead of separate itemText and
--   analysis arguments.
--   
--   It also takes logAttrs, which are needed for
--   implementing some aspects of hyphen insertion and text transforms (in
--   particular, capitalization).
--   
--   Note that the extra attributes in the analyis that is
--   returned from itemize have indices that are relative to the
--   entire paragraph, so you do not pass the full paragraph text as
--   paragraphText, you need to subtract the item offset
--   from their indices before calling shapeWithFlags.
--   
--   Since: 1.50
shapeItem :: (HasCallStack, MonadIO m) => Item -> Maybe Text -> Int32 -> Maybe LogAttr -> [ShapeFlags] -> m GlyphString

-- | Convert the characters in text into glyphs.
--   
--   Given a segment of text and the corresponding PangoAnalysis
--   structure returned from itemize, convert the characters into
--   glyphs. You may also pass in only a substring of the item from
--   itemize.
--   
--   This is similar to shapeFull, except it also takes flags that
--   can influence the shaping process.
--   
--   Some aspects of hyphen insertion and text transformation (in
--   particular, capitalization) require log attrs, and thus can only be
--   handled by shapeItem.
--   
--   Note that the extra attributes in the analyis that is
--   returned from itemize have indices that are relative to the
--   entire paragraph, so you do not pass the full paragraph text as
--   paragraphText, you need to subtract the item offset
--   from their indices before calling shapeWithFlags.
--   
--   Since: 1.44
shapeWithFlags :: (HasCallStack, MonadIO m) => Text -> Int32 -> Maybe Text -> Int32 -> Analysis -> [ShapeFlags] -> m GlyphString

-- | Skips 0 or more characters of white space.

-- | Deprecated: (Since version 1.38)
skipSpace :: (HasCallStack, MonadIO m) => Text -> m (Bool, Text)

-- | Splits a SEARCHPATH_SEPARATOR-separated list of files,
--   stripping white space and substituting ~/ with $HOME/.

-- | Deprecated: (Since version 1.38)
splitFileList :: (HasCallStack, MonadIO m) => Text -> m [Text]

-- | Apply language-specific tailoring to the breaks in
--   attrs.
--   
--   The line breaks are assumed to have been produced by
--   defaultBreak.
--   
--   If offset is not -1, it is used to apply attributes
--   from analysis that are relevant to line breaking.
--   
--   Note that it is better to pass -1 for offset and use
--   attrBreak to apply attributes to the whole paragraph.
--   
--   Since: 1.44
tailorBreak :: (HasCallStack, MonadIO m) => Text -> Int32 -> Analysis -> Int32 -> [LogAttr] -> m [LogAttr]

-- | Trims leading and trailing whitespace from a string.

-- | Deprecated: (Since version 1.38)
trimString :: (HasCallStack, MonadIO m) => Text -> m Text

-- | Determines the inherent direction of a character.
--   
--   The inherent direction is either PANGO_DIRECTION_LTR,
--   PANGO_DIRECTION_RTL, or PANGO_DIRECTION_NEUTRAL.
--   
--   This function is useful to categorize characters into left-to-right
--   letters, right-to-left letters, and everything else. If full Unicode
--   bidirectional type of a character is needed,
--   BidiType.for_unichar() can be used instead.
unicharDirection :: (HasCallStack, MonadIO m) => Char -> m Direction

-- | Converts a floating-point number to Pango units.
--   
--   The conversion is done by multiplying d by
--   SCALE and rounding the result to nearest integer.
--   
--   Since: 1.16
unitsFromDouble :: (HasCallStack, MonadIO m) => Double -> m Int32

-- | Converts a number in Pango units to floating-point.
--   
--   The conversion is done by dividing i by SCALE.
--   
--   Since: 1.16
unitsToDouble :: (HasCallStack, MonadIO m) => Int32 -> m Double

-- | Returns the encoded version of Pango available at run-time.
--   
--   This is similar to the macro PANGO_VERSION except that
--   the macro returns the encoded version available at compile-time. A
--   version number can be encoded into an integer using
--   PANGO_VERSION_ENCODE().
--   
--   Since: 1.16
version :: (HasCallStack, MonadIO m) => m Int32

-- | Checks that the Pango library in use is compatible with the given
--   version.
--   
--   Generally you would pass in the constants VERSION_MAJOR,
--   VERSION_MINOR, VERSION_MICRO as the three arguments to
--   this function; that produces a check that the library in use at
--   run-time is compatible with the version of Pango the application or
--   module was compiled against.
--   
--   Compatibility is defined by two things: first the version of the
--   running library is newer than the version
--   requiredMajor.required_minor.requiredMicro.
--   Second the running library must be binary compatible with the version
--   requiredMajor.required_minor.requiredMicro
--   (same major version.)
--   
--   For compile-time version checking use
--   PANGO_VERSION_CHECK().
--   
--   Since: 1.16
versionCheck :: (HasCallStack, MonadIO m) => Int32 -> Int32 -> Int32 -> m (Maybe Text)

-- | Returns the version of Pango available at run-time.
--   
--   This is similar to the macro VERSION_STRING except that the
--   macro returns the version available at compile-time.
--   
--   Since: 1.16
versionString :: (HasCallStack, MonadIO m) => m Text

-- | A PangoScriptIter is used to iterate through a string and
--   identify ranges in different scripts.
module GI.Pango.Structs.ScriptIter

-- | Memory-managed wrapper type.
newtype ScriptIter
ScriptIter :: ManagedPtr ScriptIter -> ScriptIter

-- | Frees a PangoScriptIter.
--   
--   Since: 1.4
scriptIterFree :: (HasCallStack, MonadIO m) => ScriptIter -> m ()

-- | Gets information about the range to which iter
--   currently points.
--   
--   The range is the set of locations p where *start <= p < *end.
--   (That is, it doesn't include the character stored at *end)
--   
--   Note that while the type of the script argument is
--   declared as PangoScript, as of Pango 1.18, this function
--   simply returns GUnicodeScript values. Callers must be
--   prepared to handle unknown values.
--   
--   Since: 1.4
scriptIterGetRange :: (HasCallStack, MonadIO m) => ScriptIter -> m (Text, Text, Script)

-- | Create a new PangoScriptIter, used to break a string of
--   Unicode text into runs by Unicode script.
--   
--   No copy is made of text, so the caller needs to make
--   sure it remains valid until the iterator is freed with
--   scriptIterFree.
--   
--   Since: 1.4
scriptIterNew :: (HasCallStack, MonadIO m) => Text -> Int32 -> m ScriptIter

-- | Advances a PangoScriptIter to the next range.
--   
--   If iter is already at the end, it is left unchanged
--   and False is returned.
--   
--   Since: 1.4
scriptIterNext :: (HasCallStack, MonadIO m) => ScriptIter -> m Bool
instance GHC.Classes.Eq GI.Pango.Structs.ScriptIter.ScriptIter
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.ScriptIter.ScriptIter
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.ScriptIter.ScriptIter
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.ScriptIter.ScriptIter)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.ScriptIter.ScriptIter
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.ScriptIter.ScriptIter

-- | A PangoTabArray contains an array of tab stops.
--   
--   PangoTabArray can be used to set tab stops in a
--   PangoLayout. Each tab stop has an alignment, a position, and
--   optionally a character to use as decimal point.
module GI.Pango.Structs.TabArray

-- | Memory-managed wrapper type.
newtype TabArray
TabArray :: ManagedPtr TabArray -> TabArray

-- | Copies a PangoTabArray.
tabArrayCopy :: (HasCallStack, MonadIO m) => TabArray -> m TabArray

-- | Frees a tab array and associated resources.
tabArrayFree :: (HasCallStack, MonadIO m) => TabArray -> m ()

-- | Deserializes a PangoTabArray from a string.
--   
--   This is the counterpart to tabArrayToString. See that functions
--   for details about the format.
--   
--   Since: 1.50
tabArrayFromString :: (HasCallStack, MonadIO m) => Text -> m (Maybe TabArray)

-- | Gets the Unicode character to use as decimal point.
--   
--   This is only relevant for tabs with TabAlignDecimal alignment,
--   which align content at the first occurrence of the decimal point
--   character.
--   
--   The default value of 0 means that Pango will use the decimal point
--   according to the current locale.
--   
--   Since: 1.50
tabArrayGetDecimalPoint :: (HasCallStack, MonadIO m) => TabArray -> Int32 -> m Char

-- | Returns True if the tab positions are in pixels, False
--   if they are in Pango units.
tabArrayGetPositionsInPixels :: (HasCallStack, MonadIO m) => TabArray -> m Bool

-- | Gets the number of tab stops in tabArray.
tabArrayGetSize :: (HasCallStack, MonadIO m) => TabArray -> m Int32

-- | Gets the alignment and position of a tab stop.
tabArrayGetTab :: (HasCallStack, MonadIO m) => TabArray -> Int32 -> m (TabAlign, Int32)

-- | Creates an array of initialSize tab stops.
--   
--   Tab stops are specified in pixel units if
--   positionsInPixels is True, otherwise in Pango
--   units. All stops are initially at position 0.
tabArrayNew :: (HasCallStack, MonadIO m) => Int32 -> Bool -> m TabArray

-- | Resizes a tab array.
--   
--   You must subsequently initialize any tabs that were added as a result
--   of growing the array.
tabArrayResize :: (HasCallStack, MonadIO m) => TabArray -> Int32 -> m ()

-- | Sets the Unicode character to use as decimal point.
--   
--   This is only relevant for tabs with TabAlignDecimal alignment,
--   which align content at the first occurrence of the decimal point
--   character.
--   
--   By default, Pango uses the decimal point according to the current
--   locale.
--   
--   Since: 1.50
tabArraySetDecimalPoint :: (HasCallStack, MonadIO m) => TabArray -> Int32 -> Char -> m ()

-- | Sets whether positions in this array are specified in pixels.
--   
--   Since: 1.50
tabArraySetPositionsInPixels :: (HasCallStack, MonadIO m) => TabArray -> Bool -> m ()

-- | Sets the alignment and location of a tab stop.
tabArraySetTab :: (HasCallStack, MonadIO m) => TabArray -> Int32 -> TabAlign -> Int32 -> m ()

-- | Utility function to ensure that the tab stops are in increasing order.
--   
--   Since: 1.50
tabArraySort :: (HasCallStack, MonadIO m) => TabArray -> m ()

-- | Serializes a PangoTabArray to a string.
--   
--   In the resulting string, serialized tabs are separated by newlines or
--   commas.
--   
--   Individual tabs are serialized to a string of the form
--   
--   
--   
- ALIGNMENT: POSITION[:DECIMAL_POINT]
--   
--   
--   Where ALIGNMENT is one of _left_, _right_, _center_ or _decimal_, and
--   POSITION is the position of the tab, optionally followed by the unit
--   _px_. If ALIGNMENT is omitted, it defaults to _left_. If ALIGNMENT is
--   _decimal_, the DECIMAL_POINT character may be specified as a Unicode
--   codepoint.
--   
--   Note that all tabs in the array must use the same unit.
--   
--   A typical example:
--   
--   100px 200px center:300px right:400px
--   
--   Since: 1.50
tabArrayToString :: (HasCallStack, MonadIO m) => TabArray -> m Text
instance GHC.Classes.Eq GI.Pango.Structs.TabArray.TabArray
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.TabArray.TabArray
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.TabArray.TabArray
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.TabArray.TabArray)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.TabArray.TabArray
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.TabArray.TabArray

-- | A PangoLayoutLine represents one of the lines resulting from
--   laying out a paragraph via PangoLayout.
--   
--   PangoLayoutLine structures are obtained by calling
--   layoutGetLine and are only valid until the text, attributes, or
--   settings of the parent PangoLayout are modified.
module GI.Pango.Structs.LayoutLine

-- | Memory-managed wrapper type.
newtype LayoutLine
LayoutLine :: ManagedPtr LayoutLine -> LayoutLine

-- | Construct a LayoutLine struct initialized to zero.
newZeroLayoutLine :: MonadIO m => m LayoutLine

-- | Computes the logical and ink extents of a layout line.
--   
--   See fontGetGlyphExtents for details about the interpretation of
--   the rectangles.
layoutLineGetExtents :: (HasCallStack, MonadIO m) => LayoutLine -> m (Rectangle, Rectangle)

-- | Computes the height of the line, as the maximum of the heights of
--   fonts used in this line.
--   
--   Note that the actual baseline-to-baseline distance between lines of
--   text is influenced by other factors, such as layoutSetSpacing
--   and layoutSetLineSpacing.
--   
--   Since: 1.44
layoutLineGetHeight :: (HasCallStack, MonadIO m) => LayoutLine -> m Int32

-- | Returns the length of the line, in bytes.
--   
--   Since: 1.50
layoutLineGetLength :: (HasCallStack, MonadIO m) => LayoutLine -> m Int32

-- | Computes the logical and ink extents of layoutLine in
--   device units.
--   
--   This function just calls layoutLineGetExtents followed by two
--   [funcextentsToPixels] calls, rounding
--   inkRect and logicalRect such that the
--   rounded rectangles fully contain the unrounded one (that is, passes
--   them as first argument to [funcextentsToPixels]).
layoutLineGetPixelExtents :: (HasCallStack, MonadIO m) => LayoutLine -> m (Rectangle, Rectangle)

-- | Returns the resolved direction of the line.
--   
--   Since: 1.50
layoutLineGetResolvedDirection :: (HasCallStack, MonadIO m) => LayoutLine -> m Direction

-- | Returns the start index of the line, as byte index into the text of
--   the layout.
--   
--   Since: 1.50
layoutLineGetStartIndex :: (HasCallStack, MonadIO m) => LayoutLine -> m Int32

-- | Gets a list of visual ranges corresponding to a given logical range.
--   
--   This list is not necessarily minimal - there may be consecutive ranges
--   which are adjacent. The ranges will be sorted from left to right. The
--   ranges are with respect to the left edge of the entire layout, not
--   with respect to the line.
layoutLineGetXRanges :: (HasCallStack, MonadIO m) => LayoutLine -> Int32 -> Int32 -> m [Int32]

-- | Converts an index within a line to a X position.
layoutLineIndexToX :: (HasCallStack, MonadIO m) => LayoutLine -> Int32 -> Bool -> m Int32

-- | Returns whether this is the first line of the paragraph.
--   
--   Since: 1.50
layoutLineIsParagraphStart :: (HasCallStack, MonadIO m) => LayoutLine -> m Bool

-- | Increase the reference count of a PangoLayoutLine by one.
--   
--   Since: 1.10
layoutLineRef :: (HasCallStack, MonadIO m) => Maybe LayoutLine -> m (Maybe LayoutLine)

-- | Decrease the reference count of a PangoLayoutLine by one.
--   
--   If the result is zero, the line and all associated memory will be
--   freed.
layoutLineUnref :: (HasCallStack, MonadIO m) => LayoutLine -> m ()

-- | Converts from x offset to the byte index of the corresponding
--   character within the text of the layout.
--   
--   If xPos is outside the line, index_
--   and trailing will point to the very first or very last
--   position in the line. This determination is based on the resolved
--   direction of the paragraph; for example, if the resolved direction is
--   right-to-left, then an X position to the right of the line (after it)
--   results in 0 being stored in index_ and
--   trailing. An X position to the left of the line
--   results in index_ pointing to the (logical) last
--   grapheme in the line and trailing being set to the
--   number of characters in that grapheme. The reverse is true for a
--   left-to-right line.
layoutLineXToIndex :: (HasCallStack, MonadIO m) => LayoutLine -> Int32 -> m (Bool, Int32, Int32)

-- | Get the value of the “is_paragraph_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get layoutLine #isParagraphStart
--   
getLayoutLineIsParagraphStart :: MonadIO m => LayoutLine -> m Word32

-- | Set the value of the “is_paragraph_start” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set layoutLine [ #isParagraphStart := value ]
--   
setLayoutLineIsParagraphStart :: MonadIO m => LayoutLine -> Word32 -> m ()

-- | Set the value of the “layout” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #layout
--   
clearLayoutLineLayout :: MonadIO m => LayoutLine -> m ()

-- | Get the value of the “layout” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get layoutLine #layout
--   
getLayoutLineLayout :: MonadIO m => LayoutLine -> m (Maybe Layout)

-- | Set the value of the “layout” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set layoutLine [ #layout := value ]
--   
setLayoutLineLayout :: MonadIO m => LayoutLine -> Ptr Layout -> m ()

-- | Get the value of the “length” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   get layoutLine #length
--   
getLayoutLineLength :: MonadIO m => LayoutLine -> m Int32

-- | Set the value of the “length” field. When overloading
--   is enabled, this is equivalent to
--   
--   
--   set layoutLine [ #length := value ]
--   
setLayoutLineLength :: MonadIO m => LayoutLine -> Int32 -> m ()

-- | Get the value of the “resolved_dir” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get layoutLine #resolvedDir
--   
getLayoutLineResolvedDir :: MonadIO m => LayoutLine -> m Word32

-- | Set the value of the “resolved_dir” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set layoutLine [ #resolvedDir := value ]
--   
setLayoutLineResolvedDir :: MonadIO m => LayoutLine -> Word32 -> m ()

-- | Set the value of the “runs” field to Nothing. When
--   overloading is enabled, this is equivalent to
--   
--   
--   clear #runs
--   
clearLayoutLineRuns :: MonadIO m => LayoutLine -> m ()

-- | Get the value of the “runs” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   get layoutLine #runs
--   
getLayoutLineRuns :: MonadIO m => LayoutLine -> m [GlyphItem]

-- | Set the value of the “runs” field. When overloading is
--   enabled, this is equivalent to
--   
--   
--   set layoutLine [ #runs := value ]
--   
setLayoutLineRuns :: MonadIO m => LayoutLine -> Ptr (GSList (Ptr GlyphItem)) -> m ()

-- | Get the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   get layoutLine #startIndex
--   
getLayoutLineStartIndex :: MonadIO m => LayoutLine -> m Int32

-- | Set the value of the “start_index” field. When
--   overloading is enabled, this is equivalent to
--   
--   
--   set layoutLine [ #startIndex := value ]
--   
setLayoutLineStartIndex :: MonadIO m => LayoutLine -> Int32 -> m ()
instance (tag GHC.Types.~ 'Data.GI.Base.Attributes.AttrSet) => Data.GI.Base.Constructible.Constructible GI.Pango.Structs.LayoutLine.LayoutLine tag
instance GHC.Classes.Eq GI.Pango.Structs.LayoutLine.LayoutLine
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.LayoutLine.LayoutLine
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.LayoutLine.LayoutLine
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.LayoutLine.LayoutLine)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.LayoutLine.LayoutLine
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.LayoutLine.LayoutLine

-- | A PangoLayoutIter can be used to iterate over the visual
--   extents of a PangoLayout.
--   
--   To obtain a PangoLayoutIter, use layoutGetIter.
--   
--   The PangoLayoutIter structure is opaque, and has no
--   user-visible fields.
module GI.Pango.Structs.LayoutIter

-- | Memory-managed wrapper type.
newtype LayoutIter
LayoutIter :: ManagedPtr LayoutIter -> LayoutIter

-- | Determines whether iter is on the last line of the
--   layout.
layoutIterAtLastLine :: (HasCallStack, MonadIO m) => LayoutIter -> m Bool

-- | Copies a PangoLayoutIter.
--   
--   Since: 1.20
layoutIterCopy :: (HasCallStack, MonadIO m) => Maybe LayoutIter -> m (Maybe LayoutIter)

-- | Frees an iterator that's no longer in use.
layoutIterFree :: (HasCallStack, MonadIO m) => Maybe LayoutIter -> m ()

-- | Gets the Y position of the current line's baseline, in layout
--   coordinates.
--   
--   Layout coordinates have the origin at the top left of the entire
--   layout.
layoutIterGetBaseline :: (HasCallStack, MonadIO m) => LayoutIter -> m Int32

-- | Gets the extents of the current character, in layout coordinates.
--   
--   Layout coordinates have the origin at the top left of the entire
--   layout.
--   
--   Only logical extents can sensibly be obtained for characters; ink
--   extents make sense only down to the level of clusters.
layoutIterGetCharExtents :: (HasCallStack, MonadIO m) => LayoutIter -> m Rectangle

-- | Gets the extents of the current cluster, in layout coordinates.
--   
--   Layout coordinates have the origin at the top left of the entire
--   layout.
layoutIterGetClusterExtents :: (HasCallStack, MonadIO m) => LayoutIter -> m (Rectangle, Rectangle)

-- | Gets the current byte index.
--   
--   Note that iterating forward by char moves in visual order, not logical
--   order, so indexes may not be sequential. Also, the index may be equal
--   to the length of the text in the layout, if on the Nothing run
--   (see layoutIterGetRun).
layoutIterGetIndex :: (HasCallStack, MonadIO m) => LayoutIter -> m Int32

-- | Gets the layout associated with a PangoLayoutIter.
--   
--   Since: 1.20
layoutIterGetLayout :: (HasCallStack, MonadIO m) => LayoutIter -> m (Maybe Layout)

-- | Obtains the extents of the PangoLayout being iterated over.
layoutIterGetLayoutExtents :: (HasCallStack, MonadIO m) => LayoutIter -> m (Rectangle, Rectangle)

-- | Gets the current line.
--   
--   Use the faster layoutIterGetLineReadonly if you do not plan to
--   modify the contents of the line (glyphs, glyph widths, etc.).
layoutIterGetLine :: (HasCallStack, MonadIO m) => LayoutIter -> m (Maybe LayoutLine)

-- | Obtains the extents of the current line.
--   
--   Extents are in layout coordinates (origin is the top-left corner of
--   the entire PangoLayout). Thus the extents returned by this
--   function will be the same width/height but not at the same x/y as the
--   extents returned from layoutLineGetExtents.
layoutIterGetLineExtents :: (HasCallStack, MonadIO m) => LayoutIter -> m (Rectangle, Rectangle)

-- | Gets the current line for read-only access.
--   
--   This is a faster alternative to layoutIterGetLine, but the user
--   is not expected to modify the contents of the line (glyphs, glyph
--   widths, etc.).
--   
--   Since: 1.16
layoutIterGetLineReadonly :: (HasCallStack, MonadIO m) => LayoutIter -> m (Maybe LayoutLine)

-- | Divides the vertical space in the PangoLayout being iterated
--   over between the lines in the layout, and returns the space belonging
--   to the current line.
--   
--   A line's range includes the line's logical extents. plus half of the
--   spacing above and below the line, if layoutSetSpacing has been
--   called to set layout spacing. The Y positions are in layout
--   coordinates (origin at top left of the entire layout).
--   
--   Note: Since 1.44, Pango uses line heights for placing lines, and there
--   may be gaps between the ranges returned by this function.
layoutIterGetLineYrange :: (HasCallStack, MonadIO m) => LayoutIter -> m (Int32, Int32)

-- | Gets the current run.
--   
--   When iterating by run, at the end of each line, there's a position
--   with a Nothing run, so this function can return Nothing.
--   The Nothing run at the end of each line ensures that all lines
--   have at least one run, even lines consisting of only a newline.
--   
--   Use the faster layoutIterGetRunReadonly if you do not plan to
--   modify the contents of the run (glyphs, glyph widths, etc.).
layoutIterGetRun :: (HasCallStack, MonadIO m) => LayoutIter -> m (Maybe GlyphItem)

-- | Gets the Y position of the current run's baseline, in layout
--   coordinates.
--   
--   Layout coordinates have the origin at the top left of the entire
--   layout.
--   
--   The run baseline can be different from the line baseline, for example
--   due to superscript or subscript positioning.
--   
--   Since: 1.50
layoutIterGetRunBaseline :: (HasCallStack, MonadIO m) => LayoutIter -> m Int32

-- | Gets the extents of the current run in layout coordinates.
--   
--   Layout coordinates have the origin at the top left of the entire
--   layout.
layoutIterGetRunExtents :: (HasCallStack, MonadIO m) => LayoutIter -> m (Rectangle, Rectangle)

-- | Gets the current run for read-only access.
--   
--   When iterating by run, at the end of each line, there's a position
--   with a Nothing run, so this function can return Nothing.
--   The Nothing run at the end of each line ensures that all lines
--   have at least one run, even lines consisting of only a newline.
--   
--   This is a faster alternative to layoutIterGetRun, but the user
--   is not expected to modify the contents of the run (glyphs, glyph
--   widths, etc.).
--   
--   Since: 1.16
layoutIterGetRunReadonly :: (HasCallStack, MonadIO m) => LayoutIter -> m (Maybe GlyphItem)

-- | Moves iter forward to the next character in visual
--   order.
--   
--   If iter was already at the end of the layout, returns
--   False.
layoutIterNextChar :: (HasCallStack, MonadIO m) => LayoutIter -> m Bool

-- | Moves iter forward to the next cluster in visual
--   order.
--   
--   If iter was already at the end of the layout, returns
--   False.
layoutIterNextCluster :: (HasCallStack, MonadIO m) => LayoutIter -> m Bool

-- | Moves iter forward to the start of the next line.
--   
--   If iter is already on the last line, returns
--   False.
layoutIterNextLine :: (HasCallStack, MonadIO m) => LayoutIter -> m Bool

-- | Moves iter forward to the next run in visual order.
--   
--   If iter was already at the end of the layout, returns
--   False.
layoutIterNextRun :: (HasCallStack, MonadIO m) => LayoutIter -> m Bool
instance GHC.Classes.Eq GI.Pango.Structs.LayoutIter.LayoutIter
instance Data.GI.Base.BasicTypes.GBoxed GI.Pango.Structs.LayoutIter.LayoutIter
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Structs.LayoutIter.LayoutIter
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Structs.LayoutIter.LayoutIter)
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Structs.LayoutIter.LayoutIter
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Structs.LayoutIter.LayoutIter

module GI.Pango.Structs

-- | PangoRenderer is a base class for objects that can render
--   text provided as PangoGlyphString or PangoLayout.
--   
--   By subclassing PangoRenderer and overriding operations such
--   as drawGlyphs and drawRectangle,
--   renderers for particular font backends and destinations can be
--   created.
--   
--   Since: 1.8
module GI.Pango.Objects.Renderer

-- | Memory-managed wrapper type.
newtype Renderer
Renderer :: ManagedPtr Renderer -> Renderer

-- | Type class for types which can be safely cast to Renderer, for
--   instance with toRenderer.
class (GObject o, IsDescendantOf Renderer o) => IsRenderer o

-- | Cast to Renderer, for types for which this is known to be safe.
--   For general casts, use castTo.
toRenderer :: (MonadIO m, IsRenderer o) => o -> m Renderer

-- | Does initial setup before rendering operations on
--   renderer.
--   
--   rendererDeactivate should be called when done drawing. Calls
--   such as rendererDrawLayout automatically activate the layout
--   before drawing on it.
--   
--   Calls to rendererActivate and rendererDeactivate can be
--   nested and the renderer will only be initialized and deinitialized
--   once.
--   
--   Since: 1.8
rendererActivate :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m ()

-- | Cleans up after rendering operations on renderer.
--   
--   See docs for rendererActivate.
--   
--   Since: 1.8
rendererDeactivate :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m ()

-- | Draw a squiggly line that approximately covers the given rectangle in
--   the style of an underline used to indicate a spelling error.
--   
--   The width of the underline is rounded to an integer number of up/down
--   segments and the resulting rectangle is centered in the original
--   rectangle.
--   
--   This should be called while renderer is already
--   active. Use rendererActivate to activate a renderer.
--   
--   Since: 1.8
rendererDrawErrorUnderline :: (HasCallStack, MonadIO m, IsRenderer a) => a -> Int32 -> Int32 -> Int32 -> Int32 -> m ()

-- | Draws a single glyph with coordinates in device space.
--   
--   Since: 1.8
rendererDrawGlyph :: (HasCallStack, MonadIO m, IsRenderer a, IsFont b) => a -> b -> Word32 -> Double -> Double -> m ()

-- | Draws the glyphs in glyphItem with the specified
--   PangoRenderer, embedding the text associated with the glyphs
--   in the output if the output format supports it.
--   
--   This is useful for rendering text in PDF.
--   
--   Note that this method does not handle attributes in
--   glyphItem. If you want colors, shapes and lines
--   handled automatically according to those attributes, you need to use
--   rendererDrawLayoutLine or rendererDrawLayout.
--   
--   Note that text is the start of the text for layout,
--   which is then indexed by glyph_item->item->offset.
--   
--   If text is Nothing, this simply calls
--   rendererDrawGlyphs.
--   
--   The default implementation of this method simply falls back to
--   rendererDrawGlyphs.
--   
--   Since: 1.22
rendererDrawGlyphItem :: (HasCallStack, MonadIO m, IsRenderer a) => a -> Maybe Text -> GlyphItem -> Int32 -> Int32 -> m ()

-- | Draws the glyphs in glyphs with the specified
--   PangoRenderer.
--   
--   Since: 1.8
rendererDrawGlyphs :: (HasCallStack, MonadIO m, IsRenderer a, IsFont b) => a -> b -> GlyphString -> Int32 -> Int32 -> m ()

-- | Draws layout with the specified
--   PangoRenderer.
--   
--   This is equivalent to drawing the lines of the layout, at their
--   respective positions relative to x, y.
--   
--   Since: 1.8
rendererDrawLayout :: (HasCallStack, MonadIO m, IsRenderer a, IsLayout b) => a -> b -> Int32 -> Int32 -> m ()

-- | Draws line with the specified PangoRenderer.
--   
--   This draws the glyph items that make up the line, as well as shapes,
--   backgrounds and lines that are specified by the attributes of those
--   items.
--   
--   Since: 1.8
rendererDrawLayoutLine :: (HasCallStack, MonadIO m, IsRenderer a) => a -> LayoutLine -> Int32 -> Int32 -> m ()

-- | Draws an axis-aligned rectangle in user space coordinates with the
--   specified PangoRenderer.
--   
--   This should be called while renderer is already
--   active. Use rendererActivate to activate a renderer.
--   
--   Since: 1.8
rendererDrawRectangle :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> Int32 -> Int32 -> Int32 -> Int32 -> m ()

-- | Draws a trapezoid with the parallel sides aligned with the X axis
--   using the given PangoRenderer; coordinates are in device
--   space.
--   
--   Since: 1.8
rendererDrawTrapezoid :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> Double -> Double -> Double -> Double -> Double -> Double -> m ()

-- | Gets the current alpha for the specified part.
--   
--   Since: 1.38
rendererGetAlpha :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> m Word16

-- | Gets the current rendering color for the specified part.
--   
--   Since: 1.8
rendererGetColor :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> m (Maybe Color)

-- | Gets the layout currently being rendered using
--   renderer.
--   
--   Calling this function only makes sense from inside a subclass's
--   methods, like in its draw_shape vfunc, for example.
--   
--   The returned layout should not be modified while still being rendered.
--   
--   Since: 1.20
rendererGetLayout :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m (Maybe Layout)

-- | Gets the layout line currently being rendered using
--   renderer.
--   
--   Calling this function only makes sense from inside a subclass's
--   methods, like in its draw_shape vfunc, for example.
--   
--   The returned layout line should not be modified while still being
--   rendered.
--   
--   Since: 1.20
rendererGetLayoutLine :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m (Maybe LayoutLine)

-- | Gets the transformation matrix that will be applied when rendering.
--   
--   See rendererSetMatrix.
--   
--   Since: 1.8
rendererGetMatrix :: (HasCallStack, MonadIO m, IsRenderer a) => a -> m (Maybe Matrix)

-- | Informs Pango that the way that the rendering is done for
--   part has changed.
--   
--   This should be called if the rendering changes in a way that would
--   prevent multiple pieces being joined together into one drawing call.
--   For instance, if a subclass of PangoRenderer was to add a
--   stipple option for drawing underlines, it needs to call
--   
--   
--   pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
--   
--   
--   When the stipple changes or underlines with different stipples might
--   be joined together. Pango automatically calls this for changes to
--   colors. (See rendererSetColor)
--   
--   Since: 1.8
rendererPartChanged :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> m ()

-- | Sets the alpha for part of the rendering.
--   
--   Note that the alpha may only be used if a color is specified for
--   part as well.
--   
--   Since: 1.38
rendererSetAlpha :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> Word16 -> m ()

-- | Sets the color for part of the rendering.
--   
--   Also see rendererSetAlpha.
--   
--   Since: 1.8
rendererSetColor :: (HasCallStack, MonadIO m, IsRenderer a) => a -> RenderPart -> Maybe Color -> m ()

-- | Sets the transformation matrix that will be applied when rendering.
--   
--   Since: 1.8
rendererSetMatrix :: (HasCallStack, MonadIO m, IsRenderer a) => a -> Maybe Matrix -> m ()
instance GHC.Classes.Eq GI.Pango.Objects.Renderer.Renderer
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Renderer.Renderer
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Renderer.Renderer
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Renderer.Renderer)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Renderer.Renderer o) => GI.Pango.Objects.Renderer.IsRenderer o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Renderer.Renderer
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Renderer.Renderer

-- | A PangoLayout structure represents an entire paragraph of
--   text.
--   
--   While complete access to the layout capabilities of Pango is provided
--   using the detailed interfaces for itemization and shaping, using that
--   functionality directly involves writing a fairly large amount of code.
--   PangoLayout provides a high-level driver for formatting
--   entire paragraphs of text at once. This includes paragraph-level
--   functionality such as line breaking, justification, alignment and
--   ellipsization.
--   
--   A PangoLayout is initialized with a PangoContext,
--   UTF-8 string and set of attributes for that string. Once that is done,
--   the set of formatted lines can be extracted from the object, the
--   layout can be rendered, and conversion between logical character
--   positions within the layout's text, and the physical position of the
--   resulting glyphs can be made.
--   
--   There are a number of parameters to adjust the formatting of a
--   PangoLayout. The following image shows adjustable parameters
--   (on the left) and font metrics (on the right):
--   
--   <picture> <source srcset="layout-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Pango Layout
--   Parameters" src="layout-light.png"> </picture>
--   
--   The following images demonstrate the effect of alignment and
--   justification on the layout of text:
--   
--   | | | | --- | --- | | | | | | | | | |
--   
--   It is possible, as well, to ignore the 2-D setup, and simply treat the
--   results of a PangoLayout as a list of lines.
module GI.Pango.Objects.Layout

-- | Memory-managed wrapper type.
newtype Layout
Layout :: ManagedPtr Layout -> Layout

-- | Type class for types which can be safely cast to Layout, for
--   instance with toLayout.
class (GObject o, IsDescendantOf Layout o) => IsLayout o

-- | Cast to Layout, for types for which this is known to be safe.
--   For general casts, use castTo.
toLayout :: (MonadIO m, IsLayout o) => o -> m Layout

-- | Forces recomputation of any state in the PangoLayout that
--   might depend on the layout's context.
--   
--   This function should be called if you make changes to the context
--   subsequent to creating the layout.
layoutContextChanged :: (HasCallStack, MonadIO m, IsLayout a) => a -> m ()

-- | Creates a deep copy-by-value of the layout.
--   
--   The attribute list, tab array, and text from the original layout are
--   all copied by value.
layoutCopy :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Layout

-- | Loads data previously created via layoutSerialize.
--   
--   For a discussion of the supported format, see that function.
--   
--   Note: to verify that the returned layout is identical to the one that
--   was serialized, you can compare bytes to the result of
--   serializing the layout again.
--   
--   Since: 1.50
layoutDeserialize :: (HasCallStack, MonadIO m, IsContext a) => a -> Bytes -> [LayoutDeserializeFlags] -> m (Maybe Layout)

-- | Gets the alignment for the layout: how partial lines are positioned
--   within the horizontal space available.
layoutGetAlignment :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Alignment

-- | Gets the attribute list for the layout, if any.
layoutGetAttributes :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Maybe AttrList)

-- | Gets whether to calculate the base direction for the layout according
--   to its contents.
--   
--   See layoutSetAutoDir.
--   
--   Since: 1.4
layoutGetAutoDir :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Gets the Y position of baseline of the first line in
--   layout.
--   
--   Since: 1.22
layoutGetBaseline :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Given an index within a layout, determines the positions that of the
--   strong and weak cursors if the insertion point is at that index.
--   
--   This is a variant of layoutGetCursorPos that applies font
--   metric information about caret slope and offset to the positions it
--   returns.
--   
--   <picture> <source srcset="caret-metrics-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Caret metrics"
--   src="caret-metrics-light.png"> </picture>
--   
--   Since: 1.50
layoutGetCaretPos :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m (Rectangle, Rectangle)

-- | Returns the number of Unicode characters in the the text of
--   layout.
--   
--   Since: 1.30
layoutGetCharacterCount :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Retrieves the PangoContext used for this layout.
layoutGetContext :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Context

-- | Given an index within a layout, determines the positions that of the
--   strong and weak cursors if the insertion point is at that index.
--   
--   The position of each cursor is stored as a zero-width rectangle with
--   the height of the run extents.
--   
--   <picture> <source srcset="cursor-positions-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Cursor
--   positions" src="cursor-positions-light.png"> </picture>
--   
--   The strong cursor location is the location where characters of the
--   directionality equal to the base direction of the layout are inserted.
--   The weak cursor location is the location where characters of the
--   directionality opposite to the base direction of the layout are
--   inserted.
--   
--   The following example shows text with both a strong and a weak cursor.
--   
--   <picture> <source srcset="split-cursor-dark.png"
--   media="(prefers-color-scheme: dark)"> <img alt="Strong and weak
--   cursors" src="split-cursor-light.png"> </picture>
--   
--   The strong cursor has a little arrow pointing to the right, the weak
--   cursor to the left. Typing a 'c' in this situation will insert the
--   character after the 'b', and typing another Hebrew character, like
--   'ג', will insert it at the end.
layoutGetCursorPos :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m (Rectangle, Rectangle)

-- | Gets the text direction at the given character position in
--   layout.
--   
--   Since: 1.46
layoutGetDirection :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m Direction

-- | Gets the type of ellipsization being performed for
--   layout.
--   
--   See layoutSetEllipsize.
--   
--   Use layoutIsEllipsized to query whether any paragraphs were
--   actually ellipsized.
--   
--   Since: 1.6
layoutGetEllipsize :: (HasCallStack, MonadIO m, IsLayout a) => a -> m EllipsizeMode

-- | Computes the logical and ink extents of layout.
--   
--   Logical extents are usually what you want for positioning things. Note
--   that both extents may have non-zero x and y. You may want to use those
--   to offset where you render the layout. Not doing that is a very
--   typical bug that shows up as right-to-left layouts not being correctly
--   positioned in a layout with a set width.
--   
--   The extents are given in layout coordinates and in Pango units; layout
--   coordinates begin at the top left corner of the layout.
layoutGetExtents :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Rectangle, Rectangle)

-- | Gets the font description for the layout, if any.
--   
--   Since: 1.8
layoutGetFontDescription :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Maybe FontDescription)

-- | Gets the height of layout used for ellipsization.
--   
--   See layoutSetHeight for details.
--   
--   Since: 1.20
layoutGetHeight :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Gets the paragraph indent width in Pango units.
--   
--   A negative value indicates a hanging indentation.
layoutGetIndent :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Returns an iterator to iterate over the visual extents of the layout.
layoutGetIter :: (HasCallStack, MonadIO m, IsLayout a) => a -> m LayoutIter

-- | Gets whether each complete line should be stretched to fill the entire
--   width of the layout.
layoutGetJustify :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Gets whether the last line should be stretched to fill the entire
--   width of the layout.
--   
--   Since: 1.50
layoutGetJustifyLastLine :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Retrieves a particular line from a PangoLayout.
--   
--   Use the faster layoutGetLineReadonly if you do not plan to
--   modify the contents of the line (glyphs, glyph widths, etc.).
layoutGetLine :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m (Maybe LayoutLine)

-- | Retrieves the count of lines for the layout.
layoutGetLineCount :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Retrieves a particular line from a PangoLayout.
--   
--   This is a faster alternative to layoutGetLine, but the user is
--   not expected to modify the contents of the line (glyphs, glyph widths,
--   etc.).
--   
--   Since: 1.16
layoutGetLineReadonly :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m (Maybe LayoutLine)

-- | Gets the line spacing factor of layout.
--   
--   See layoutSetLineSpacing.
--   
--   Since: 1.44
layoutGetLineSpacing :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Float

-- | Returns the lines of the layout as a list.
--   
--   Use the faster layoutGetLinesReadonly if you do not plan to
--   modify the contents of the lines (glyphs, glyph widths, etc.).
layoutGetLines :: (HasCallStack, MonadIO m, IsLayout a) => a -> m [LayoutLine]

-- | Returns the lines of the layout as a list.
--   
--   This is a faster alternative to layoutGetLines, but the user is
--   not expected to modify the contents of the lines (glyphs, glyph
--   widths, etc.).
--   
--   Since: 1.16
layoutGetLinesReadonly :: (HasCallStack, MonadIO m, IsLayout a) => a -> m [LayoutLine]

-- | Retrieves an array of logical attributes for each character in the
--   layout.
layoutGetLogAttrs :: (HasCallStack, MonadIO m, IsLayout a) => a -> m [LogAttr]

-- | Retrieves an array of logical attributes for each character in the
--   layout.
--   
--   This is a faster alternative to layoutGetLogAttrs. The returned
--   array is part of layout and must not be modified.
--   Modifying the layout will invalidate the returned array.
--   
--   The number of attributes returned in nAttrs will be
--   one more than the total number of characters in the layout, since
--   there need to be attributes corresponding to both the position before
--   the first character and the position after the last character.
--   
--   Since: 1.30
layoutGetLogAttrsReadonly :: (HasCallStack, MonadIO m, IsLayout a) => a -> m [LogAttr]

-- | Computes the logical and ink extents of layout in
--   device units.
--   
--   This function just calls layoutGetExtents followed by two
--   [funcextentsToPixels] calls, rounding
--   inkRect and logicalRect such that the
--   rounded rectangles fully contain the unrounded one (that is, passes
--   them as first argument to extentsToPixels).
layoutGetPixelExtents :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Rectangle, Rectangle)

-- | Determines the logical width and height of a PangoLayout in
--   device units.
--   
--   layoutGetSize returns the width and height scaled by
--   SCALE. This is simply a convenience function around
--   layoutGetPixelExtents.
layoutGetPixelSize :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Int32, Int32)

-- | Returns the current serial number of layout.
--   
--   The serial number is initialized to an small number larger than zero
--   when a new layout is created and is increased whenever the layout is
--   changed using any of the setter functions, or the
--   PangoContext it uses has changed. The serial may wrap, but
--   will never have the value 0. Since it can wrap, never compare it with
--   "less than", always use "not equals".
--   
--   This can be used to automatically detect changes to a
--   PangoLayout, and is useful for example to decide whether a
--   layout needs redrawing. To force the serial to be increased, use
--   layoutContextChanged.
--   
--   Since: 1.32.4
layoutGetSerial :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Word32

-- | Obtains whether layout is in single paragraph mode.
--   
--   See layoutSetSingleParagraphMode.
layoutGetSingleParagraphMode :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Determines the logical width and height of a PangoLayout in
--   Pango units.
--   
--   This is simply a convenience function around layoutGetExtents.
layoutGetSize :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Int32, Int32)

-- | Gets the amount of spacing between the lines of the layout.
layoutGetSpacing :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Gets the current PangoTabArray used by this layout.
--   
--   If no PangoTabArray has been set, then the default tabs are
--   in use and Nothing is returned. Default tabs are every 8
--   spaces.
--   
--   The return value should be freed with tabArrayFree.
layoutGetTabs :: (HasCallStack, MonadIO m, IsLayout a) => a -> m (Maybe TabArray)

-- | Gets the text in the layout.
--   
--   The returned text should not be freed or modified.
layoutGetText :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Text

-- | Counts the number of unknown glyphs in layout.
--   
--   This function can be used to determine if there are any fonts
--   available to render all characters in a certain string, or when used
--   in combination with AttrTypeFallback, to check if a certain
--   font supports all the characters in the string.
--   
--   Since: 1.16
layoutGetUnknownGlyphsCount :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Gets the width to which the lines of the PangoLayout should
--   wrap.
layoutGetWidth :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Int32

-- | Gets the wrap mode for the layout.
--   
--   Use layoutIsWrapped to query whether any paragraphs were
--   actually wrapped.
layoutGetWrap :: (HasCallStack, MonadIO m, IsLayout a) => a -> m WrapMode

-- | Converts from byte index_ within the
--   layout to line and X position.
--   
--   The X position is measured from the left edge of the line.
layoutIndexToLineX :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> Bool -> m (Int32, Int32)

-- | Converts from an index within a PangoLayout to the onscreen
--   position corresponding to the grapheme at that index.
--   
--   The returns is represented as rectangle. Note that pos->x
--   is always the leading edge of the grapheme and pos->x +
--   pos->width the trailing edge of the grapheme. If the
--   directionality of the grapheme is right-to-left, then
--   pos->width will be negative.
layoutIndexToPos :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m Rectangle

-- | Queries whether the layout had to ellipsize any paragraphs.
--   
--   This returns True if the ellipsization mode for
--   layout is not EllipsizeModeNone, a positive
--   width is set on layout, and there are paragraphs
--   exceeding that width that have to be ellipsized.
--   
--   Since: 1.16
layoutIsEllipsized :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Queries whether the layout had to wrap any paragraphs.
--   
--   This returns True if a positive width is set on
--   layout, and there are paragraphs exceeding the layout
--   width that have to be wrapped.
--   
--   Since: 1.16
layoutIsWrapped :: (HasCallStack, MonadIO m, IsLayout a) => a -> m Bool

-- | Computes a new cursor position from an old position and a direction.
--   
--   If direction is positive, then the new position will
--   cause the strong or weak cursor to be displayed one position to right
--   of where it was with the old cursor position. If
--   direction is negative, it will be moved to the left.
--   
--   In the presence of bidirectional text, the correspondence between
--   logical and visual order will depend on the direction of the current
--   run, and there may be jumps when the cursor is moved off of the end of
--   a run.
--   
--   Motion here is in cursor positions, not in characters, so a single
--   call to this function may move the cursor over multiple characters
--   when multiple characters combine to form a single grapheme.
layoutMoveCursorVisually :: (HasCallStack, MonadIO m, IsLayout a) => a -> Bool -> Int32 -> Int32 -> Int32 -> m (Int32, Int32)

-- | Create a new PangoLayout object with attributes initialized
--   to default values for a particular PangoContext.
layoutNew :: (HasCallStack, MonadIO m, IsContext a) => a -> m Layout

-- | Serializes the layout for later deserialization via
--   layoutDeserialize.
--   
--   There are no guarantees about the format of the output across
--   different versions of Pango and layoutDeserialize will reject
--   data that it cannot parse.
--   
--   The intended use of this function is testing, benchmarking and
--   debugging. The format is not meant as a permanent storage format.
--   
--   Since: 1.50
layoutSerialize :: (HasCallStack, MonadIO m, IsLayout a) => a -> [LayoutSerializeFlags] -> m Bytes

-- | Sets the alignment for the layout: how partial lines are positioned
--   within the horizontal space available.
--   
--   The default alignment is AlignmentLeft.
layoutSetAlignment :: (HasCallStack, MonadIO m, IsLayout a) => a -> Alignment -> m ()

-- | Sets the text attributes for a layout object.
--   
--   References attrs, so the caller can unref its
--   reference.
layoutSetAttributes :: (HasCallStack, MonadIO m, IsLayout a) => a -> Maybe AttrList -> m ()

-- | Sets whether to calculate the base direction for the layout according
--   to its contents.
--   
--   When this flag is on (the default), then paragraphs in
--   layout that begin with strong right-to-left characters
--   (Arabic and Hebrew principally), will have right-to-left layout,
--   paragraphs with letters from other scripts will have left-to-right
--   layout. Paragraphs with only neutral characters get their direction
--   from the surrounding paragraphs.
--   
--   When False, the choice between left-to-right and right-to-left
--   layout is done according to the base direction of the layout's
--   PangoContext. (See contextSetBaseDir).
--   
--   When the auto-computed direction of a paragraph differs from the base
--   direction of the context, the interpretation of AlignmentLeft
--   and AlignmentRight are swapped.
--   
--   Since: 1.4
layoutSetAutoDir :: (HasCallStack, MonadIO m, IsLayout a) => a -> Bool -> m ()

-- | Sets the type of ellipsization being performed for
--   layout.
--   
--   Depending on the ellipsization mode ellipsize text is
--   removed from the start, middle, or end of text so they fit within the
--   width and height of layout set with layoutSetWidth and
--   layoutSetHeight.
--   
--   If the layout contains characters such as newlines that force it to be
--   layed out in multiple paragraphs, then whether each paragraph is
--   ellipsized separately or the entire layout is ellipsized as a whole
--   depends on the set height of the layout.
--   
--   The default value is EllipsizeModeNone.
--   
--   See layoutSetHeight for details.
--   
--   Since: 1.6
layoutSetEllipsize :: (HasCallStack, MonadIO m, IsLayout a) => a -> EllipsizeMode -> m ()

-- | Sets the default font description for the layout.
--   
--   If no font description is set on the layout, the font description from
--   the layout's context is used.
layoutSetFontDescription :: (HasCallStack, MonadIO m, IsLayout a) => a -> Maybe FontDescription -> m ()

-- | Sets the height to which the PangoLayout should be ellipsized
--   at.
--   
--   There are two different behaviors, based on whether
--   height is positive or negative.
--   
--   If height is positive, it will be the maximum height
--   of the layout. Only lines would be shown that would fit, and if there
--   is any text omitted, an ellipsis added. At least one line is included
--   in each paragraph regardless of how small the height value is. A value
--   of zero will render exactly one line for the entire layout.
--   
--   If height is negative, it will be the (negative of)
--   maximum number of lines per paragraph. That is, the total number of
--   lines shown may well be more than this value if the layout contains
--   multiple paragraphs of text. The default value of -1 means that the
--   first line of each paragraph is ellipsized. This behavior may be
--   changed in the future to act per layout instead of per paragraph. File
--   a bug against pango at https://gitlab.gnome.org/gnome/pango if
--   your code relies on this behavior.
--   
--   Height setting only has effect if a positive width is set on
--   layout and ellipsization mode of
--   layout is not EllipsizeModeNone. The behavior
--   is undefined if a height other than -1 is set and ellipsization mode
--   is set to EllipsizeModeNone, and may change in the future.
--   
--   Since: 1.20
layoutSetHeight :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m ()

-- | Sets the width in Pango units to indent each paragraph.
--   
--   A negative value of indent will produce a hanging
--   indentation. That is, the first line will have the full width, and
--   subsequent lines will be indented by the absolute value of
--   indent.
--   
--   The indent setting is ignored if layout alignment is set to
--   AlignmentCenter.
--   
--   The default value is 0.
layoutSetIndent :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m ()

-- | Sets whether each complete line should be stretched to fill the entire
--   width of the layout.
--   
--   Stretching is typically done by adding whitespace, but for some
--   scripts (such as Arabic), the justification may be done in more
--   complex ways, like extending the characters.
--   
--   Note that this setting is not implemented and so is ignored in Pango
--   older than 1.18.
--   
--   Note that tabs and justification conflict with each other:
--   Justification will move content away from its tab-aligned positions.
--   
--   The default value is False.
--   
--   Also see layoutSetJustifyLastLine.
layoutSetJustify :: (HasCallStack, MonadIO m, IsLayout a) => a -> Bool -> m ()

-- | Sets whether the last line should be stretched to fill the entire
--   width of the layout.
--   
--   This only has an effect if layoutSetJustify has been called as
--   well.
--   
--   The default value is False.
--   
--   Since: 1.50
layoutSetJustifyLastLine :: (HasCallStack, MonadIO m, IsLayout a) => a -> Bool -> m ()

-- | Sets a factor for line spacing.
--   
--   Typical values are: 0, 1, 1.5, 2. The default values is 0.
--   
--   If factor is non-zero, lines are placed so that
--   
--   baseline2 = baseline1 + factor * height2
--   
--   where height2 is the line height of the second line (as determined by
--   the font(s)). In this case, the spacing set with
--   layoutSetSpacing is ignored.
--   
--   If factor is zero (the default), spacing is applied as
--   before.
--   
--   Note: for semantics that are closer to the CSS line-height property,
--   see attrLineHeightNew.
--   
--   Since: 1.44
layoutSetLineSpacing :: (HasCallStack, MonadIO m, IsLayout a) => a -> Float -> m ()

-- | Sets the layout text and attribute list from marked-up text.
--   
--   See Pango Markup).
--   
--   Replaces the current text and attribute list.
--   
--   This is the same as layoutSetMarkupWithAccel, but the markup
--   text isn't scanned for accelerators.
layoutSetMarkup :: (HasCallStack, MonadIO m, IsLayout a) => a -> Text -> Int32 -> m ()

-- | Sets the layout text and attribute list from marked-up text.
--   
--   See Pango Markup).
--   
--   Replaces the current text and attribute list.
--   
--   If accelMarker is nonzero, the given character will
--   mark the character following it as an accelerator. For example,
--   accelMarker might be an ampersand or underscore. All
--   characters marked as an accelerator will receive a UnderlineLow
--   attribute, and the first character so marked will be returned in
--   accelChar. Two accelMarker characters
--   following each other produce a single literal
--   accelMarker character.
layoutSetMarkupWithAccel :: (HasCallStack, MonadIO m, IsLayout a) => a -> Text -> Int32 -> Char -> m Char

-- | Sets the single paragraph mode of layout.
--   
--   If setting is True, do not treat newlines and
--   similar characters as paragraph separators; instead, keep all text in
--   a single paragraph, and display a glyph for paragraph separator
--   characters. Used when you want to allow editing of newlines on a
--   single text line.
--   
--   The default value is False.
layoutSetSingleParagraphMode :: (HasCallStack, MonadIO m, IsLayout a) => a -> Bool -> m ()

-- | Sets the amount of spacing in Pango units between the lines of the
--   layout.
--   
--   When placing lines with spacing, Pango arranges things so that
--   
--   line2.top = line1.bottom + spacing
--   
--   The default value is 0.
--   
--   Note: Since 1.44, Pango is using the line height (as determined by the
--   font) for placing lines when the line spacing factor is set to a
--   non-zero value with layoutSetLineSpacing. In that case, the
--   spacing set with this function is ignored.
--   
--   Note: for semantics that are closer to the CSS line-height property,
--   see attrLineHeightNew.
layoutSetSpacing :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m ()

-- | Sets the tabs to use for layout, overriding the
--   default tabs.
--   
--   PangoLayout will place content at the next tab position
--   whenever it meets a Tab character (U+0009).
--   
--   By default, tabs are every 8 spaces. If tabs is
--   Nothing, the default tabs are reinstated. tabs
--   is copied into the layout; you must free your copy of
--   tabs yourself.
--   
--   Note that tabs and justification conflict with each other:
--   Justification will move content away from its tab-aligned positions.
--   The same is true for alignments other than AlignmentLeft.
layoutSetTabs :: (HasCallStack, MonadIO m, IsLayout a) => a -> Maybe TabArray -> m ()

-- | Sets the text of the layout.
--   
--   This function validates text and renders invalid UTF-8
--   with a placeholder glyph.
--   
--   Note that if you have used layoutSetMarkup or
--   layoutSetMarkupWithAccel on layout before, you
--   may want to call layoutSetAttributes to clear the attributes
--   set on the layout from the markup as this function does not clear
--   attributes.
layoutSetText :: (HasCallStack, MonadIO m, IsLayout a) => a -> Text -> Int32 -> m ()

-- | Sets the width to which the lines of the PangoLayout should
--   wrap or get ellipsized.
--   
--   The default value is -1: no width set.
layoutSetWidth :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> m ()

-- | Sets the wrap mode.
--   
--   The wrap mode only has effect if a width is set on the layout with
--   layoutSetWidth. To turn off wrapping, set the width to -1.
--   
--   The default value is WrapModeWord.
layoutSetWrap :: (HasCallStack, MonadIO m, IsLayout a) => a -> WrapMode -> m ()

-- | A convenience method to serialize a layout to a file.
--   
--   It is equivalent to calling layoutSerialize followed by
--   fileSetContents.
--   
--   See those two functions for details on the arguments.
--   
--   It is mostly intended for use inside a debugger to quickly dump a
--   layout to a file for later inspection.
--   
--   Since: 1.50
layoutWriteToFile :: (HasCallStack, MonadIO m, IsLayout a) => a -> [LayoutSerializeFlags] -> [Char] -> m ()

-- | Converts from X and Y position within a layout to the byte index to
--   the character at that logical position.
--   
--   If the Y position is not inside the layout, the closest position is
--   chosen (the position will be clamped inside the layout). If the X
--   position is not within the layout, then the start or the end of the
--   line is chosen as described for layoutLineXToIndex. If either
--   the X or Y positions were not inside the layout, then the function
--   returns False; on an exact hit, it returns True.
layoutXyToIndex :: (HasCallStack, MonadIO m, IsLayout a) => a -> Int32 -> Int32 -> m (Bool, Int32, Int32)
instance GHC.Classes.Eq GI.Pango.Objects.Layout.Layout
instance Data.GI.Base.BasicTypes.GObject GI.Pango.Objects.Layout.Layout
instance Data.GI.Base.Overloading.HasParentTypes GI.Pango.Objects.Layout.Layout
instance Data.GI.Base.GValue.IsGValue (GHC.Internal.Maybe.Maybe GI.Pango.Objects.Layout.Layout)
instance (Data.GI.Base.BasicTypes.GObject o, Data.GI.Base.Overloading.IsDescendantOf GI.Pango.Objects.Layout.Layout o) => GI.Pango.Objects.Layout.IsLayout o
instance Data.GI.Base.BasicTypes.ManagedPtrNewtype GI.Pango.Objects.Layout.Layout
instance Data.GI.Base.BasicTypes.TypedObject GI.Pango.Objects.Layout.Layout

module GI.Pango.Objects

module GI.Pango
