{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson and Iñaki García Etxebarria
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A @GtkShortcutAction@ that invokes a callback.

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

module GI.Gtk.Objects.CallbackAction
    ( 

-- * Exported types
    CallbackAction(..)                      ,
    IsCallbackAction                        ,
    toCallbackAction                        ,


 -- * Methods
-- | 
-- 
--  === __Click to display all available methods, including inherited ones__
-- ==== Methods
-- [activate]("GI.Gtk.Objects.ShortcutAction#g:method:activate"), [bindProperty]("GI.GObject.Objects.Object#g:method:bindProperty"), [bindPropertyFull]("GI.GObject.Objects.Object#g:method:bindPropertyFull"), [forceFloating]("GI.GObject.Objects.Object#g:method:forceFloating"), [freezeNotify]("GI.GObject.Objects.Object#g:method:freezeNotify"), [getv]("GI.GObject.Objects.Object#g:method:getv"), [isFloating]("GI.GObject.Objects.Object#g:method:isFloating"), [notify]("GI.GObject.Objects.Object#g:method:notify"), [notifyByPspec]("GI.GObject.Objects.Object#g:method:notifyByPspec"), [print]("GI.Gtk.Objects.ShortcutAction#g:method:print"), [ref]("GI.GObject.Objects.Object#g:method:ref"), [refSink]("GI.GObject.Objects.Object#g:method:refSink"), [runDispose]("GI.GObject.Objects.Object#g:method:runDispose"), [stealData]("GI.GObject.Objects.Object#g:method:stealData"), [stealQdata]("GI.GObject.Objects.Object#g:method:stealQdata"), [thawNotify]("GI.GObject.Objects.Object#g:method:thawNotify"), [toString]("GI.Gtk.Objects.ShortcutAction#g:method:toString"), [unref]("GI.GObject.Objects.Object#g:method:unref"), [watchClosure]("GI.GObject.Objects.Object#g:method:watchClosure").
-- 
-- ==== Getters
-- [getData]("GI.GObject.Objects.Object#g:method:getData"), [getProperty]("GI.GObject.Objects.Object#g:method:getProperty"), [getQdata]("GI.GObject.Objects.Object#g:method:getQdata").
-- 
-- ==== Setters
-- [setData]("GI.GObject.Objects.Object#g:method:setData"), [setDataFull]("GI.GObject.Objects.Object#g:method:setDataFull"), [setProperty]("GI.GObject.Objects.Object#g:method:setProperty").

#if defined(ENABLE_OVERLOADING)
    ResolveCallbackActionMethod             ,
#endif

-- ** new #method:new#

    callbackActionNew                       ,




    ) 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 GI.GLib.Callbacks as GLib.Callbacks
import qualified GI.GObject.Objects.Object as GObject.Object
import qualified GI.Gtk.Callbacks as Gtk.Callbacks
import {-# SOURCE #-} qualified GI.Gtk.Objects.ShortcutAction as Gtk.ShortcutAction

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

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

foreign import ccall "gtk_callback_action_get_type"
    c_gtk_callback_action_get_type :: IO B.Types.GType

instance B.Types.TypedObject CallbackAction where
    glibType :: IO GType
glibType = IO GType
c_gtk_callback_action_get_type

instance B.Types.GObject CallbackAction

-- | Type class for types which can be safely cast to `CallbackAction`, for instance with `toCallbackAction`.
class (SP.GObject o, O.IsDescendantOf CallbackAction o) => IsCallbackAction o
instance (SP.GObject o, O.IsDescendantOf CallbackAction o) => IsCallbackAction o

instance O.HasParentTypes CallbackAction
type instance O.ParentTypes CallbackAction = '[Gtk.ShortcutAction.ShortcutAction, GObject.Object.Object]

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

-- | Convert 'CallbackAction' 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 CallbackAction) where
    gvalueGType_ :: IO GType
gvalueGType_ = IO GType
c_gtk_callback_action_get_type
    gvalueSet_ :: Ptr GValue -> Maybe CallbackAction -> IO ()
gvalueSet_ Ptr GValue
gv Maybe CallbackAction
P.Nothing = Ptr GValue -> Ptr CallbackAction -> IO ()
forall a. GObject a => Ptr GValue -> Ptr a -> IO ()
B.GValue.set_object Ptr GValue
gv (Ptr CallbackAction
forall a. Ptr a
FP.nullPtr :: FP.Ptr CallbackAction)
    gvalueSet_ Ptr GValue
gv (P.Just CallbackAction
obj) = CallbackAction -> (Ptr CallbackAction -> IO ()) -> IO ()
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr CallbackAction
obj (Ptr GValue -> Ptr CallbackAction -> IO ()
forall a. GObject a => Ptr GValue -> Ptr a -> IO ()
B.GValue.set_object Ptr GValue
gv)
    gvalueGet_ :: Ptr GValue -> IO (Maybe CallbackAction)
gvalueGet_ Ptr GValue
gv = do
        Ptr CallbackAction
ptr <- Ptr GValue -> IO (Ptr CallbackAction)
forall a. GObject a => Ptr GValue -> IO (Ptr a)
B.GValue.get_object Ptr GValue
gv :: IO (FP.Ptr CallbackAction)
        if Ptr CallbackAction
ptr Ptr CallbackAction -> Ptr CallbackAction -> Bool
forall a. Eq a => a -> a -> Bool
/= Ptr CallbackAction
forall a. Ptr a
FP.nullPtr
        then CallbackAction -> Maybe CallbackAction
forall a. a -> Maybe a
P.Just (CallbackAction -> Maybe CallbackAction)
-> IO CallbackAction -> IO (Maybe CallbackAction)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (ManagedPtr CallbackAction -> CallbackAction)
-> Ptr CallbackAction -> IO CallbackAction
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
B.ManagedPtr.newObject ManagedPtr CallbackAction -> CallbackAction
CallbackAction Ptr CallbackAction
ptr
        else Maybe CallbackAction -> IO (Maybe CallbackAction)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Maybe CallbackAction
forall a. Maybe a
P.Nothing
        
    

#if defined(ENABLE_OVERLOADING)
type family ResolveCallbackActionMethod (t :: Symbol) (o :: DK.Type) :: DK.Type where
    ResolveCallbackActionMethod "activate" o = Gtk.ShortcutAction.ShortcutActionActivateMethodInfo
    ResolveCallbackActionMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
    ResolveCallbackActionMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
    ResolveCallbackActionMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
    ResolveCallbackActionMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
    ResolveCallbackActionMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
    ResolveCallbackActionMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
    ResolveCallbackActionMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
    ResolveCallbackActionMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
    ResolveCallbackActionMethod "print" o = Gtk.ShortcutAction.ShortcutActionPrintMethodInfo
    ResolveCallbackActionMethod "ref" o = GObject.Object.ObjectRefMethodInfo
    ResolveCallbackActionMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
    ResolveCallbackActionMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
    ResolveCallbackActionMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
    ResolveCallbackActionMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
    ResolveCallbackActionMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
    ResolveCallbackActionMethod "toString" o = Gtk.ShortcutAction.ShortcutActionToStringMethodInfo
    ResolveCallbackActionMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
    ResolveCallbackActionMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
    ResolveCallbackActionMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
    ResolveCallbackActionMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
    ResolveCallbackActionMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
    ResolveCallbackActionMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
    ResolveCallbackActionMethod "setDataFull" o = GObject.Object.ObjectSetDataFullMethodInfo
    ResolveCallbackActionMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
    ResolveCallbackActionMethod l o = O.MethodResolutionFailed l o

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

#endif

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

#endif

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

#if defined(ENABLE_OVERLOADING)
#endif

#if defined(ENABLE_OVERLOADING)
type instance O.SignalList CallbackAction = CallbackActionSignalList
type CallbackActionSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, DK.Type)])

#endif

-- method CallbackAction::new
-- method type : Constructor
-- Args: [ Arg
--           { argCName = "callback"
--           , argType =
--               TInterface Name { namespace = "Gtk" , name = "ShortcutFunc" }
--           , direction = DirectionIn
--           , mayBeNull = True
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the callback to call"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeNotified
--           , argClosure = 1
--           , argDestroy = 2
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "data"
--           , argType = TBasicType TPtr
--           , direction = DirectionIn
--           , mayBeNull = True
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the data to be passed to @callback"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeNotified
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "destroy"
--           , argType =
--               TInterface Name { namespace = "GLib" , name = "DestroyNotify" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText =
--                     Just
--                       "the function to be called when the\n  callback action is finalized"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeAsync
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface Name { namespace = "Gtk" , name = "CallbackAction" })
-- throws : False
-- Skip return : False

foreign import ccall "gtk_callback_action_new" gtk_callback_action_new :: 
    FunPtr Gtk.Callbacks.C_ShortcutFunc ->  -- callback : TInterface (Name {namespace = "Gtk", name = "ShortcutFunc"})
    Ptr () ->                               -- data : TBasicType TPtr
    FunPtr GLib.Callbacks.C_DestroyNotify -> -- destroy : TInterface (Name {namespace = "GLib", name = "DestroyNotify"})
    IO (Ptr CallbackAction)

-- | Create a custom action that calls the given /@callback@/ when
-- activated.
callbackActionNew ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    Maybe (Gtk.Callbacks.ShortcutFunc)
    -- ^ /@callback@/: the callback to call
    -> m CallbackAction
    -- ^ __Returns:__ A new shortcut action
callbackActionNew :: forall (m :: * -> *).
(HasCallStack, MonadIO m) =>
Maybe ShortcutFunc -> m CallbackAction
callbackActionNew Maybe ShortcutFunc
callback = IO CallbackAction -> m CallbackAction
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO CallbackAction -> m CallbackAction)
-> IO CallbackAction -> m CallbackAction
forall a b. (a -> b) -> a -> b
$ do
    FunPtr C_ShortcutFunc
maybeCallback <- case Maybe ShortcutFunc
callback of
        Maybe ShortcutFunc
Nothing -> FunPtr C_ShortcutFunc -> IO (FunPtr C_ShortcutFunc)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return (Ptr Any -> FunPtr C_ShortcutFunc
forall a b. Ptr a -> FunPtr b
castPtrToFunPtr Ptr Any
forall a. Ptr a
nullPtr)
        Just ShortcutFunc
jCallback -> do
            FunPtr C_ShortcutFunc
jCallback' <- C_ShortcutFunc -> IO (FunPtr C_ShortcutFunc)
Gtk.Callbacks.mk_ShortcutFunc (Maybe (Ptr (FunPtr C_ShortcutFunc))
-> ShortcutFunc_WithClosures -> C_ShortcutFunc
Gtk.Callbacks.wrap_ShortcutFunc Maybe (Ptr (FunPtr C_ShortcutFunc))
forall a. Maybe a
Nothing (ShortcutFunc -> ShortcutFunc_WithClosures
Gtk.Callbacks.drop_closures_ShortcutFunc ShortcutFunc
jCallback))
            FunPtr C_ShortcutFunc -> IO (FunPtr C_ShortcutFunc)
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return FunPtr C_ShortcutFunc
jCallback'
    let data_ :: Ptr ()
data_ = FunPtr C_ShortcutFunc -> Ptr ()
forall a b. FunPtr a -> Ptr b
castFunPtrToPtr FunPtr C_ShortcutFunc
maybeCallback
    let destroy :: FunPtr (Ptr a -> IO ())
destroy = FunPtr (Ptr a -> IO ())
forall a. FunPtr (Ptr a -> IO ())
SP.safeFreeFunPtrPtr
    Ptr CallbackAction
result <- FunPtr C_ShortcutFunc
-> Ptr () -> FunPtr C_DestroyNotify -> IO (Ptr CallbackAction)
gtk_callback_action_new FunPtr C_ShortcutFunc
maybeCallback Ptr ()
data_ FunPtr C_DestroyNotify
forall a. FunPtr (Ptr a -> IO ())
destroy
    Text -> Ptr CallbackAction -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"callbackActionNew" Ptr CallbackAction
result
    CallbackAction
result' <- ((ManagedPtr CallbackAction -> CallbackAction)
-> Ptr CallbackAction -> IO CallbackAction
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
wrapObject ManagedPtr CallbackAction -> CallbackAction
CallbackAction) Ptr CallbackAction
result
    CallbackAction -> IO CallbackAction
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return CallbackAction
result'

#if defined(ENABLE_OVERLOADING)
#endif