| 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.StructureElementIter
Description
No description available in the introspection data.
Synopsis
- newtype StructureElementIter = StructureElementIter (ManagedPtr StructureElementIter)
- structureElementIterCopy :: (HasCallStack, MonadIO m) => StructureElementIter -> m StructureElementIter
- structureElementIterFree :: (HasCallStack, MonadIO m) => StructureElementIter -> m ()
- structureElementIterGetChild :: (HasCallStack, MonadIO m) => StructureElementIter -> m StructureElementIter
- structureElementIterGetElement :: (HasCallStack, MonadIO m) => StructureElementIter -> m StructureElement
- structureElementIterNew :: (HasCallStack, MonadIO m, IsDocument a) => a -> m StructureElementIter
- structureElementIterNext :: (HasCallStack, MonadIO m) => StructureElementIter -> m Bool
Exported types
newtype StructureElementIter Source #
Memory-managed wrapper type.
Constructors
| StructureElementIter (ManagedPtr StructureElementIter) |
Instances
Methods
Click to display all available methods, including inherited ones
copy
structureElementIterCopy Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => StructureElementIter |
|
| -> m StructureElementIter | Returns: a new |
Creates a new StructureElementIter as a copy of iter. The
returned value must be freed with structureElementIterFree.
Since: 0.26
free
structureElementIterFree Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => StructureElementIter |
|
| -> m () |
Frees iter.
Since: 0.26
getChild
structureElementIterGetChild Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => StructureElementIter |
|
| -> m StructureElementIter | Returns: a new |
Returns a new iterator to the children elements of the
StructureElement associated with iter. The returned value must
be freed with structureElementIterFree.
Since: 0.26
getElement
structureElementIterGetElement Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => StructureElementIter |
|
| -> m StructureElement | Returns: a new |
Returns the StructureElementIter associated with iter.
Since: 0.26
new
structureElementIterNew Source #
Arguments
| :: (HasCallStack, MonadIO m, IsDocument a) | |
| => a |
|
| -> m StructureElementIter | Returns: a new |
Returns the root StructureElementIter for document, or Nothing. The
returned value must be freed with structureElementIterFree.
Documents may have an associated structure tree —mostly, Tagged-PDF
compliant documents— which can be used to obtain information about
the document structure and its contents. Each node in the tree contains
a StructureElement.
Here is a simple example that walks the whole tree:
<informalexample><programlisting> static void walk_structure (PopplerStructureElementIter *iter) { do { /<!-- -->* Get the element and do something with it *<!-- -->/ PopplerStructureElementIter *child = poppler_structure_element_iter_get_child (iter); if (child) walk_structure (child); poppler_structure_element_iter_free (child); } while (poppler_structure_element_iter_next (iter)); } ... { iter = poppler_structure_element_iter_new (document); walk_structure (iter); poppler_structure_element_iter_free (iter); } </programlisting></informalexample>
Since: 0.26
next
structureElementIterNext Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => StructureElementIter |
|
| -> m Bool | Returns: |
Sets iter to point to the next structure element at the current level
of the tree, if valid. See structureElementIterNew for more
information.
Since: 0.26