{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- AtkHyperlinkImpl allows AtkObjects to refer to their associated
-- AtkHyperlink instance, if one exists.  AtkHyperlinkImpl differs
-- from AtkHyperlink in that AtkHyperlinkImpl is an interface, whereas
-- AtkHyperlink is a object type.  The AtkHyperlinkImpl interface
-- allows a client to query an AtkObject for the availability of an
-- associated AtkHyperlink instance, and obtain that instance.  It is
-- thus particularly useful in cases where embedded content or inline
-- content within a text object is present, since the embedding text
-- object implements AtkHypertext and the inline\/embedded objects are
-- exposed as children which implement AtkHyperlinkImpl, in addition
-- to their being obtainable via AtkHypertext:getLink followed by
-- AtkHyperlink:getObject.
-- 
-- The AtkHyperlinkImpl interface should be supported by objects
-- exposed within the hierarchy as children of an AtkHypertext
-- container which correspond to \"links\" or embedded content within
-- the text.  HTML anchors are not, for instance, normally exposed
-- this way, but embedded images and components which appear inline in
-- the content of a text object are. The AtkHyperlinkIface interface
-- allows a means of determining which children are hyperlinks in this
-- sense of the word, and for obtaining their corresponding
-- AtkHyperlink object, from which the embedding range, URI, etc. can
-- be obtained.
-- 
-- To some extent this interface exists because, for historical
-- reasons, AtkHyperlink was defined as an object type, not an
-- interface.  Thus, in order to interact with AtkObjects via
-- AtkHyperlink semantics, a new interface was required.

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

module GI.Atk.Interfaces.HyperlinkImpl
    ( 

-- * Exported types
    HyperlinkImpl(..)                       ,
    IsHyperlinkImpl                         ,


 -- * Methods
-- ** Overloaded methods #method:Overloaded methods#

#if defined(ENABLE_OVERLOADING)
    ResolveHyperlinkImplMethod              ,
#endif


-- ** getHyperlink #method:getHyperlink#

#if defined(ENABLE_OVERLOADING)
    HyperlinkImplGetHyperlinkMethodInfo     ,
#endif
    hyperlinkImplGetHyperlink               ,




    ) 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.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
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.Text as T
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 {-# SOURCE #-} qualified GI.Atk.Objects.Hyperlink as Atk.Hyperlink

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

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

-- | Type class for types which implement `HyperlinkImpl`.
class (ManagedPtrNewtype o, O.IsDescendantOf HyperlinkImpl o) => IsHyperlinkImpl o
instance (ManagedPtrNewtype o, O.IsDescendantOf HyperlinkImpl o) => IsHyperlinkImpl o
-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance BoxedPtr HyperlinkImpl where
    boxedPtrCopy :: HyperlinkImpl -> IO HyperlinkImpl
boxedPtrCopy = HyperlinkImpl -> IO HyperlinkImpl
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: HyperlinkImpl -> IO ()
boxedPtrFree = \HyperlinkImpl
_x -> () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()


#if defined(ENABLE_OVERLOADING)
type family ResolveHyperlinkImplMethod (t :: Symbol) (o :: *) :: * where
    ResolveHyperlinkImplMethod "getHyperlink" o = HyperlinkImplGetHyperlinkMethodInfo
    ResolveHyperlinkImplMethod l o = O.MethodResolutionFailed l o

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

#endif

-- method HyperlinkImpl::get_hyperlink
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "impl"
--           , argType =
--               TInterface Name { namespace = "Atk" , name = "HyperlinkImpl" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText =
--                     Just "a #GObject instance that implements AtkHyperlinkImplIface"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "Atk" , name = "Hyperlink" })
-- throws : False
-- Skip return : False

foreign import ccall "atk_hyperlink_impl_get_hyperlink" atk_hyperlink_impl_get_hyperlink :: 
    Ptr HyperlinkImpl ->                    -- impl : TInterface (Name {namespace = "Atk", name = "HyperlinkImpl"})
    IO (Ptr Atk.Hyperlink.Hyperlink)

-- | Gets the hyperlink associated with this object.
-- 
-- /Since: 1.12/
hyperlinkImplGetHyperlink ::
    (B.CallStack.HasCallStack, MonadIO m, IsHyperlinkImpl a) =>
    a
    -- ^ /@impl@/: a t'GI.GObject.Objects.Object.Object' instance that implements AtkHyperlinkImplIface
    -> m Atk.Hyperlink.Hyperlink
    -- ^ __Returns:__ an AtkHyperlink object which points to this
    -- implementing AtkObject.
hyperlinkImplGetHyperlink :: a -> m Hyperlink
hyperlinkImplGetHyperlink a
impl = IO Hyperlink -> m Hyperlink
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO Hyperlink -> m Hyperlink) -> IO Hyperlink -> m Hyperlink
forall a b. (a -> b) -> a -> b
$ do
    Ptr HyperlinkImpl
impl' <- a -> IO (Ptr HyperlinkImpl)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
impl
    Ptr Hyperlink
result <- Ptr HyperlinkImpl -> IO (Ptr Hyperlink)
atk_hyperlink_impl_get_hyperlink Ptr HyperlinkImpl
impl'
    Text -> Ptr Hyperlink -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"hyperlinkImplGetHyperlink" Ptr Hyperlink
result
    Hyperlink
result' <- ((ManagedPtr Hyperlink -> Hyperlink)
-> Ptr Hyperlink -> IO Hyperlink
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
wrapObject ManagedPtr Hyperlink -> Hyperlink
Atk.Hyperlink.Hyperlink) Ptr Hyperlink
result
    a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
impl
    Hyperlink -> IO Hyperlink
forall (m :: * -> *) a. Monad m => a -> m a
return Hyperlink
result'

#if defined(ENABLE_OVERLOADING)
data HyperlinkImplGetHyperlinkMethodInfo
instance (signature ~ (m Atk.Hyperlink.Hyperlink), MonadIO m, IsHyperlinkImpl a) => O.MethodInfo HyperlinkImplGetHyperlinkMethodInfo a signature where
    overloadedMethod = hyperlinkImplGetHyperlink

#endif

#if defined(ENABLE_OVERLOADING)
type instance O.SignalList HyperlinkImpl = HyperlinkImplSignalList
type HyperlinkImplSignalList = ('[ ] :: [(Symbol, *)])

#endif