gi-poppler-0.18.30: Poppler bindings

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

GI.Poppler.Structs.TextSpan

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype TextSpan = TextSpan (ManagedPtr TextSpan)
textSpanCopy :: (HasCallStack, MonadIO m) => TextSpan -> m TextSpan
textSpanFree :: (HasCallStack, MonadIO m) => TextSpan -> m ()
textSpanGetColor :: (HasCallStack, MonadIO m) => TextSpan -> m Color
textSpanGetFontName :: (HasCallStack, MonadIO m) => TextSpan -> m Text
textSpanGetText :: (HasCallStack, MonadIO m) => TextSpan -> m Text
textSpanIsBoldFont :: (HasCallStack, MonadIO m) => TextSpan -> m Bool
textSpanIsFixedWidthFont :: (HasCallStack, MonadIO m) => TextSpan -> m Bool
textSpanIsSerifFont :: (HasCallStack, MonadIO m) => TextSpan -> m Bool

Exported types

newtype TextSpan Source #

Memory-managed wrapper type.

Constructors

TextSpan (ManagedPtr TextSpan)

Instances

Instances details

Eq TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan Methods (==) :: TextSpan -> TextSpan -> Bool # (/=) :: TextSpan -> TextSpan -> Bool #
GBoxed TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan
ManagedPtrNewtype TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan Methods toManagedPtr :: TextSpan -> ManagedPtr TextSpan
TypedObject TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan Methods glibType :: IO GType
HasParentTypes TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan
IsGValue (Maybe TextSpan) Source #	Convert `TextSpan` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Poppler.Structs.TextSpan Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe TextSpan -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe TextSpan)
type ParentTypes TextSpan Source #
Instance details Defined in GI.Poppler.Structs.TextSpan type ParentTypes TextSpan = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free, isBoldFont, isFixedWidthFont, isSerifFont.

Getters

getColor, getFontName, getText.

Setters

None.

copy

textSpanCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m TextSpan	Returns: A new `TextSpan`

Makes a copy of a text span.

Since: 0.26

free

textSpanFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: A `TextSpan`
-> m ()

Frees a text span.

Since: 0.26

getColor

textSpanGetColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Color

Obtains the color in which the text is to be rendered.

Since: 0.26

getFontName

textSpanGetFontName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Text	Returns: A string containing the font name, or `Nothing` if a font is not defined.

Obtains the name of the font in which the span is to be rendered.

Since: 0.26

getText

textSpanGetText Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Text	Returns: A string.

Obtains the text contained in the span.

Since: 0.26

isBoldFont

textSpanIsBoldFont Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Bool	Returns: Whether the span uses bold font.

Check whether a text span is meant to be rendered using a bold font.

Since: 0.26

isFixedWidthFont

textSpanIsFixedWidthFont Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Bool	Returns: Whether the span uses a fixed-width font.

Check wether a text span is meant to be rendered using a fixed-width font.

Since: 0.26

isSerifFont

textSpanIsSerifFont Source #

Arguments

:: (HasCallStack, MonadIO m)
=> TextSpan	`popplerTextSpan`: a `TextSpan`
-> m Bool	Returns: Whether the span uses a serif font.

Check whether a text span is meant to be rendered using a serif font.

Since: 0.26