CssSection.hs


{- |
Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
License    : LGPL-2.1
Maintainer : Iñaki García Etxebarria (inaki@blueleaf.cc)

Defines a part of a CSS document. Because sections are nested into
one another, you can use 'GI.Gtk.Structs.CssSection.cssSectionGetParent' to get the
containing region.

/Since: 3.2/
-}

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

module GI.Gtk.Structs.CssSection
    ( 

-- * Exported types
    CssSection(..)                          ,
    noCssSection                            ,


 -- * Methods
-- ** getEndLine #method:getEndLine#

#if ENABLE_OVERLOADING
    CssSectionGetEndLineMethodInfo          ,
#endif
    cssSectionGetEndLine                    ,


-- ** getEndPosition #method:getEndPosition#

#if ENABLE_OVERLOADING
    CssSectionGetEndPositionMethodInfo      ,
#endif
    cssSectionGetEndPosition                ,


-- ** getFile #method:getFile#

#if ENABLE_OVERLOADING
    CssSectionGetFileMethodInfo             ,
#endif
    cssSectionGetFile                       ,


-- ** getParent #method:getParent#

#if ENABLE_OVERLOADING
    CssSectionGetParentMethodInfo           ,
#endif
    cssSectionGetParent                     ,


-- ** getSectionType #method:getSectionType#

#if ENABLE_OVERLOADING
    CssSectionGetSectionTypeMethodInfo      ,
#endif
    cssSectionGetSectionType                ,


-- ** getStartLine #method:getStartLine#

#if ENABLE_OVERLOADING
    CssSectionGetStartLineMethodInfo        ,
#endif
    cssSectionGetStartLine                  ,


-- ** getStartPosition #method:getStartPosition#

#if ENABLE_OVERLOADING
    CssSectionGetStartPositionMethodInfo    ,
#endif
    cssSectionGetStartPosition              ,


-- ** ref #method:ref#

#if ENABLE_OVERLOADING
    CssSectionRefMethodInfo                 ,
#endif
    cssSectionRef                           ,


-- ** unref #method:unref#

#if ENABLE_OVERLOADING
    CssSectionUnrefMethodInfo               ,
#endif
    cssSectionUnref                         ,




    ) 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.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.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.Gio.Interfaces.File as Gio.File
import {-# SOURCE #-} qualified GI.Gtk.Enums as Gtk.Enums

-- | Memory-managed wrapper type.
newtype CssSection = CssSection (ManagedPtr CssSection)
foreign import ccall "gtk_css_section_get_type" c_gtk_css_section_get_type :: 
    IO GType

instance BoxedObject CssSection where
    boxedType _ = c_gtk_css_section_get_type

-- | A convenience alias for `Nothing` :: `Maybe` `CssSection`.
noCssSection :: Maybe CssSection
noCssSection = Nothing


#if ENABLE_OVERLOADING
instance O.HasAttributeList CssSection
type instance O.AttributeList CssSection = CssSectionAttributeList
type CssSectionAttributeList = ('[ ] :: [(Symbol, *)])
#endif

-- method CssSection::get_end_line
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_end_line" gtk_css_section_get_end_line :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO Word32

{- |
Returns the line in the CSS document where this section end.
The line number is 0-indexed, so the first line of the document
will return 0.
This value may change in future invocations of this function if
/@section@/ is not yet parsed completely. This will for example
happen in the GtkCssProvider::parsing-error signal.
The end position and line may be identical to the start
position and line for sections which failed to parse anything
successfully.

/Since: 3.2/
-}
cssSectionGetEndLine ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Word32
    {- ^ __Returns:__ the line number -}
cssSectionGetEndLine section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_end_line section'
    touchManagedPtr section
    return result

#if ENABLE_OVERLOADING
data CssSectionGetEndLineMethodInfo
instance (signature ~ (m Word32), MonadIO m) => O.MethodInfo CssSectionGetEndLineMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetEndLine

#endif

-- method CssSection::get_end_position
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_end_position" gtk_css_section_get_end_position :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO Word32

{- |
Returns the offset in bytes from the start of the current line
returned via 'GI.Gtk.Structs.CssSection.cssSectionGetEndLine'.
This value may change in future invocations of this function if
/@section@/ is not yet parsed completely. This will for example
happen in the GtkCssProvider::parsing-error signal.
The end position and line may be identical to the start
position and line for sections which failed to parse anything
successfully.

/Since: 3.2/
-}
cssSectionGetEndPosition ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Word32
    {- ^ __Returns:__ the offset in bytes from the start of the line. -}
cssSectionGetEndPosition section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_end_position section'
    touchManagedPtr section
    return result

#if ENABLE_OVERLOADING
data CssSectionGetEndPositionMethodInfo
instance (signature ~ (m Word32), MonadIO m) => O.MethodInfo CssSectionGetEndPositionMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetEndPosition

#endif

-- method CssSection::get_file
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gio", name = "File"}))
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_file" gtk_css_section_get_file :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO (Ptr Gio.File.File)

{- |
Gets the file that /@section@/ was parsed from. If no such file exists,
for example because the CSS was loaded via
/@gtkCssProviderLoadFromData@/(), then 'Nothing' is returned.

/Since: 3.2/
-}
cssSectionGetFile ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Gio.File.File
    {- ^ __Returns:__ the 'GI.Gio.Interfaces.File.File' that /@section@/ was parsed from
    or 'Nothing' if /@section@/ was parsed from other data -}
cssSectionGetFile section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_file section'
    checkUnexpectedReturnNULL "cssSectionGetFile" result
    result' <- (newObject Gio.File.File) result
    touchManagedPtr section
    return result'

#if ENABLE_OVERLOADING
data CssSectionGetFileMethodInfo
instance (signature ~ (m Gio.File.File), MonadIO m) => O.MethodInfo CssSectionGetFileMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetFile

#endif

-- method CssSection::get_parent
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "CssSection"}))
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_parent" gtk_css_section_get_parent :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO (Ptr CssSection)

{- |
Gets the parent section for the given /@section@/. The parent section is
the section that contains this /@section@/. A special case are sections of
type @/GTK_CSS_SECTION_DOCUMENT/@. Their parent will either be 'Nothing'
if they are the original CSS document that was loaded by
'GI.Gtk.Objects.CssProvider.cssProviderLoadFromFile' or a section of type
@/GTK_CSS_SECTION_IMPORT/@ if it was loaded with an import rule from
a different file.

/Since: 3.2/
-}
cssSectionGetParent ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m (Maybe CssSection)
    {- ^ __Returns:__ the parent section or 'Nothing' if none -}
cssSectionGetParent section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_parent section'
    maybeResult <- convertIfNonNull result $ \result' -> do
        result'' <- (newBoxed CssSection) result'
        return result''
    touchManagedPtr section
    return maybeResult

#if ENABLE_OVERLOADING
data CssSectionGetParentMethodInfo
instance (signature ~ (m (Maybe CssSection)), MonadIO m) => O.MethodInfo CssSectionGetParentMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetParent

#endif

-- method CssSection::get_section_type
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "CssSectionType"}))
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_section_type" gtk_css_section_get_section_type :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO CUInt

{- |
Gets the type of information that /@section@/ describes.

/Since: 3.2/
-}
cssSectionGetSectionType ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Gtk.Enums.CssSectionType
    {- ^ __Returns:__ the type of /@section@/ -}
cssSectionGetSectionType section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_section_type section'
    let result' = (toEnum . fromIntegral) result
    touchManagedPtr section
    return result'

#if ENABLE_OVERLOADING
data CssSectionGetSectionTypeMethodInfo
instance (signature ~ (m Gtk.Enums.CssSectionType), MonadIO m) => O.MethodInfo CssSectionGetSectionTypeMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetSectionType

#endif

-- method CssSection::get_start_line
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_start_line" gtk_css_section_get_start_line :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO Word32

{- |
Returns the line in the CSS document where this section starts.
The line number is 0-indexed, so the first line of the document
will return 0.

/Since: 3.2/
-}
cssSectionGetStartLine ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Word32
    {- ^ __Returns:__ the line number -}
cssSectionGetStartLine section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_start_line section'
    touchManagedPtr section
    return result

#if ENABLE_OVERLOADING
data CssSectionGetStartLineMethodInfo
instance (signature ~ (m Word32), MonadIO m) => O.MethodInfo CssSectionGetStartLineMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetStartLine

#endif

-- method CssSection::get_start_position
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "the section", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TUInt)
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_get_start_position" gtk_css_section_get_start_position :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO Word32

{- |
Returns the offset in bytes from the start of the current line
returned via 'GI.Gtk.Structs.CssSection.cssSectionGetStartLine'.

/Since: 3.2/
-}
cssSectionGetStartPosition ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: the section -}
    -> m Word32
    {- ^ __Returns:__ the offset in bytes from the start of the line. -}
cssSectionGetStartPosition section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_get_start_position section'
    touchManagedPtr section
    return result

#if ENABLE_OVERLOADING
data CssSectionGetStartPositionMethodInfo
instance (signature ~ (m Word32), MonadIO m) => O.MethodInfo CssSectionGetStartPositionMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionGetStartPosition

#endif

-- method CssSection::ref
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkCssSection", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "CssSection"}))
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_ref" gtk_css_section_ref :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO (Ptr CssSection)

{- |
Increments the reference count on /@section@/.

/Since: 3.2/
-}
cssSectionRef ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: a 'GI.Gtk.Structs.CssSection.CssSection' -}
    -> m CssSection
    {- ^ __Returns:__ /@section@/ itself. -}
cssSectionRef section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    result <- gtk_css_section_ref section'
    checkUnexpectedReturnNULL "cssSectionRef" result
    result' <- (wrapBoxed CssSection) result
    touchManagedPtr section
    return result'

#if ENABLE_OVERLOADING
data CssSectionRefMethodInfo
instance (signature ~ (m CssSection), MonadIO m) => O.MethodInfo CssSectionRefMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionRef

#endif

-- method CssSection::unref
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "section", argType = TInterface (Name {namespace = "Gtk", name = "CssSection"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkCssSection", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False

foreign import ccall "gtk_css_section_unref" gtk_css_section_unref :: 
    Ptr CssSection ->                       -- section : TInterface (Name {namespace = "Gtk", name = "CssSection"})
    IO ()

{- |
Decrements the reference count on /@section@/, freeing the
structure if the reference count reaches 0.

/Since: 3.2/
-}
cssSectionUnref ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    CssSection
    {- ^ /@section@/: a 'GI.Gtk.Structs.CssSection.CssSection' -}
    -> m ()
cssSectionUnref section = liftIO $ do
    section' <- unsafeManagedPtrGetPtr section
    gtk_css_section_unref section'
    touchManagedPtr section
    return ()

#if ENABLE_OVERLOADING
data CssSectionUnrefMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.MethodInfo CssSectionUnrefMethodInfo CssSection signature where
    overloadedMethod _ = cssSectionUnref

#endif

#if ENABLE_OVERLOADING
type family ResolveCssSectionMethod (t :: Symbol) (o :: *) :: * where
    ResolveCssSectionMethod "ref" o = CssSectionRefMethodInfo
    ResolveCssSectionMethod "unref" o = CssSectionUnrefMethodInfo
    ResolveCssSectionMethod "getEndLine" o = CssSectionGetEndLineMethodInfo
    ResolveCssSectionMethod "getEndPosition" o = CssSectionGetEndPositionMethodInfo
    ResolveCssSectionMethod "getFile" o = CssSectionGetFileMethodInfo
    ResolveCssSectionMethod "getParent" o = CssSectionGetParentMethodInfo
    ResolveCssSectionMethod "getSectionType" o = CssSectionGetSectionTypeMethodInfo
    ResolveCssSectionMethod "getStartLine" o = CssSectionGetStartLineMethodInfo
    ResolveCssSectionMethod "getStartPosition" o = CssSectionGetStartPositionMethodInfo
    ResolveCssSectionMethod l o = O.MethodResolutionFailed l o

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

#endif