gi-pango-1.0.23: Pango bindings

Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Pango.Structs.Analysis

Contents

- Exported types
- Methods
  - Overloaded methods
- Properties
  - extraAttrs
  - flags
  - font
  - gravity
  - langEngine
  - language
  - level
  - script
  - shapeEngine

Description

The `Analysis` structure stores information about the properties of a segment of text.

Synopsis

- newtype Analysis = Analysis (ManagedPtr Analysis)
- newZeroAnalysis :: MonadIO m => m Analysis
- clearAnalysisExtraAttrs :: MonadIO m => Analysis -> m ()
- getAnalysisExtraAttrs :: MonadIO m => Analysis -> m [Ptr ()]
- setAnalysisExtraAttrs :: MonadIO m => Analysis -> Ptr (GSList (Ptr ())) -> m ()
- getAnalysisFlags :: MonadIO m => Analysis -> m Word8
- setAnalysisFlags :: MonadIO m => Analysis -> Word8 -> m ()
- clearAnalysisFont :: MonadIO m => Analysis -> m ()
- getAnalysisFont :: MonadIO m => Analysis -> m (Maybe Font)
- setAnalysisFont :: MonadIO m => Analysis -> Ptr Font -> m ()
- getAnalysisGravity :: MonadIO m => Analysis -> m Word8
- setAnalysisGravity :: MonadIO m => Analysis -> Word8 -> m ()
- clearAnalysisLangEngine :: MonadIO m => Analysis -> m ()
- getAnalysisLangEngine :: MonadIO m => Analysis -> m (Maybe EngineLang)
- setAnalysisLangEngine :: MonadIO m => Analysis -> Ptr EngineLang -> m ()
- clearAnalysisLanguage :: MonadIO m => Analysis -> m ()
- getAnalysisLanguage :: MonadIO m => Analysis -> m (Maybe Language)
- setAnalysisLanguage :: MonadIO m => Analysis -> Ptr Language -> m ()
- getAnalysisLevel :: MonadIO m => Analysis -> m Word8
- setAnalysisLevel :: MonadIO m => Analysis -> Word8 -> m ()
- getAnalysisScript :: MonadIO m => Analysis -> m Word8
- setAnalysisScript :: MonadIO m => Analysis -> Word8 -> m ()
- clearAnalysisShapeEngine :: MonadIO m => Analysis -> m ()
- getAnalysisShapeEngine :: MonadIO m => Analysis -> m (Maybe EngineShape)
- setAnalysisShapeEngine :: MonadIO m => Analysis -> Ptr EngineShape -> m ()

# Exported types

newtype Analysis Source #

Memory-managed wrapper type.

Constructors

Analysis (ManagedPtr Analysis) |

#### Instances

Instances details

Eq Analysis Source # |
Instance details Defined in GI.Pango.Structs.Analysis Methods (==) :: Analysis -> Analysis -> Bool # (/=) :: Analysis -> Analysis -> Bool #
CallocPtr Analysis Source # |
Instance details Defined in GI.Pango.Structs.Analysis Methods boxedPtrCalloc :: IO (Ptr Analysis) Source #
BoxedPtr Analysis Source # |
Instance details Defined in GI.Pango.Structs.Analysis Methods boxedPtrCopy :: Analysis -> IO Analysis Source # boxedPtrFree :: Analysis -> IO () Source #
ManagedPtrNewtype Analysis Source # |
Instance details Defined in GI.Pango.Structs.Analysis Methods toManagedPtr :: Analysis -> ManagedPtr Analysis Source #
tag ~ 'AttrSet => Constructible Analysis tag Source # |
Instance details Defined in GI.Pango.Structs.Analysis Methods new :: MonadIO m => (ManagedPtr Analysis -> Analysis) -> [AttrOp Analysis tag] -> m Analysis Source #

newZeroAnalysis :: MonadIO m => m Analysis Source #

Construct a `Analysis` struct initialized to zero.

# Methods

## Overloaded methods

# Properties

## extraAttrs

extra attributes for this segment.

clearAnalysisExtraAttrs :: MonadIO m => Analysis -> m () Source #

Set the value of the “`extra_attrs`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #extraAttrs

getAnalysisExtraAttrs :: MonadIO m => Analysis -> m [Ptr ()] Source #

Get the value of the “`extra_attrs`” field. When overloading is enabled, this is equivalent to

    get analysis #extraAttrs

setAnalysisExtraAttrs :: MonadIO m => Analysis -> Ptr (GSList (Ptr ())) -> m () Source #

Set the value of the “`extra_attrs`” field. When overloading is enabled, this is equivalent to

    set analysis [ #extraAttrs := value ]

## flags

boolean flags for this segment (Since: 1.16).

getAnalysisFlags :: MonadIO m => Analysis -> m Word8 Source #

Get the value of the “`flags`” field. When overloading is enabled, this is equivalent to

    get analysis #flags

setAnalysisFlags :: MonadIO m => Analysis -> Word8 -> m () Source #

Set the value of the “`flags`” field. When overloading is enabled, this is equivalent to

    set analysis [ #flags := value ]

## font

the font for this segment.

clearAnalysisFont :: MonadIO m => Analysis -> m () Source #

Set the value of the “`font`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #font

getAnalysisFont :: MonadIO m => Analysis -> m (Maybe Font) Source #

Get the value of the “`font`” field. When overloading is enabled, this is equivalent to

    get analysis #font

setAnalysisFont :: MonadIO m => Analysis -> Ptr Font -> m () Source #

Set the value of the “`font`” field. When overloading is enabled, this is equivalent to

    set analysis [ #font := value ]

## gravity

the glyph orientation for this segment (A `Gravity`).

getAnalysisGravity :: MonadIO m => Analysis -> m Word8 Source #

Get the value of the “`gravity`” field. When overloading is enabled, this is equivalent to

    get analysis #gravity

setAnalysisGravity :: MonadIO m => Analysis -> Word8 -> m () Source #

Set the value of the “`gravity`” field. When overloading is enabled, this is equivalent to

    set analysis [ #gravity := value ]

## langEngine

unused

clearAnalysisLangEngine :: MonadIO m => Analysis -> m () Source #

Set the value of the “`lang_engine`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #langEngine

getAnalysisLangEngine :: MonadIO m => Analysis -> m (Maybe EngineLang) Source #

Get the value of the “`lang_engine`” field. When overloading is enabled, this is equivalent to

    get analysis #langEngine

setAnalysisLangEngine :: MonadIO m => Analysis -> Ptr EngineLang -> m () Source #

Set the value of the “`lang_engine`” field. When overloading is enabled, this is equivalent to

    set analysis [ #langEngine := value ]

## language

the detected language for this segment.

clearAnalysisLanguage :: MonadIO m => Analysis -> m () Source #

Set the value of the “`language`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #language

getAnalysisLanguage :: MonadIO m => Analysis -> m (Maybe Language) Source #

Get the value of the “`language`” field. When overloading is enabled, this is equivalent to

    get analysis #language

setAnalysisLanguage :: MonadIO m => Analysis -> Ptr Language -> m () Source #

Set the value of the “`language`” field. When overloading is enabled, this is equivalent to

    set analysis [ #language := value ]

## level

the bidirectional level for this segment.

getAnalysisLevel :: MonadIO m => Analysis -> m Word8 Source #

Get the value of the “`level`” field. When overloading is enabled, this is equivalent to

    get analysis #level

setAnalysisLevel :: MonadIO m => Analysis -> Word8 -> m () Source #

Set the value of the “`level`” field. When overloading is enabled, this is equivalent to

    set analysis [ #level := value ]

## script

the detected script for this segment (A `Script`) (Since: 1.18).

getAnalysisScript :: MonadIO m => Analysis -> m Word8 Source #

Get the value of the “`script`” field. When overloading is enabled, this is equivalent to

    get analysis #script

setAnalysisScript :: MonadIO m => Analysis -> Word8 -> m () Source #

Set the value of the “`script`” field. When overloading is enabled, this is equivalent to

    set analysis [ #script := value ]

## shapeEngine

unused

clearAnalysisShapeEngine :: MonadIO m => Analysis -> m () Source #

Set the value of the “`shape_engine`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #shapeEngine

getAnalysisShapeEngine :: MonadIO m => Analysis -> m (Maybe EngineShape) Source #

Get the value of the “`shape_engine`” field. When overloading is enabled, this is equivalent to

    get analysis #shapeEngine

setAnalysisShapeEngine :: MonadIO m => Analysis -> Ptr EngineShape -> m () Source #

Set the value of the “`shape_engine`” field. When overloading is enabled, this is equivalent to

    set analysis [ #shapeEngine := value ]