GI.Poppler.Structs.LayersIter

No description available in the introspection data.

Exported types

newtype LayersIter

Memory-managed wrapper type.

Constructors

LayersIter (ManagedPtr LayersIter)

Instances

Eq LayersIter

Defined in GI.Poppler.Structs.LayersIter

Methods

(==) :: LayersIter -> LayersIter -> Bool

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

GBoxed LayersIter

Defined in GI.Poppler.Structs.LayersIter

ManagedPtrNewtype LayersIter

Defined in GI.Poppler.Structs.LayersIter

Methods

toManagedPtr :: LayersIter -> ManagedPtr LayersIter

TypedObject LayersIter

Defined in GI.Poppler.Structs.LayersIter

Methods

glibType :: IO GType

HasParentTypes LayersIter

Defined in GI.Poppler.Structs.LayersIter

IsGValue (Maybe LayersIter)

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

Defined in GI.Poppler.Structs.LayersIter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes LayersIter

Defined in GI.Poppler.Structs.LayersIter

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

Methods

Click to display all available methods, including inherited ones

Methods

copy, free, next.

Getters

getChild, getLayer, getTitle.

Setters

None.

copy

layersIterCopy

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

iter: a LayersIter

-> m LayersIter

Returns: a new LayersIter

Since 0.12

Creates a new LayersIter as a copy of iter. This must be freed with layersIterFree.

free

layersIterFree

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

iter: a LayersIter

-> m ()

Frees iter.

Since: 0.12

getChild

layersIterGetChild

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

parent: a LayersIter

-> m LayersIter

Returns: a new LayersIter, or Nothing

Returns a newly created child of parent, or Nothing if the iter has no child. See layersIterNew for more information on this function.

Since: 0.12

getLayer

layersIterGetLayer

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

iter: a LayersIter

-> m Layer

Returns: a new Layer, or Nothing if there isn't any layer associated with iter

Returns the Layer associated with iter.

Since: 0.12

getTitle

layersIterGetTitle

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

iter: a LayersIter

-> m Text

Returns: a new string containing the iter's title or Nothing if iter doesn't have a title. The returned string should be freed with free when no longer needed.

Returns the title associated with iter. It must be freed with free.

Since: 0.12

new

layersIterNew

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

document: a Document

-> m LayersIter

No description available in the introspection data.

Since: 0.12

next

layersIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> LayersIter

iter: a LayersIter

-> m Bool

Returns: True, if iter was set to the next action

Sets iter to point to the next action at the current level, if valid. See layersIterNew for more information.

Since: 0.12