{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- /No description available in the introspection data./

#if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__))
#define ENABLE_OVERLOADING
#endif

module GI.Poppler.Structs.LayersIter
    ( 

-- * Exported types
    LayersIter(..)                          ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [copy]("GI.Poppler.Structs.LayersIter#g:method:copy"), [free]("GI.Poppler.Structs.LayersIter#g:method:free"), [next]("GI.Poppler.Structs.LayersIter#g:method:next").
-- 
-- ==== Getters
-- [getChild]("GI.Poppler.Structs.LayersIter#g:method:getChild"), [getLayer]("GI.Poppler.Structs.LayersIter#g:method:getLayer"), [getTitle]("GI.Poppler.Structs.LayersIter#g:method:getTitle").
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveLayersIterMethod                 ,
#endif

-- ** copy #method:copy#

#if defined(ENABLE_OVERLOADING)
    LayersIterCopyMethodInfo                ,
#endif
    layersIterCopy                          ,


-- ** free #method:free#

#if defined(ENABLE_OVERLOADING)
    LayersIterFreeMethodInfo                ,
#endif
    layersIterFree                          ,


-- ** getChild #method:getChild#

#if defined(ENABLE_OVERLOADING)
    LayersIterGetChildMethodInfo            ,
#endif
    layersIterGetChild                      ,


-- ** getLayer #method:getLayer#

#if defined(ENABLE_OVERLOADING)
    LayersIterGetLayerMethodInfo            ,
#endif
    layersIterGetLayer                      ,


-- ** getTitle #method:getTitle#

#if defined(ENABLE_OVERLOADING)
    LayersIterGetTitleMethodInfo            ,
#endif
    layersIterGetTitle                      ,


-- ** new #method:new#

    layersIterNew                           ,


-- ** next #method:next#

#if defined(ENABLE_OVERLOADING)
    LayersIterNextMethodInfo                ,
#endif
    layersIterNext                          ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.BasicTypes as B.Types
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GArray as B.GArray
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GHashTable as B.GHT
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.GI.Base.Signals as B.Signals
import qualified Control.Monad.IO.Class as MIO
import qualified Data.Coerce as Coerce
import qualified Data.Text as T
import qualified Data.Kind as DK
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL
import qualified GHC.Records as R
import qualified Data.Word as DW
import qualified Data.Int as DI
import qualified System.Posix.Types as SPT
import qualified Foreign.C.Types as FCT

-- Workaround for https://gitlab.haskell.org/ghc/ghc/-/issues/23392
#if MIN_VERSION_base(4,18,0)
import qualified GI.Cairo.Structs.Context as Cairo.Context
import qualified GI.Cairo.Structs.Region as Cairo.Region
import qualified GI.Cairo.Structs.Surface as Cairo.Surface
import qualified GI.GLib.Structs.Bytes as GLib.Bytes
import qualified GI.GLib.Structs.DateTime as GLib.DateTime
import qualified GI.GLib.Structs.String as GLib.String
import qualified GI.GLib.Structs.Tree as GLib.Tree
import qualified GI.GObject.Objects.Object as GObject.Object
import qualified GI.Gio.Callbacks as Gio.Callbacks
import qualified GI.Gio.Interfaces.AsyncResult as Gio.AsyncResult
import qualified GI.Gio.Interfaces.File as Gio.File
import qualified GI.Gio.Objects.Cancellable as Gio.Cancellable
import qualified GI.Gio.Objects.InputStream as Gio.InputStream
import qualified GI.Poppler.Callbacks as Poppler.Callbacks
import {-# SOURCE #-} qualified GI.Poppler.Enums as Poppler.Enums
import {-# SOURCE #-} qualified GI.Poppler.Flags as Poppler.Flags
import {-# SOURCE #-} qualified GI.Poppler.Objects.Annot as Poppler.Annot
import {-# SOURCE #-} qualified GI.Poppler.Objects.Attachment as Poppler.Attachment
import {-# SOURCE #-} qualified GI.Poppler.Objects.Document as Poppler.Document
import {-# SOURCE #-} qualified GI.Poppler.Objects.FormField as Poppler.FormField
import {-# SOURCE #-} qualified GI.Poppler.Objects.Layer as Poppler.Layer
import {-# SOURCE #-} qualified GI.Poppler.Objects.Media as Poppler.Media
import {-# SOURCE #-} qualified GI.Poppler.Objects.Movie as Poppler.Movie
import {-# SOURCE #-} qualified GI.Poppler.Objects.PSFile as Poppler.PSFile
import {-# SOURCE #-} qualified GI.Poppler.Objects.Page as Poppler.Page
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionAny as Poppler.ActionAny
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionGotoDest as Poppler.ActionGotoDest
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionGotoRemote as Poppler.ActionGotoRemote
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionJavascript as Poppler.ActionJavascript
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionLaunch as Poppler.ActionLaunch
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionLayer as Poppler.ActionLayer
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionMovie as Poppler.ActionMovie
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionNamed as Poppler.ActionNamed
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionOCGState as Poppler.ActionOCGState
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionRendition as Poppler.ActionRendition
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionResetForm as Poppler.ActionResetForm
import {-# SOURCE #-} qualified GI.Poppler.Structs.ActionUri as Poppler.ActionUri
import {-# SOURCE #-} qualified GI.Poppler.Structs.AnnotMapping as Poppler.AnnotMapping
import {-# SOURCE #-} qualified GI.Poppler.Structs.CertificateInfo as Poppler.CertificateInfo
import {-# SOURCE #-} qualified GI.Poppler.Structs.Color as Poppler.Color
import {-# SOURCE #-} qualified GI.Poppler.Structs.Dest as Poppler.Dest
import {-# SOURCE #-} qualified GI.Poppler.Structs.FormFieldMapping as Poppler.FormFieldMapping
import {-# SOURCE #-} qualified GI.Poppler.Structs.ImageMapping as Poppler.ImageMapping
import {-# SOURCE #-} qualified GI.Poppler.Structs.LinkMapping as Poppler.LinkMapping
import {-# SOURCE #-} qualified GI.Poppler.Structs.PageRange as Poppler.PageRange
import {-# SOURCE #-} qualified GI.Poppler.Structs.PageTransition as Poppler.PageTransition
import {-# SOURCE #-} qualified GI.Poppler.Structs.Rectangle as Poppler.Rectangle
import {-# SOURCE #-} qualified GI.Poppler.Structs.SignatureInfo as Poppler.SignatureInfo
import {-# SOURCE #-} qualified GI.Poppler.Structs.SigningData as Poppler.SigningData
import {-# SOURCE #-} qualified GI.Poppler.Structs.TextAttributes as Poppler.TextAttributes
import {-# SOURCE #-} qualified GI.Poppler.Unions.Action as Poppler.Action

#else
import {-# SOURCE #-} qualified GI.Poppler.Objects.Document as Poppler.Document
import {-# SOURCE #-} qualified GI.Poppler.Objects.Layer as Poppler.Layer

#endif

-- | Memory-managed wrapper type.
newtype LayersIter = LayersIter (SP.ManagedPtr LayersIter)
    deriving (LayersIter -> LayersIter -> Bool
(LayersIter -> LayersIter -> Bool)
-> (LayersIter -> LayersIter -> Bool) -> Eq LayersIter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: LayersIter -> LayersIter -> Bool
== :: LayersIter -> LayersIter -> Bool
$c/= :: LayersIter -> LayersIter -> Bool
/= :: LayersIter -> LayersIter -> Bool
Eq)

instance SP.ManagedPtrNewtype LayersIter where
    toManagedPtr :: LayersIter -> ManagedPtr LayersIter
toManagedPtr (LayersIter ManagedPtr LayersIter
p) = ManagedPtr LayersIter
p

foreign import ccall "poppler_layers_iter_get_type" c_poppler_layers_iter_get_type :: 
    IO GType

type instance O.ParentTypes LayersIter = '[]
instance O.HasParentTypes LayersIter

instance B.Types.TypedObject LayersIter where
    glibType :: IO GType
glibType = IO GType
c_poppler_layers_iter_get_type

instance B.Types.GBoxed LayersIter

-- | Convert 'LayersIter' to and from 'Data.GI.Base.GValue.GValue'. See 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue (Maybe LayersIter) where
    gvalueGType_ :: IO GType
gvalueGType_ = IO GType
c_poppler_layers_iter_get_type
    gvalueSet_ :: Ptr GValue -> Maybe LayersIter -> IO ()
gvalueSet_ Ptr GValue
gv Maybe LayersIter
P.Nothing = Ptr GValue -> Ptr LayersIter -> IO ()
forall a. Ptr GValue -> Ptr a -> IO ()
B.GValue.set_boxed Ptr GValue
gv (Ptr LayersIter
forall a. Ptr a
FP.nullPtr :: FP.Ptr LayersIter)
    gvalueSet_ Ptr GValue
gv (P.Just LayersIter
obj) = LayersIter -> (Ptr LayersIter -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr LayersIter
obj (Ptr GValue -> Ptr LayersIter -> IO ()
forall a. Ptr GValue -> Ptr a -> IO ()
B.GValue.set_boxed Ptr GValue
gv)
    gvalueGet_ :: Ptr GValue -> IO (Maybe LayersIter)
gvalueGet_ Ptr GValue
gv = do
        Ptr LayersIter
ptr <- Ptr GValue -> IO (Ptr LayersIter)
forall b. Ptr GValue -> IO (Ptr b)
B.GValue.get_boxed Ptr GValue
gv :: IO (Ptr LayersIter)
        if Ptr LayersIter
ptr Ptr LayersIter -> Ptr LayersIter -> Bool
forall a. Eq a => a -> a -> Bool
/= Ptr LayersIter
forall a. Ptr a
FP.nullPtr
        then LayersIter -> Maybe LayersIter
forall a. a -> Maybe a
P.Just (LayersIter -> Maybe LayersIter)
-> IO LayersIter -> IO (Maybe LayersIter)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (ManagedPtr LayersIter -> LayersIter)
-> Ptr LayersIter -> IO LayersIter
forall a.
(HasCallStack, GBoxed a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
B.ManagedPtr.newBoxed ManagedPtr LayersIter -> LayersIter
LayersIter Ptr LayersIter
ptr
        else Maybe LayersIter -> IO (Maybe LayersIter)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe LayersIter
forall a. Maybe a
P.Nothing
        
    


#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList LayersIter
type instance O.AttributeList LayersIter = LayersIterAttributeList
type LayersIterAttributeList = ('[ ] :: [(Symbol, DK.Type)])
#endif

-- method LayersIter::new
-- method type : Constructor
-- Args: [ Arg
--           { argCName = "document"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "Document" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerDocument" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface Name { namespace = "Poppler" , name = "LayersIter" })
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_new" poppler_layers_iter_new :: 
    Ptr Poppler.Document.Document ->        -- document : TInterface (Name {namespace = "Poppler", name = "Document"})
    IO (Ptr LayersIter)

-- | /No description available in the introspection data./
-- 
-- /Since: 0.12/
layersIterNew ::
    (B.CallStack.HasCallStack, MonadIO m, Poppler.Document.IsDocument a) =>
    a
    -- ^ /@document@/: a t'GI.Poppler.Objects.Document.Document'
    -> m LayersIter
layersIterNew :: forall (m :: * -> *) a.
(HasCallStack, MonadIO m, IsDocument a) =>
a -> m LayersIter
layersIterNew a
document = IO LayersIter -> m LayersIter
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO LayersIter -> m LayersIter) -> IO LayersIter -> m LayersIter
forall a b. (a -> b) -> a -> b
$ do
    Ptr Document
document' <- a -> IO (Ptr Document)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
document
    Ptr LayersIter
result <- Ptr Document -> IO (Ptr LayersIter)
poppler_layers_iter_new Ptr Document
document'
    Text -> Ptr LayersIter -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"layersIterNew" Ptr LayersIter
result
    LayersIter
result' <- ((ManagedPtr LayersIter -> LayersIter)
-> Ptr LayersIter -> IO LayersIter
forall a.
(HasCallStack, GBoxed a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapBoxed ManagedPtr LayersIter -> LayersIter
LayersIter) Ptr LayersIter
result
    a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
document
    LayersIter -> IO LayersIter
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return LayersIter
result'

#if defined(ENABLE_OVERLOADING)
#endif

-- method LayersIter::copy
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "iter"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface Name { namespace = "Poppler" , name = "LayersIter" })
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_copy" poppler_layers_iter_copy :: 
    Ptr LayersIter ->                       -- iter : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO (Ptr LayersIter)

-- | Creates a new t'GI.Poppler.Structs.LayersIter.LayersIter' as a copy of /@iter@/.  This must be freed with
-- 'GI.Poppler.Structs.LayersIter.layersIterFree'.
layersIterCopy ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@iter@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m LayersIter
    -- ^ __Returns:__ a new t'GI.Poppler.Structs.LayersIter.LayersIter'
    -- 
    -- Since 0.12
layersIterCopy :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m LayersIter
layersIterCopy LayersIter
iter = IO LayersIter -> m LayersIter
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO LayersIter -> m LayersIter) -> IO LayersIter -> m LayersIter
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
iter' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
iter
    Ptr LayersIter
result <- Ptr LayersIter -> IO (Ptr LayersIter)
poppler_layers_iter_copy Ptr LayersIter
iter'
    Text -> Ptr LayersIter -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"layersIterCopy" Ptr LayersIter
result
    LayersIter
result' <- ((ManagedPtr LayersIter -> LayersIter)
-> Ptr LayersIter -> IO LayersIter
forall a.
(HasCallStack, GBoxed a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapBoxed ManagedPtr LayersIter -> LayersIter
LayersIter) Ptr LayersIter
result
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
iter
    LayersIter -> IO LayersIter
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return LayersIter
result'

#if defined(ENABLE_OVERLOADING)
data LayersIterCopyMethodInfo
instance (signature ~ (m LayersIter), MonadIO m) => O.OverloadedMethod LayersIterCopyMethodInfo LayersIter signature where
    overloadedMethod = layersIterCopy

instance O.OverloadedMethodInfo LayersIterCopyMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterCopy",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterCopy"
        })


#endif

-- method LayersIter::free
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "iter"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_free" poppler_layers_iter_free :: 
    Ptr LayersIter ->                       -- iter : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO ()

-- | Frees /@iter@/.
-- 
-- /Since: 0.12/
layersIterFree ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@iter@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m ()
layersIterFree :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m ()
layersIterFree LayersIter
iter = IO () -> m ()
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO () -> m ()) -> IO () -> m ()
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
iter' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
iter
    Ptr LayersIter -> IO ()
poppler_layers_iter_free Ptr LayersIter
iter'
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
iter
    () -> IO ()
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ()

#if defined(ENABLE_OVERLOADING)
data LayersIterFreeMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.OverloadedMethod LayersIterFreeMethodInfo LayersIter signature where
    overloadedMethod = layersIterFree

instance O.OverloadedMethodInfo LayersIterFreeMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterFree",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterFree"
        })


#endif

-- method LayersIter::get_child
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "parent"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface Name { namespace = "Poppler" , name = "LayersIter" })
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_get_child" poppler_layers_iter_get_child :: 
    Ptr LayersIter ->                       -- parent : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO (Ptr LayersIter)

-- | Returns a newly created child of /@parent@/, or 'P.Nothing' if the iter has no child.
-- See 'GI.Poppler.Structs.LayersIter.layersIterNew' for more information on this function.
-- 
-- /Since: 0.12/
layersIterGetChild ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@parent@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m LayersIter
    -- ^ __Returns:__ a new t'GI.Poppler.Structs.LayersIter.LayersIter', or 'P.Nothing'
layersIterGetChild :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m LayersIter
layersIterGetChild LayersIter
parent = IO LayersIter -> m LayersIter
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO LayersIter -> m LayersIter) -> IO LayersIter -> m LayersIter
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
parent' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
parent
    Ptr LayersIter
result <- Ptr LayersIter -> IO (Ptr LayersIter)
poppler_layers_iter_get_child Ptr LayersIter
parent'
    Text -> Ptr LayersIter -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"layersIterGetChild" Ptr LayersIter
result
    LayersIter
result' <- ((ManagedPtr LayersIter -> LayersIter)
-> Ptr LayersIter -> IO LayersIter
forall a.
(HasCallStack, GBoxed a) =>
(ManagedPtr a -> a) -> Ptr a -> IO a
wrapBoxed ManagedPtr LayersIter -> LayersIter
LayersIter) Ptr LayersIter
result
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
parent
    LayersIter -> IO LayersIter
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return LayersIter
result'

#if defined(ENABLE_OVERLOADING)
data LayersIterGetChildMethodInfo
instance (signature ~ (m LayersIter), MonadIO m) => O.OverloadedMethod LayersIterGetChildMethodInfo LayersIter signature where
    overloadedMethod = layersIterGetChild

instance O.OverloadedMethodInfo LayersIterGetChildMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterGetChild",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterGetChild"
        })


#endif

-- method LayersIter::get_layer
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "iter"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "Poppler" , name = "Layer" })
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_get_layer" poppler_layers_iter_get_layer :: 
    Ptr LayersIter ->                       -- iter : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO (Ptr Poppler.Layer.Layer)

-- | Returns the t'GI.Poppler.Objects.Layer.Layer' associated with /@iter@/.
-- 
-- /Since: 0.12/
layersIterGetLayer ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@iter@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m Poppler.Layer.Layer
    -- ^ __Returns:__ a new t'GI.Poppler.Objects.Layer.Layer', or 'P.Nothing' if
    -- there isn\'t any layer associated with /@iter@/
layersIterGetLayer :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m Layer
layersIterGetLayer LayersIter
iter = IO Layer -> m Layer
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Layer -> m Layer) -> IO Layer -> m Layer
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
iter' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
iter
    Ptr Layer
result <- Ptr LayersIter -> IO (Ptr Layer)
poppler_layers_iter_get_layer Ptr LayersIter
iter'
    Text -> Ptr Layer -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"layersIterGetLayer" Ptr Layer
result
    Layer
result' <- ((ManagedPtr Layer -> Layer) -> Ptr Layer -> IO Layer
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
wrapObject ManagedPtr Layer -> Layer
Poppler.Layer.Layer) Ptr Layer
result
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
iter
    Layer -> IO Layer
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Layer
result'

#if defined(ENABLE_OVERLOADING)
data LayersIterGetLayerMethodInfo
instance (signature ~ (m Poppler.Layer.Layer), MonadIO m) => O.OverloadedMethod LayersIterGetLayerMethodInfo LayersIter signature where
    overloadedMethod = layersIterGetLayer

instance O.OverloadedMethodInfo LayersIterGetLayerMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterGetLayer",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterGetLayer"
        })


#endif

-- method LayersIter::get_title
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "iter"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_get_title" poppler_layers_iter_get_title :: 
    Ptr LayersIter ->                       -- iter : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO CString

-- | Returns the title associated with /@iter@/.  It must be freed with
-- 'GI.GLib.Functions.free'.
-- 
-- /Since: 0.12/
layersIterGetTitle ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@iter@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m T.Text
    -- ^ __Returns:__ a new string containing the /@iter@/\'s title or 'P.Nothing' if /@iter@/ doesn\'t have a title.
    -- The returned string should be freed with 'GI.GLib.Functions.free' when no longer needed.
layersIterGetTitle :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m Text
layersIterGetTitle LayersIter
iter = IO Text -> m Text
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Text -> m Text) -> IO Text -> m Text
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
iter' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
iter
    CString
result <- Ptr LayersIter -> IO CString
poppler_layers_iter_get_title Ptr LayersIter
iter'
    Text -> CString -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"layersIterGetTitle" CString
result
    Text
result' <- HasCallStack => CString -> IO Text
CString -> IO Text
cstringToText CString
result
    CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
result
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
iter
    Text -> IO Text
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Text
result'

#if defined(ENABLE_OVERLOADING)
data LayersIterGetTitleMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.OverloadedMethod LayersIterGetTitleMethodInfo LayersIter signature where
    overloadedMethod = layersIterGetTitle

instance O.OverloadedMethodInfo LayersIterGetTitleMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterGetTitle",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterGetTitle"
        })


#endif

-- method LayersIter::next
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "iter"
--           , argType =
--               TInterface Name { namespace = "Poppler" , name = "LayersIter" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #PopplerLayersIter"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , argCallbackUserData = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False

foreign import ccall "poppler_layers_iter_next" poppler_layers_iter_next :: 
    Ptr LayersIter ->                       -- iter : TInterface (Name {namespace = "Poppler", name = "LayersIter"})
    IO CInt

-- | Sets /@iter@/ to point to the next action at the current level, if valid.  See
-- 'GI.Poppler.Structs.LayersIter.layersIterNew' for more information.
-- 
-- /Since: 0.12/
layersIterNext ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    LayersIter
    -- ^ /@iter@/: a t'GI.Poppler.Structs.LayersIter.LayersIter'
    -> m Bool
    -- ^ __Returns:__ 'P.True', if /@iter@/ was set to the next action
layersIterNext :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
LayersIter -> m Bool
layersIterNext LayersIter
iter = IO Bool -> m Bool
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Bool -> m Bool) -> IO Bool -> m Bool
forall a b. (a -> b) -> a -> b
$ do
    Ptr LayersIter
iter' <- LayersIter -> IO (Ptr LayersIter)
forall a. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr a)
unsafeManagedPtrGetPtr LayersIter
iter
    CInt
result <- Ptr LayersIter -> IO CInt
poppler_layers_iter_next Ptr LayersIter
iter'
    let result' :: Bool
result' = (CInt -> CInt -> Bool
forall a. Eq a => a -> a -> Bool
/= CInt
0) CInt
result
    LayersIter -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr LayersIter
iter
    Bool -> IO Bool
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Bool
result'

#if defined(ENABLE_OVERLOADING)
data LayersIterNextMethodInfo
instance (signature ~ (m Bool), MonadIO m) => O.OverloadedMethod LayersIterNextMethodInfo LayersIter signature where
    overloadedMethod = layersIterNext

instance O.OverloadedMethodInfo LayersIterNextMethodInfo LayersIter where
    overloadedMethodInfo = P.Just (O.ResolvedSymbolInfo {
        O.resolvedSymbolName = "GI.Poppler.Structs.LayersIter.layersIterNext",
        O.resolvedSymbolURL = "https://hackage.haskell.org/package/gi-poppler-0.18.30/docs/GI-Poppler-Structs-LayersIter.html#v:layersIterNext"
        })


#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveLayersIterMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveLayersIterMethod "copy" o = LayersIterCopyMethodInfo
    ResolveLayersIterMethod "free" o = LayersIterFreeMethodInfo
    ResolveLayersIterMethod "next" o = LayersIterNextMethodInfo
    ResolveLayersIterMethod "getChild" o = LayersIterGetChildMethodInfo
    ResolveLayersIterMethod "getLayer" o = LayersIterGetLayerMethodInfo
    ResolveLayersIterMethod "getTitle" o = LayersIterGetTitleMethodInfo
    ResolveLayersIterMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveLayersIterMethod t LayersIter, O.OverloadedMethod info LayersIter p) => OL.IsLabel t (LayersIter -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod @info
#else
    fromLabel _ = O.overloadedMethod @info
#endif

#if MIN_VERSION_base(4,13,0)
instance (info ~ ResolveLayersIterMethod t LayersIter, O.OverloadedMethod info LayersIter p, R.HasField t LayersIter p) => R.HasField t LayersIter p where
    getField = O.overloadedMethod @info

#endif

instance (info ~ ResolveLayersIterMethod t LayersIter, O.OverloadedMethodInfo info LayersIter) => OL.IsLabel t (O.MethodProxy info LayersIter) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.MethodProxy
#else
    fromLabel _ = O.MethodProxy
#endif

#endif