GI.Poppler.Structs.TextAttributes

A TextAttributes is used to describe text attributes of a range of text

Since: 0.18

Exported types

newtype TextAttributes

Memory-managed wrapper type.

Constructors

TextAttributes (ManagedPtr TextAttributes)

Instances

Eq TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

Methods

(==) :: TextAttributes -> TextAttributes -> Bool

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

GBoxed TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

ManagedPtrNewtype TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

Methods

toManagedPtr :: TextAttributes -> ManagedPtr TextAttributes

TypedObject TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

Methods

glibType :: IO GType

HasParentTypes TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

tag ~ 'AttrSet => Constructible TextAttributes tag

Defined in GI.Poppler.Structs.TextAttributes

Methods

new :: MonadIO m => (ManagedPtr TextAttributes -> TextAttributes) -> [AttrOp TextAttributes tag] -> m TextAttributes

IsGValue (Maybe TextAttributes)

Convert TextAttributes to and from GValue. See toGValue and fromGValue.

Defined in GI.Poppler.Structs.TextAttributes

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TextAttributes -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TextAttributes)

type ParentTypes TextAttributes

Defined in GI.Poppler.Structs.TextAttributes

type ParentTypes TextAttributes = '[] :: [Type]

newZeroTextAttributes :: MonadIO m => m TextAttributes

Construct a TextAttributes struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

copy, free.

Getters

None.

Setters

None.

copy

textAttributesCopy

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

textAttrs: a TextAttributes to copy

-> m TextAttributes

Returns: a new allocated copy of textAttrs

Creates a copy of textAttrs

Since: 0.18

free

textAttributesFree

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

textAttrs: a TextAttributes

-> m ()

Frees the given TextAttributes

Since: 0.18

new

textAttributesNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextAttributes

Returns: a new TextAttributes, use textAttributesFree to free it

Creates a new TextAttributes

Since: 0.18

Properties

color

a Color, the foreground color

getTextAttributesColor :: MonadIO m => TextAttributes -> m Color

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

get textAttributes #color

endIndex

end position this text attributes apply

getTextAttributesEndIndex :: MonadIO m => TextAttributes -> m Int32

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

get textAttributes #endIndex

setTextAttributesEndIndex :: MonadIO m => TextAttributes -> Int32 -> m ()

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

set textAttributes [ #endIndex := value ]

fontName

font name

clearTextAttributesFontName :: MonadIO m => TextAttributes -> m ()

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

clear #fontName

getTextAttributesFontName :: MonadIO m => TextAttributes -> m (Maybe Text)

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

get textAttributes #fontName

setTextAttributesFontName :: MonadIO m => TextAttributes -> CString -> m ()

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

set textAttributes [ #fontName := value ]

fontSize

font size

getTextAttributesFontSize :: MonadIO m => TextAttributes -> m Double

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

get textAttributes #fontSize

setTextAttributesFontSize :: MonadIO m => TextAttributes -> Double -> m ()

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

set textAttributes [ #fontSize := value ]

isUnderlined

if text is underlined

getTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> m Bool

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

get textAttributes #isUnderlined

setTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> Bool -> m ()

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

set textAttributes [ #isUnderlined := value ]

startIndex

start position this text attributes apply

getTextAttributesStartIndex :: MonadIO m => TextAttributes -> m Int32

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

get textAttributes #startIndex

setTextAttributesStartIndex :: MonadIO m => TextAttributes -> Int32 -> m ()

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

set textAttributes [ #startIndex := value ]