{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- An event related to drag and drop operations.

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

module GI.Gdk.Objects.DNDEvent
    ( 

-- * Exported types
    DNDEvent(..)                            ,
    IsDNDEvent                              ,
    toDNDEvent                              ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [ref]("GI.Gdk.Objects.Event#g:method:ref"), [triggersContextMenu]("GI.Gdk.Objects.Event#g:method:triggersContextMenu"), [unref]("GI.Gdk.Objects.Event#g:method:unref").
-- 
-- ==== Getters
-- [getAxes]("GI.Gdk.Objects.Event#g:method:getAxes"), [getAxis]("GI.Gdk.Objects.Event#g:method:getAxis"), [getDevice]("GI.Gdk.Objects.Event#g:method:getDevice"), [getDeviceTool]("GI.Gdk.Objects.Event#g:method:getDeviceTool"), [getDisplay]("GI.Gdk.Objects.Event#g:method:getDisplay"), [getDrop]("GI.Gdk.Objects.DNDEvent#g:method:getDrop"), [getEventSequence]("GI.Gdk.Objects.Event#g:method:getEventSequence"), [getEventType]("GI.Gdk.Objects.Event#g:method:getEventType"), [getHistory]("GI.Gdk.Objects.Event#g:method:getHistory"), [getModifierState]("GI.Gdk.Objects.Event#g:method:getModifierState"), [getPointerEmulated]("GI.Gdk.Objects.Event#g:method:getPointerEmulated"), [getPosition]("GI.Gdk.Objects.Event#g:method:getPosition"), [getSeat]("GI.Gdk.Objects.Event#g:method:getSeat"), [getSurface]("GI.Gdk.Objects.Event#g:method:getSurface"), [getTime]("GI.Gdk.Objects.Event#g:method:getTime").
-- 
-- ==== Setters
-- /None/.

#if defined(ENABLE_OVERLOADING)
    ResolveDNDEventMethod                   ,
#endif

-- ** getDrop #method:getDrop#

#if defined(ENABLE_OVERLOADING)
    DNDEventGetDropMethodInfo               ,
#endif
    dNDEventGetDrop                         ,




    ) 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.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 qualified GHC.Records as R

import {-# SOURCE #-} qualified GI.Gdk.Objects.Drop as Gdk.Drop
import {-# SOURCE #-} qualified GI.Gdk.Objects.Event as Gdk.Event

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

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

foreign import ccall "gdk_dnd_event_get_type"
    c_gdk_dnd_event_get_type :: IO B.Types.GType

instance B.Types.TypedObject DNDEvent where
    glibType :: IO GType
glibType = IO GType
c_gdk_dnd_event_get_type

-- | Type class for types which can be safely cast to `DNDEvent`, for instance with `toDNDEvent`.
class (SP.BoxedPtr o, SP.TypedObject o, O.IsDescendantOf DNDEvent o) => IsDNDEvent o
instance (SP.BoxedPtr o, SP.TypedObject o, O.IsDescendantOf DNDEvent o) => IsDNDEvent o

instance O.HasParentTypes DNDEvent
type instance O.ParentTypes DNDEvent = '[Gdk.Event.Event]

-- | Cast to `DNDEvent`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toDNDEvent :: (MIO.MonadIO m, IsDNDEvent o) => o -> m DNDEvent
toDNDEvent :: forall (m :: * -> *) o.
(MonadIO m, IsDNDEvent o) =>
o -> m DNDEvent
toDNDEvent = IO DNDEvent -> m DNDEvent
forall (m :: * -> *) a. MonadIO m => IO a -> m a
MIO.liftIO (IO DNDEvent -> m DNDEvent)
-> (o -> IO DNDEvent) -> o -> m DNDEvent
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (ManagedPtr DNDEvent -> DNDEvent) -> o -> IO DNDEvent
forall o o'.
(HasCallStack, ManagedPtrNewtype o, TypedObject o,
 ManagedPtrNewtype o', TypedObject o') =>
(ManagedPtr o' -> o') -> o -> IO o'
B.ManagedPtr.unsafeCastTo ManagedPtr DNDEvent -> DNDEvent
DNDEvent

--- XXX Missing getter and/or setter, so no GValue instance could be generated.
#if defined(ENABLE_OVERLOADING)
type family ResolveDNDEventMethod (t :: Symbol) (o :: *) :: * where
    ResolveDNDEventMethod "ref" o = Gdk.Event.EventRefMethodInfo
    ResolveDNDEventMethod "triggersContextMenu" o = Gdk.Event.EventTriggersContextMenuMethodInfo
    ResolveDNDEventMethod "unref" o = Gdk.Event.EventUnrefMethodInfo
    ResolveDNDEventMethod "getAxes" o = Gdk.Event.EventGetAxesMethodInfo
    ResolveDNDEventMethod "getAxis" o = Gdk.Event.EventGetAxisMethodInfo
    ResolveDNDEventMethod "getDevice" o = Gdk.Event.EventGetDeviceMethodInfo
    ResolveDNDEventMethod "getDeviceTool" o = Gdk.Event.EventGetDeviceToolMethodInfo
    ResolveDNDEventMethod "getDisplay" o = Gdk.Event.EventGetDisplayMethodInfo
    ResolveDNDEventMethod "getDrop" o = DNDEventGetDropMethodInfo
    ResolveDNDEventMethod "getEventSequence" o = Gdk.Event.EventGetEventSequenceMethodInfo
    ResolveDNDEventMethod "getEventType" o = Gdk.Event.EventGetEventTypeMethodInfo
    ResolveDNDEventMethod "getHistory" o = Gdk.Event.EventGetHistoryMethodInfo
    ResolveDNDEventMethod "getModifierState" o = Gdk.Event.EventGetModifierStateMethodInfo
    ResolveDNDEventMethod "getPointerEmulated" o = Gdk.Event.EventGetPointerEmulatedMethodInfo
    ResolveDNDEventMethod "getPosition" o = Gdk.Event.EventGetPositionMethodInfo
    ResolveDNDEventMethod "getSeat" o = Gdk.Event.EventGetSeatMethodInfo
    ResolveDNDEventMethod "getSurface" o = Gdk.Event.EventGetSurfaceMethodInfo
    ResolveDNDEventMethod "getTime" o = Gdk.Event.EventGetTimeMethodInfo
    ResolveDNDEventMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveDNDEventMethod t DNDEvent, O.OverloadedMethod info DNDEvent p) => OL.IsLabel t (DNDEvent -> 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 ~ ResolveDNDEventMethod t DNDEvent, O.OverloadedMethod info DNDEvent p, R.HasField t DNDEvent p) => R.HasField t DNDEvent p where
    getField = O.overloadedMethod @info

#endif

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

#endif

-- XXX Wrapping a foreign struct/union with no known destructor or size, leak?
instance BoxedPtr DNDEvent where
    boxedPtrCopy :: DNDEvent -> IO DNDEvent
boxedPtrCopy = DNDEvent -> IO DNDEvent
forall (m :: * -> *) a. Monad m => a -> m a
return
    boxedPtrFree :: DNDEvent -> IO ()
boxedPtrFree = \DNDEvent
_x -> () -> IO ()
forall (m :: * -> *) a. Monad m => a -> m a
return ()


-- method DNDEvent::get_drop
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "event"
--           , argType =
--               TInterface Name { namespace = "Gdk" , name = "DNDEvent" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a DND event" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "Gdk" , name = "Drop" })
-- throws : False
-- Skip return : False

foreign import ccall "gdk_dnd_event_get_drop" gdk_dnd_event_get_drop :: 
    Ptr DNDEvent ->                         -- event : TInterface (Name {namespace = "Gdk", name = "DNDEvent"})
    IO (Ptr Gdk.Drop.Drop)

-- | Gets the t'GI.Gdk.Objects.Drop.Drop' from a DND event.
dNDEventGetDrop ::
    (B.CallStack.HasCallStack, MonadIO m, IsDNDEvent a) =>
    a
    -- ^ /@event@/: a DND event
    -> m (Maybe Gdk.Drop.Drop)
    -- ^ __Returns:__ the drop
dNDEventGetDrop :: forall (m :: * -> *) a.
(HasCallStack, MonadIO m, IsDNDEvent a) =>
a -> m (Maybe Drop)
dNDEventGetDrop a
event = IO (Maybe Drop) -> m (Maybe Drop)
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO (Maybe Drop) -> m (Maybe Drop))
-> IO (Maybe Drop) -> m (Maybe Drop)
forall a b. (a -> b) -> a -> b
$ do
    Ptr DNDEvent
event' <- a -> IO (Ptr DNDEvent)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
event
    Ptr Drop
result <- Ptr DNDEvent -> IO (Ptr Drop)
gdk_dnd_event_get_drop Ptr DNDEvent
event'
    Maybe Drop
maybeResult <- Ptr Drop -> (Ptr Drop -> IO Drop) -> IO (Maybe Drop)
forall a b. Ptr a -> (Ptr a -> IO b) -> IO (Maybe b)
convertIfNonNull Ptr Drop
result ((Ptr Drop -> IO Drop) -> IO (Maybe Drop))
-> (Ptr Drop -> IO Drop) -> IO (Maybe Drop)
forall a b. (a -> b) -> a -> b
$ \Ptr Drop
result' -> do
        Drop
result'' <- ((ManagedPtr Drop -> Drop) -> Ptr Drop -> IO Drop
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
newObject ManagedPtr Drop -> Drop
Gdk.Drop.Drop) Ptr Drop
result'
        Drop -> IO Drop
forall (m :: * -> *) a. Monad m => a -> m a
return Drop
result''
    a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
event
    Maybe Drop -> IO (Maybe Drop)
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe Drop
maybeResult

#if defined(ENABLE_OVERLOADING)
data DNDEventGetDropMethodInfo
instance (signature ~ (m (Maybe Gdk.Drop.Drop)), MonadIO m, IsDNDEvent a) => O.OverloadedMethod DNDEventGetDropMethodInfo a signature where
    overloadedMethod = dNDEventGetDrop

instance O.OverloadedMethodInfo DNDEventGetDropMethodInfo a where
    overloadedMethodInfo = O.MethodInfo {
        O.overloadedMethodName = "GI.Gdk.Objects.DNDEvent.dNDEventGetDrop",
        O.overloadedMethodURL = "https://hackage.haskell.org/package/gi-gdk-4.0.3/docs/GI-Gdk-Objects-DNDEvent.html#v:dNDEventGetDrop"
        }


#endif