Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Poppler.Structs.LayersIter
Description
- newtype LayersIter = LayersIter (ManagedPtr LayersIter)
- noLayersIter :: Maybe LayersIter
- data LayersIterCopyMethodInfo
- layersIterCopy :: (HasCallStack, MonadIO m) => LayersIter -> m LayersIter
- data LayersIterFreeMethodInfo
- layersIterFree :: (HasCallStack, MonadIO m) => LayersIter -> m ()
- data LayersIterGetChildMethodInfo
- layersIterGetChild :: (HasCallStack, MonadIO m) => LayersIter -> m LayersIter
- data LayersIterGetLayerMethodInfo
- layersIterGetLayer :: (HasCallStack, MonadIO m) => LayersIter -> m Layer
- data LayersIterGetTitleMethodInfo
- layersIterGetTitle :: (HasCallStack, MonadIO m) => LayersIter -> m Text
- layersIterNew :: (HasCallStack, MonadIO m, IsDocument a) => a -> m LayersIter
- data LayersIterNextMethodInfo
- layersIterNext :: (HasCallStack, MonadIO m) => LayersIter -> m Bool
Exported types
newtype LayersIter Source #
Constructors
LayersIter (ManagedPtr LayersIter) |
Instances
Methods
copy
data LayersIterCopyMethodInfo Source #
Instances
((~) * signature (m LayersIter), MonadIO m) => MethodInfo * LayersIterCopyMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m LayersIter | Returns: a new Since 0.12 |
Creates a new LayersIter
as a copy of iter
. This must be freed with
layersIterFree
.
free
data LayersIterFreeMethodInfo Source #
Instances
((~) * signature (m ()), MonadIO m) => MethodInfo * LayersIterFreeMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m () |
Frees iter
.
Since: 0.12
getChild
data LayersIterGetChildMethodInfo Source #
Instances
((~) * signature (m LayersIter), MonadIO m) => MethodInfo * LayersIterGetChildMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m LayersIter | Returns: a new |
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
data LayersIterGetLayerMethodInfo Source #
Instances
((~) * signature (m Layer), MonadIO m) => MethodInfo * LayersIterGetLayerMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m Layer | Returns: a new |
Returns the Layer
associated with iter
.
Since: 0.12
getTitle
data LayersIterGetTitleMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m) => MethodInfo * LayersIterGetTitleMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m Text | Returns: a new string containing the |
Returns the title associated with iter
. It must be freed with
free
.
Since: 0.12
new
Arguments
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> m LayersIter |
No description available in the introspection data.
Since: 0.12
next
data LayersIterNextMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m) => MethodInfo * LayersIterNextMethodInfo LayersIter signature Source # | |
Arguments
:: (HasCallStack, MonadIO m) | |
=> LayersIter |
|
-> m Bool | Returns: |
Sets iter
to point to the next action at the current level, if valid. See
layersIterNew
for more information.
Since: 0.12