{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- A t'GI.Gtk.Objects.ShortcutAction.ShortcutAction' that emits a signal.

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

module GI.Gtk.Objects.SignalAction
    ( 

-- * Exported types
    SignalAction(..)                        ,
    IsSignalAction                          ,
    toSignalAction                          ,


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

#if defined(ENABLE_OVERLOADING)
    ResolveSignalActionMethod               ,
#endif


-- ** getSignalName #method:getSignalName#

#if defined(ENABLE_OVERLOADING)
    SignalActionGetSignalNameMethodInfo     ,
#endif
    signalActionGetSignalName               ,


-- ** new #method:new#

    signalActionNew                         ,




 -- * Properties
-- ** signalName #attr:signalName#
-- | The name of the signal to emit.

#if defined(ENABLE_OVERLOADING)
    SignalActionSignalNamePropertyInfo      ,
#endif
    constructSignalActionSignalName         ,
    getSignalActionSignalName               ,
#if defined(ENABLE_OVERLOADING)
    signalActionSignalName                  ,
#endif




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

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

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

foreign import ccall "gtk_signal_action_get_type"
    c_gtk_signal_action_get_type :: IO B.Types.GType

instance B.Types.TypedObject SignalAction where
    glibType :: IO GType
glibType = IO GType
c_gtk_signal_action_get_type

instance B.Types.GObject SignalAction

-- | Convert 'SignalAction' to and from 'Data.GI.Base.GValue.GValue' with 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue SignalAction where
    toGValue :: SignalAction -> IO GValue
toGValue SignalAction
o = do
        GType
gtype <- IO GType
c_gtk_signal_action_get_type
        SignalAction -> (Ptr SignalAction -> IO GValue) -> IO GValue
forall a c.
(HasCallStack, ManagedPtrNewtype a) =>
a -> (Ptr a -> IO c) -> IO c
B.ManagedPtr.withManagedPtr SignalAction
o (GType
-> (GValue -> Ptr SignalAction -> IO ())
-> Ptr SignalAction
-> IO GValue
forall a. GType -> (GValue -> a -> IO ()) -> a -> IO GValue
B.GValue.buildGValue GType
gtype GValue -> Ptr SignalAction -> IO ()
forall a. GObject a => GValue -> Ptr a -> IO ()
B.GValue.set_object)
        
    fromGValue :: GValue -> IO SignalAction
fromGValue GValue
gv = do
        Ptr SignalAction
ptr <- GValue -> IO (Ptr SignalAction)
forall b. GObject b => GValue -> IO (Ptr b)
B.GValue.get_object GValue
gv :: IO (Ptr SignalAction)
        (ManagedPtr SignalAction -> SignalAction)
-> Ptr SignalAction -> IO SignalAction
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
B.ManagedPtr.newObject ManagedPtr SignalAction -> SignalAction
SignalAction Ptr SignalAction
ptr
        
    

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

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

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

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

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

#endif

-- VVV Prop "signal-name"
   -- Type: TBasicType TUTF8
   -- Flags: [PropertyReadable,PropertyWritable,PropertyConstructOnly]
   -- Nullable: (Just False,Nothing)

-- | Get the value of the “@signal-name@” property.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.get' signalAction #signalName
-- @
getSignalActionSignalName :: (MonadIO m, IsSignalAction o) => o -> m T.Text
getSignalActionSignalName :: o -> m Text
getSignalActionSignalName o
obj = IO Text -> m Text
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
$ Text -> IO (Maybe Text) -> IO Text
forall a. HasCallStack => Text -> IO (Maybe a) -> IO a
checkUnexpectedNothing Text
"getSignalActionSignalName" (IO (Maybe Text) -> IO Text) -> IO (Maybe Text) -> IO Text
forall a b. (a -> b) -> a -> b
$ o -> String -> IO (Maybe Text)
forall a. GObject a => a -> String -> IO (Maybe Text)
B.Properties.getObjectPropertyString o
obj String
"signal-name"

-- | Construct a `GValueConstruct` with valid value for the “@signal-name@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
constructSignalActionSignalName :: (IsSignalAction o, MIO.MonadIO m) => T.Text -> m (GValueConstruct o)
constructSignalActionSignalName :: Text -> m (GValueConstruct o)
constructSignalActionSignalName Text
val = IO (GValueConstruct o) -> m (GValueConstruct o)
forall (m :: * -> *) a. MonadIO m => IO a -> m a
MIO.liftIO (IO (GValueConstruct o) -> m (GValueConstruct o))
-> IO (GValueConstruct o) -> m (GValueConstruct o)
forall a b. (a -> b) -> a -> b
$ String -> Maybe Text -> IO (GValueConstruct o)
forall o. String -> Maybe Text -> IO (GValueConstruct o)
B.Properties.constructObjectPropertyString String
"signal-name" (Text -> Maybe Text
forall a. a -> Maybe a
P.Just Text
val)

#if defined(ENABLE_OVERLOADING)
data SignalActionSignalNamePropertyInfo
instance AttrInfo SignalActionSignalNamePropertyInfo where
    type AttrAllowedOps SignalActionSignalNamePropertyInfo = '[ 'AttrConstruct, 'AttrGet, 'AttrClear]
    type AttrBaseTypeConstraint SignalActionSignalNamePropertyInfo = IsSignalAction
    type AttrSetTypeConstraint SignalActionSignalNamePropertyInfo = (~) T.Text
    type AttrTransferTypeConstraint SignalActionSignalNamePropertyInfo = (~) T.Text
    type AttrTransferType SignalActionSignalNamePropertyInfo = T.Text
    type AttrGetType SignalActionSignalNamePropertyInfo = T.Text
    type AttrLabel SignalActionSignalNamePropertyInfo = "signal-name"
    type AttrOrigin SignalActionSignalNamePropertyInfo = SignalAction
    attrGet = getSignalActionSignalName
    attrSet = undefined
    attrTransfer _ v = do
        return v
    attrConstruct = constructSignalActionSignalName
    attrClear = undefined
#endif

#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList SignalAction
type instance O.AttributeList SignalAction = SignalActionAttributeList
type SignalActionAttributeList = ('[ '("signalName", SignalActionSignalNamePropertyInfo)] :: [(Symbol, *)])
#endif

#if defined(ENABLE_OVERLOADING)
signalActionSignalName :: AttrLabelProxy "signalName"
signalActionSignalName = AttrLabelProxy

#endif

#if defined(ENABLE_OVERLOADING)
type instance O.SignalList SignalAction = SignalActionSignalList
type SignalActionSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo)] :: [(Symbol, *)])

#endif

-- method SignalAction::new
-- method type : Constructor
-- Args: [ Arg
--           { argCName = "signal_name"
--           , argType = TBasicType TUTF8
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "name of the signal to emit"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just
--               (TInterface Name { namespace = "Gtk" , name = "SignalAction" })
-- throws : False
-- Skip return : False

foreign import ccall "gtk_signal_action_new" gtk_signal_action_new :: 
    CString ->                              -- signal_name : TBasicType TUTF8
    IO (Ptr SignalAction)

-- | Creates an action that when activated, emits the given action signal
-- on the provided widget unpacking the given args into arguments passed
-- to the signal.
signalActionNew ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    T.Text
    -- ^ /@signalName@/: name of the signal to emit
    -> m SignalAction
    -- ^ __Returns:__ a new t'GI.Gtk.Objects.ShortcutAction.ShortcutAction'
signalActionNew :: Text -> m SignalAction
signalActionNew Text
signalName = IO SignalAction -> m SignalAction
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO SignalAction -> m SignalAction)
-> IO SignalAction -> m SignalAction
forall a b. (a -> b) -> a -> b
$ do
    CString
signalName' <- Text -> IO CString
textToCString Text
signalName
    Ptr SignalAction
result <- CString -> IO (Ptr SignalAction)
gtk_signal_action_new CString
signalName'
    Text -> Ptr SignalAction -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"signalActionNew" Ptr SignalAction
result
    SignalAction
result' <- ((ManagedPtr SignalAction -> SignalAction)
-> Ptr SignalAction -> IO SignalAction
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
wrapObject ManagedPtr SignalAction -> SignalAction
SignalAction) Ptr SignalAction
result
    CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
signalName'
    SignalAction -> IO SignalAction
forall (m :: * -> *) a. Monad m => a -> m a
return SignalAction
result'

#if defined(ENABLE_OVERLOADING)
#endif

-- method SignalAction::get_signal_name
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "self"
--           , argType =
--               TInterface Name { namespace = "Gtk" , name = "SignalAction" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a signal action" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "gtk_signal_action_get_signal_name" gtk_signal_action_get_signal_name :: 
    Ptr SignalAction ->                     -- self : TInterface (Name {namespace = "Gtk", name = "SignalAction"})
    IO CString

-- | Returns the name of the signal that will be emitted.
signalActionGetSignalName ::
    (B.CallStack.HasCallStack, MonadIO m, IsSignalAction a) =>
    a
    -- ^ /@self@/: a signal action
    -> m T.Text
    -- ^ __Returns:__ the name of the signal to emit
signalActionGetSignalName :: a -> m Text
signalActionGetSignalName a
self = IO Text -> m Text
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 SignalAction
self' <- a -> IO (Ptr SignalAction)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
self
    CString
result <- Ptr SignalAction -> IO CString
gtk_signal_action_get_signal_name Ptr SignalAction
self'
    Text -> CString -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"signalActionGetSignalName" CString
result
    Text
result' <- HasCallStack => CString -> IO Text
CString -> IO Text
cstringToText CString
result
    a -> IO ()
forall a. ManagedPtrNewtype a => a -> IO ()
touchManagedPtr a
self
    Text -> IO Text
forall (m :: * -> *) a. Monad m => a -> m a
return Text
result'

#if defined(ENABLE_OVERLOADING)
data SignalActionGetSignalNameMethodInfo
instance (signature ~ (m T.Text), MonadIO m, IsSignalAction a) => O.MethodInfo SignalActionGetSignalNameMethodInfo a signature where
    overloadedMethod = signalActionGetSignalName

#endif