{-# 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 activates an action by name.

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

module GI.Gtk.Objects.NamedAction
    ( 

-- * Exported types
    NamedAction(..)                         ,
    IsNamedAction                           ,
    toNamedAction                           ,


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

#if defined(ENABLE_OVERLOADING)
    ResolveNamedActionMethod                ,
#endif


-- ** getActionName #method:getActionName#

#if defined(ENABLE_OVERLOADING)
    NamedActionGetActionNameMethodInfo      ,
#endif
    namedActionGetActionName                ,


-- ** new #method:new#

    namedActionNew                          ,




 -- * Properties
-- ** actionName #attr:actionName#
-- | The name of the action to activate.

#if defined(ENABLE_OVERLOADING)
    NamedActionActionNamePropertyInfo       ,
#endif
    constructNamedActionActionName          ,
    getNamedActionActionName                ,
#if defined(ENABLE_OVERLOADING)
    namedActionActionName                   ,
#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 NamedAction = NamedAction (SP.ManagedPtr NamedAction)
    deriving (NamedAction -> NamedAction -> Bool
(NamedAction -> NamedAction -> Bool)
-> (NamedAction -> NamedAction -> Bool) -> Eq NamedAction
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NamedAction -> NamedAction -> Bool
$c/= :: NamedAction -> NamedAction -> Bool
== :: NamedAction -> NamedAction -> Bool
$c== :: NamedAction -> NamedAction -> Bool
Eq)

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

foreign import ccall "gtk_named_action_get_type"
    c_gtk_named_action_get_type :: IO B.Types.GType

instance B.Types.TypedObject NamedAction where
    glibType :: IO GType
glibType = IO GType
c_gtk_named_action_get_type

instance B.Types.GObject NamedAction

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

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

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

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

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

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

#endif

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

-- | Get the value of the “@action-name@” property.
-- When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
-- 
-- @
-- 'Data.GI.Base.Attributes.get' namedAction #actionName
-- @
getNamedActionActionName :: (MonadIO m, IsNamedAction o) => o -> m T.Text
getNamedActionActionName :: o -> m Text
getNamedActionActionName 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
"getNamedActionActionName" (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
"action-name"

-- | Construct a `GValueConstruct` with valid value for the “@action-name@” property. This is rarely needed directly, but it is used by `Data.GI.Base.Constructible.new`.
constructNamedActionActionName :: (IsNamedAction o, MIO.MonadIO m) => T.Text -> m (GValueConstruct o)
constructNamedActionActionName :: Text -> m (GValueConstruct o)
constructNamedActionActionName 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
"action-name" (Text -> Maybe Text
forall a. a -> Maybe a
P.Just Text
val)

#if defined(ENABLE_OVERLOADING)
data NamedActionActionNamePropertyInfo
instance AttrInfo NamedActionActionNamePropertyInfo where
    type AttrAllowedOps NamedActionActionNamePropertyInfo = '[ 'AttrConstruct, 'AttrGet, 'AttrClear]
    type AttrBaseTypeConstraint NamedActionActionNamePropertyInfo = IsNamedAction
    type AttrSetTypeConstraint NamedActionActionNamePropertyInfo = (~) T.Text
    type AttrTransferTypeConstraint NamedActionActionNamePropertyInfo = (~) T.Text
    type AttrTransferType NamedActionActionNamePropertyInfo = T.Text
    type AttrGetType NamedActionActionNamePropertyInfo = T.Text
    type AttrLabel NamedActionActionNamePropertyInfo = "action-name"
    type AttrOrigin NamedActionActionNamePropertyInfo = NamedAction
    attrGet = getNamedActionActionName
    attrSet = undefined
    attrTransfer _ v = do
        return v
    attrConstruct = constructNamedActionActionName
    attrClear = undefined
#endif

#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList NamedAction
type instance O.AttributeList NamedAction = NamedActionAttributeList
type NamedActionAttributeList = ('[ '("actionName", NamedActionActionNamePropertyInfo)] :: [(Symbol, *)])
#endif

#if defined(ENABLE_OVERLOADING)
namedActionActionName :: AttrLabelProxy "actionName"
namedActionActionName = AttrLabelProxy

#endif

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

#endif

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

foreign import ccall "gtk_named_action_new" gtk_named_action_new :: 
    CString ->                              -- name : TBasicType TUTF8
    IO (Ptr NamedAction)

-- | Creates an action that when activated, activates the action given by
-- the detailed /@name@/ on the widget passing the given arguments to it.
-- 
-- See 'GI.Gtk.Objects.Widget.widgetInsertActionGroup' for how to add actions to widgets.
namedActionNew ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    T.Text
    -- ^ /@name@/: the detailed name of the action
    -> m NamedAction
    -- ^ __Returns:__ a new t'GI.Gtk.Objects.ShortcutAction.ShortcutAction'
namedActionNew :: Text -> m NamedAction
namedActionNew Text
name = IO NamedAction -> m NamedAction
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (IO NamedAction -> m NamedAction)
-> IO NamedAction -> m NamedAction
forall a b. (a -> b) -> a -> b
$ do
    CString
name' <- Text -> IO CString
textToCString Text
name
    Ptr NamedAction
result <- CString -> IO (Ptr NamedAction)
gtk_named_action_new CString
name'
    Text -> Ptr NamedAction -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"namedActionNew" Ptr NamedAction
result
    NamedAction
result' <- ((ManagedPtr NamedAction -> NamedAction)
-> Ptr NamedAction -> IO NamedAction
forall a b.
(HasCallStack, GObject a, GObject b) =>
(ManagedPtr a -> a) -> Ptr b -> IO a
wrapObject ManagedPtr NamedAction -> NamedAction
NamedAction) Ptr NamedAction
result
    CString -> IO ()
forall a. Ptr a -> IO ()
freeMem CString
name'
    NamedAction -> IO NamedAction
forall (m :: * -> *) a. Monad m => a -> m a
return NamedAction
result'

#if defined(ENABLE_OVERLOADING)
#endif

-- method NamedAction::get_action_name
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "self"
--           , argType =
--               TInterface Name { namespace = "Gtk" , name = "NamedAction" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a named 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_named_action_get_action_name" gtk_named_action_get_action_name :: 
    Ptr NamedAction ->                      -- self : TInterface (Name {namespace = "Gtk", name = "NamedAction"})
    IO CString

-- | Returns the name of the action that will be activated.
namedActionGetActionName ::
    (B.CallStack.HasCallStack, MonadIO m, IsNamedAction a) =>
    a
    -- ^ /@self@/: a named action
    -> m T.Text
    -- ^ __Returns:__ the name of the action to activate
namedActionGetActionName :: a -> m Text
namedActionGetActionName 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 NamedAction
self' <- a -> IO (Ptr NamedAction)
forall a b. (HasCallStack, ManagedPtrNewtype a) => a -> IO (Ptr b)
unsafeManagedPtrCastPtr a
self
    CString
result <- Ptr NamedAction -> IO CString
gtk_named_action_get_action_name Ptr NamedAction
self'
    Text -> CString -> IO ()
forall a. HasCallStack => Text -> Ptr a -> IO ()
checkUnexpectedReturnNULL Text
"namedActionGetActionName" 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 NamedActionGetActionNameMethodInfo
instance (signature ~ (m T.Text), MonadIO m, IsNamedAction a) => O.MethodInfo NamedActionGetActionNameMethodInfo a signature where
    overloadedMethod = namedActionGetActionName

#endif