gi-gtk-3.0.28: GI/Gtk/Objects/TextTagTable.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)
You may wish to begin by reading the
[text widget conceptual overview][TextWidget]
which gives an overview of all the objects and
data types related to the text widget and how they work together.
= GtkTextTagTables as GtkBuildable
The GtkTextTagTable implementation of the GtkBuildable interface
supports adding tags by specifying “tag” as the “type” attribute
of a \<child> element.
An example of a UI definition fragment specifying tags:
>
><object class="GtkTextTagTable">
> <child type="tag">
> <object class="GtkTextTag"/>
> </child>
></object>
-}
#define ENABLE_OVERLOADING (MIN_VERSION_haskell_gi_overloading(1,0,0) \
&& !defined(__HADDOCK_VERSION__))
module GI.Gtk.Objects.TextTagTable
(
-- * Exported types
TextTagTable(..) ,
IsTextTagTable ,
toTextTagTable ,
noTextTagTable ,
-- * Methods
-- ** add #method:add#
#if ENABLE_OVERLOADING
TextTagTableAddMethodInfo ,
#endif
textTagTableAdd ,
-- ** foreach #method:foreach#
#if ENABLE_OVERLOADING
TextTagTableForeachMethodInfo ,
#endif
textTagTableForeach ,
-- ** getSize #method:getSize#
#if ENABLE_OVERLOADING
TextTagTableGetSizeMethodInfo ,
#endif
textTagTableGetSize ,
-- ** lookup #method:lookup#
#if ENABLE_OVERLOADING
TextTagTableLookupMethodInfo ,
#endif
textTagTableLookup ,
-- ** new #method:new#
textTagTableNew ,
-- ** remove #method:remove#
#if ENABLE_OVERLOADING
TextTagTableRemoveMethodInfo ,
#endif
textTagTableRemove ,
-- * Signals
-- ** tagAdded #signal:tagAdded#
C_TextTagTableTagAddedCallback ,
TextTagTableTagAddedCallback ,
#if ENABLE_OVERLOADING
TextTagTableTagAddedSignalInfo ,
#endif
afterTextTagTableTagAdded ,
genClosure_TextTagTableTagAdded ,
mk_TextTagTableTagAddedCallback ,
noTextTagTableTagAddedCallback ,
onTextTagTableTagAdded ,
wrap_TextTagTableTagAddedCallback ,
-- ** tagChanged #signal:tagChanged#
C_TextTagTableTagChangedCallback ,
TextTagTableTagChangedCallback ,
#if ENABLE_OVERLOADING
TextTagTableTagChangedSignalInfo ,
#endif
afterTextTagTableTagChanged ,
genClosure_TextTagTableTagChanged ,
mk_TextTagTableTagChangedCallback ,
noTextTagTableTagChangedCallback ,
onTextTagTableTagChanged ,
wrap_TextTagTableTagChangedCallback ,
-- ** tagRemoved #signal:tagRemoved#
C_TextTagTableTagRemovedCallback ,
TextTagTableTagRemovedCallback ,
#if ENABLE_OVERLOADING
TextTagTableTagRemovedSignalInfo ,
#endif
afterTextTagTableTagRemoved ,
genClosure_TextTagTableTagRemoved ,
mk_TextTagTableTagRemovedCallback ,
noTextTagTableTagRemovedCallback ,
onTextTagTableTagRemoved ,
wrap_TextTagTableTagRemovedCallback ,
) 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.GObject.Objects.Object as GObject.Object
import qualified GI.Gtk.Callbacks as Gtk.Callbacks
import {-# SOURCE #-} qualified GI.Gtk.Interfaces.Buildable as Gtk.Buildable
import {-# SOURCE #-} qualified GI.Gtk.Objects.TextTag as Gtk.TextTag
-- | Memory-managed wrapper type.
newtype TextTagTable = TextTagTable (ManagedPtr TextTagTable)
foreign import ccall "gtk_text_tag_table_get_type"
c_gtk_text_tag_table_get_type :: IO GType
instance GObject TextTagTable where
gobjectType = c_gtk_text_tag_table_get_type
-- | Type class for types which can be safely cast to `TextTagTable`, for instance with `toTextTagTable`.
class (GObject o, O.IsDescendantOf TextTagTable o) => IsTextTagTable o
instance (GObject o, O.IsDescendantOf TextTagTable o) => IsTextTagTable o
instance O.HasParentTypes TextTagTable
type instance O.ParentTypes TextTagTable = '[GObject.Object.Object, Gtk.Buildable.Buildable]
-- | Cast to `TextTagTable`, for types for which this is known to be safe. For general casts, use `Data.GI.Base.ManagedPtr.castTo`.
toTextTagTable :: (MonadIO m, IsTextTagTable o) => o -> m TextTagTable
toTextTagTable = liftIO . unsafeCastTo TextTagTable
-- | A convenience alias for `Nothing` :: `Maybe` `TextTagTable`.
noTextTagTable :: Maybe TextTagTable
noTextTagTable = Nothing
#if ENABLE_OVERLOADING
type family ResolveTextTagTableMethod (t :: Symbol) (o :: *) :: * where
ResolveTextTagTableMethod "add" o = TextTagTableAddMethodInfo
ResolveTextTagTableMethod "addChild" o = Gtk.Buildable.BuildableAddChildMethodInfo
ResolveTextTagTableMethod "bindProperty" o = GObject.Object.ObjectBindPropertyMethodInfo
ResolveTextTagTableMethod "bindPropertyFull" o = GObject.Object.ObjectBindPropertyFullMethodInfo
ResolveTextTagTableMethod "constructChild" o = Gtk.Buildable.BuildableConstructChildMethodInfo
ResolveTextTagTableMethod "customFinished" o = Gtk.Buildable.BuildableCustomFinishedMethodInfo
ResolveTextTagTableMethod "customTagEnd" o = Gtk.Buildable.BuildableCustomTagEndMethodInfo
ResolveTextTagTableMethod "customTagStart" o = Gtk.Buildable.BuildableCustomTagStartMethodInfo
ResolveTextTagTableMethod "forceFloating" o = GObject.Object.ObjectForceFloatingMethodInfo
ResolveTextTagTableMethod "foreach" o = TextTagTableForeachMethodInfo
ResolveTextTagTableMethod "freezeNotify" o = GObject.Object.ObjectFreezeNotifyMethodInfo
ResolveTextTagTableMethod "getv" o = GObject.Object.ObjectGetvMethodInfo
ResolveTextTagTableMethod "isFloating" o = GObject.Object.ObjectIsFloatingMethodInfo
ResolveTextTagTableMethod "lookup" o = TextTagTableLookupMethodInfo
ResolveTextTagTableMethod "notify" o = GObject.Object.ObjectNotifyMethodInfo
ResolveTextTagTableMethod "notifyByPspec" o = GObject.Object.ObjectNotifyByPspecMethodInfo
ResolveTextTagTableMethod "parserFinished" o = Gtk.Buildable.BuildableParserFinishedMethodInfo
ResolveTextTagTableMethod "ref" o = GObject.Object.ObjectRefMethodInfo
ResolveTextTagTableMethod "refSink" o = GObject.Object.ObjectRefSinkMethodInfo
ResolveTextTagTableMethod "remove" o = TextTagTableRemoveMethodInfo
ResolveTextTagTableMethod "runDispose" o = GObject.Object.ObjectRunDisposeMethodInfo
ResolveTextTagTableMethod "stealData" o = GObject.Object.ObjectStealDataMethodInfo
ResolveTextTagTableMethod "stealQdata" o = GObject.Object.ObjectStealQdataMethodInfo
ResolveTextTagTableMethod "thawNotify" o = GObject.Object.ObjectThawNotifyMethodInfo
ResolveTextTagTableMethod "unref" o = GObject.Object.ObjectUnrefMethodInfo
ResolveTextTagTableMethod "watchClosure" o = GObject.Object.ObjectWatchClosureMethodInfo
ResolveTextTagTableMethod "getData" o = GObject.Object.ObjectGetDataMethodInfo
ResolveTextTagTableMethod "getInternalChild" o = Gtk.Buildable.BuildableGetInternalChildMethodInfo
ResolveTextTagTableMethod "getName" o = Gtk.Buildable.BuildableGetNameMethodInfo
ResolveTextTagTableMethod "getProperty" o = GObject.Object.ObjectGetPropertyMethodInfo
ResolveTextTagTableMethod "getQdata" o = GObject.Object.ObjectGetQdataMethodInfo
ResolveTextTagTableMethod "getSize" o = TextTagTableGetSizeMethodInfo
ResolveTextTagTableMethod "setBuildableProperty" o = Gtk.Buildable.BuildableSetBuildablePropertyMethodInfo
ResolveTextTagTableMethod "setData" o = GObject.Object.ObjectSetDataMethodInfo
ResolveTextTagTableMethod "setName" o = Gtk.Buildable.BuildableSetNameMethodInfo
ResolveTextTagTableMethod "setProperty" o = GObject.Object.ObjectSetPropertyMethodInfo
ResolveTextTagTableMethod l o = O.MethodResolutionFailed l o
instance (info ~ ResolveTextTagTableMethod t TextTagTable, O.MethodInfo info TextTagTable p) => OL.IsLabel t (TextTagTable -> 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
-- signal TextTagTable::tag-added
{- |
/No description available in the introspection data./
-}
type TextTagTableTagAddedCallback =
Gtk.TextTag.TextTag
{- ^ /@tag@/: the added tag. -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `TextTagTableTagAddedCallback`@.
noTextTagTableTagAddedCallback :: Maybe TextTagTableTagAddedCallback
noTextTagTableTagAddedCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_TextTagTableTagAddedCallback =
Ptr () -> -- object
Ptr Gtk.TextTag.TextTag ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_TextTagTableTagAddedCallback`.
foreign import ccall "wrapper"
mk_TextTagTableTagAddedCallback :: C_TextTagTableTagAddedCallback -> IO (FunPtr C_TextTagTableTagAddedCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_TextTagTableTagAdded :: MonadIO m => TextTagTableTagAddedCallback -> m (GClosure C_TextTagTableTagAddedCallback)
genClosure_TextTagTableTagAdded cb = liftIO $ do
let cb' = wrap_TextTagTableTagAddedCallback cb
mk_TextTagTableTagAddedCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `TextTagTableTagAddedCallback` into a `C_TextTagTableTagAddedCallback`.
wrap_TextTagTableTagAddedCallback ::
TextTagTableTagAddedCallback ->
C_TextTagTableTagAddedCallback
wrap_TextTagTableTagAddedCallback _cb _ tag _ = do
tag' <- (newObject Gtk.TextTag.TextTag) tag
_cb tag'
{- |
Connect a signal handler for the “@tag-added@” signal, to be run before the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' textTagTable #tagAdded callback
@
-}
onTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId
onTextTagTableTagAdded obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagAddedCallback cb
cb'' <- mk_TextTagTableTagAddedCallback cb'
connectSignalFunPtr obj "tag-added" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@tag-added@” signal, to be run after the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' textTagTable #tagAdded callback
@
-}
afterTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId
afterTextTagTableTagAdded obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagAddedCallback cb
cb'' <- mk_TextTagTableTagAddedCallback cb'
connectSignalFunPtr obj "tag-added" cb'' SignalConnectAfter
-- signal TextTagTable::tag-changed
{- |
/No description available in the introspection data./
-}
type TextTagTableTagChangedCallback =
Gtk.TextTag.TextTag
{- ^ /@tag@/: the changed tag. -}
-> Bool
{- ^ /@sizeChanged@/: whether the change affects the 'GI.Gtk.Objects.TextView.TextView' layout. -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `TextTagTableTagChangedCallback`@.
noTextTagTableTagChangedCallback :: Maybe TextTagTableTagChangedCallback
noTextTagTableTagChangedCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_TextTagTableTagChangedCallback =
Ptr () -> -- object
Ptr Gtk.TextTag.TextTag ->
CInt ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_TextTagTableTagChangedCallback`.
foreign import ccall "wrapper"
mk_TextTagTableTagChangedCallback :: C_TextTagTableTagChangedCallback -> IO (FunPtr C_TextTagTableTagChangedCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_TextTagTableTagChanged :: MonadIO m => TextTagTableTagChangedCallback -> m (GClosure C_TextTagTableTagChangedCallback)
genClosure_TextTagTableTagChanged cb = liftIO $ do
let cb' = wrap_TextTagTableTagChangedCallback cb
mk_TextTagTableTagChangedCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `TextTagTableTagChangedCallback` into a `C_TextTagTableTagChangedCallback`.
wrap_TextTagTableTagChangedCallback ::
TextTagTableTagChangedCallback ->
C_TextTagTableTagChangedCallback
wrap_TextTagTableTagChangedCallback _cb _ tag sizeChanged _ = do
tag' <- (newObject Gtk.TextTag.TextTag) tag
let sizeChanged' = (/= 0) sizeChanged
_cb tag' sizeChanged'
{- |
Connect a signal handler for the “@tag-changed@” signal, to be run before the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' textTagTable #tagChanged callback
@
-}
onTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId
onTextTagTableTagChanged obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagChangedCallback cb
cb'' <- mk_TextTagTableTagChangedCallback cb'
connectSignalFunPtr obj "tag-changed" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@tag-changed@” signal, to be run after the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' textTagTable #tagChanged callback
@
-}
afterTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId
afterTextTagTableTagChanged obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagChangedCallback cb
cb'' <- mk_TextTagTableTagChangedCallback cb'
connectSignalFunPtr obj "tag-changed" cb'' SignalConnectAfter
-- signal TextTagTable::tag-removed
{- |
/No description available in the introspection data./
-}
type TextTagTableTagRemovedCallback =
Gtk.TextTag.TextTag
{- ^ /@tag@/: the removed tag. -}
-> IO ()
-- | A convenience synonym for @`Nothing` :: `Maybe` `TextTagTableTagRemovedCallback`@.
noTextTagTableTagRemovedCallback :: Maybe TextTagTableTagRemovedCallback
noTextTagTableTagRemovedCallback = Nothing
-- | Type for the callback on the (unwrapped) C side.
type C_TextTagTableTagRemovedCallback =
Ptr () -> -- object
Ptr Gtk.TextTag.TextTag ->
Ptr () -> -- user_data
IO ()
-- | Generate a function pointer callable from C code, from a `C_TextTagTableTagRemovedCallback`.
foreign import ccall "wrapper"
mk_TextTagTableTagRemovedCallback :: C_TextTagTableTagRemovedCallback -> IO (FunPtr C_TextTagTableTagRemovedCallback)
-- | Wrap the callback into a `GClosure`.
genClosure_TextTagTableTagRemoved :: MonadIO m => TextTagTableTagRemovedCallback -> m (GClosure C_TextTagTableTagRemovedCallback)
genClosure_TextTagTableTagRemoved cb = liftIO $ do
let cb' = wrap_TextTagTableTagRemovedCallback cb
mk_TextTagTableTagRemovedCallback cb' >>= B.GClosure.newGClosure
-- | Wrap a `TextTagTableTagRemovedCallback` into a `C_TextTagTableTagRemovedCallback`.
wrap_TextTagTableTagRemovedCallback ::
TextTagTableTagRemovedCallback ->
C_TextTagTableTagRemovedCallback
wrap_TextTagTableTagRemovedCallback _cb _ tag _ = do
tag' <- (newObject Gtk.TextTag.TextTag) tag
_cb tag'
{- |
Connect a signal handler for the “@tag-removed@” signal, to be run before the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.on' textTagTable #tagRemoved callback
@
-}
onTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId
onTextTagTableTagRemoved obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagRemovedCallback cb
cb'' <- mk_TextTagTableTagRemovedCallback cb'
connectSignalFunPtr obj "tag-removed" cb'' SignalConnectBefore
{- |
Connect a signal handler for the “@tag-removed@” signal, to be run after the default handler.
When <https://github.com/haskell-gi/haskell-gi/wiki/Overloading overloading> is enabled, this is equivalent to
@
'Data.GI.Base.Signals.after' textTagTable #tagRemoved callback
@
-}
afterTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId
afterTextTagTableTagRemoved obj cb = liftIO $ do
let cb' = wrap_TextTagTableTagRemovedCallback cb
cb'' <- mk_TextTagTableTagRemovedCallback cb'
connectSignalFunPtr obj "tag-removed" cb'' SignalConnectAfter
#if ENABLE_OVERLOADING
instance O.HasAttributeList TextTagTable
type instance O.AttributeList TextTagTable = TextTagTableAttributeList
type TextTagTableAttributeList = ('[ ] :: [(Symbol, *)])
#endif
#if ENABLE_OVERLOADING
#endif
#if ENABLE_OVERLOADING
data TextTagTableTagAddedSignalInfo
instance SignalInfo TextTagTableTagAddedSignalInfo where
type HaskellCallbackType TextTagTableTagAddedSignalInfo = TextTagTableTagAddedCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_TextTagTableTagAddedCallback cb
cb'' <- mk_TextTagTableTagAddedCallback cb'
connectSignalFunPtr obj "tag-added" cb'' connectMode
data TextTagTableTagChangedSignalInfo
instance SignalInfo TextTagTableTagChangedSignalInfo where
type HaskellCallbackType TextTagTableTagChangedSignalInfo = TextTagTableTagChangedCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_TextTagTableTagChangedCallback cb
cb'' <- mk_TextTagTableTagChangedCallback cb'
connectSignalFunPtr obj "tag-changed" cb'' connectMode
data TextTagTableTagRemovedSignalInfo
instance SignalInfo TextTagTableTagRemovedSignalInfo where
type HaskellCallbackType TextTagTableTagRemovedSignalInfo = TextTagTableTagRemovedCallback
connectSignal _ obj cb connectMode = do
let cb' = wrap_TextTagTableTagRemovedCallback cb
cb'' <- mk_TextTagTableTagRemovedCallback cb'
connectSignalFunPtr obj "tag-removed" cb'' connectMode
type instance O.SignalList TextTagTable = TextTagTableSignalList
type TextTagTableSignalList = ('[ '("notify", GObject.Object.ObjectNotifySignalInfo), '("tagAdded", TextTagTableTagAddedSignalInfo), '("tagChanged", TextTagTableTagChangedSignalInfo), '("tagRemoved", TextTagTableTagRemovedSignalInfo)] :: [(Symbol, *)])
#endif
-- method TextTagTable::new
-- method type : Constructor
-- Args : []
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "TextTagTable"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_new" gtk_text_tag_table_new ::
IO (Ptr TextTagTable)
{- |
Creates a new 'GI.Gtk.Objects.TextTagTable.TextTagTable'. The table contains no tags by
default.
-}
textTagTableNew ::
(B.CallStack.HasCallStack, MonadIO m) =>
m TextTagTable
{- ^ __Returns:__ a new 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
textTagTableNew = liftIO $ do
result <- gtk_text_tag_table_new
checkUnexpectedReturnNULL "textTagTableNew" result
result' <- (wrapObject TextTagTable) result
return result'
#if ENABLE_OVERLOADING
#endif
-- method TextTagTable::add
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "table", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTable"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTagTable", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "tag", argType = TInterface (Name {namespace = "Gtk", name = "TextTag"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTag", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TBoolean)
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_add" gtk_text_tag_table_add ::
Ptr TextTagTable -> -- table : TInterface (Name {namespace = "Gtk", name = "TextTagTable"})
Ptr Gtk.TextTag.TextTag -> -- tag : TInterface (Name {namespace = "Gtk", name = "TextTag"})
IO CInt
{- |
Add a tag to the table. The tag is assigned the highest priority
in the table.
/@tag@/ must not be in a tag table already, and may not have
the same name as an already-added tag.
-}
textTagTableAdd ::
(B.CallStack.HasCallStack, MonadIO m, IsTextTagTable a, Gtk.TextTag.IsTextTag b) =>
a
{- ^ /@table@/: a 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
-> b
{- ^ /@tag@/: a 'GI.Gtk.Objects.TextTag.TextTag' -}
-> m Bool
{- ^ __Returns:__ 'True' on success. -}
textTagTableAdd table tag = liftIO $ do
table' <- unsafeManagedPtrCastPtr table
tag' <- unsafeManagedPtrCastPtr tag
result <- gtk_text_tag_table_add table' tag'
let result' = (/= 0) result
touchManagedPtr table
touchManagedPtr tag
return result'
#if ENABLE_OVERLOADING
data TextTagTableAddMethodInfo
instance (signature ~ (b -> m Bool), MonadIO m, IsTextTagTable a, Gtk.TextTag.IsTextTag b) => O.MethodInfo TextTagTableAddMethodInfo a signature where
overloadedMethod _ = textTagTableAdd
#endif
-- method TextTagTable::foreach
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "table", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTable"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTagTable", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "func", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTableForeach"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a function to call on each tag", sinceVersion = Nothing}, argScope = ScopeTypeCall, argClosure = 2, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "data", argType = TBasicType TPtr, direction = DirectionIn, mayBeNull = True, argDoc = Documentation {rawDocText = Just "user data", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_foreach" gtk_text_tag_table_foreach ::
Ptr TextTagTable -> -- table : TInterface (Name {namespace = "Gtk", name = "TextTagTable"})
FunPtr Gtk.Callbacks.C_TextTagTableForeach -> -- func : TInterface (Name {namespace = "Gtk", name = "TextTagTableForeach"})
Ptr () -> -- data : TBasicType TPtr
IO ()
{- |
Calls /@func@/ on each tag in /@table@/, with user data /@data@/.
Note that the table may not be modified while iterating
over it (you can’t add\/remove tags).
-}
textTagTableForeach ::
(B.CallStack.HasCallStack, MonadIO m, IsTextTagTable a) =>
a
{- ^ /@table@/: a 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
-> Gtk.Callbacks.TextTagTableForeach
{- ^ /@func@/: a function to call on each tag -}
-> m ()
textTagTableForeach table func = liftIO $ do
table' <- unsafeManagedPtrCastPtr table
func' <- Gtk.Callbacks.mk_TextTagTableForeach (Gtk.Callbacks.wrap_TextTagTableForeach Nothing (Gtk.Callbacks.drop_closures_TextTagTableForeach func))
let data_ = nullPtr
gtk_text_tag_table_foreach table' func' data_
safeFreeFunPtr $ castFunPtrToPtr func'
touchManagedPtr table
return ()
#if ENABLE_OVERLOADING
data TextTagTableForeachMethodInfo
instance (signature ~ (Gtk.Callbacks.TextTagTableForeach -> m ()), MonadIO m, IsTextTagTable a) => O.MethodInfo TextTagTableForeachMethodInfo a signature where
overloadedMethod _ = textTagTableForeach
#endif
-- method TextTagTable::get_size
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "table", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTable"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTagTable", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TBasicType TInt)
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_get_size" gtk_text_tag_table_get_size ::
Ptr TextTagTable -> -- table : TInterface (Name {namespace = "Gtk", name = "TextTagTable"})
IO Int32
{- |
Returns the size of the table (number of tags)
-}
textTagTableGetSize ::
(B.CallStack.HasCallStack, MonadIO m, IsTextTagTable a) =>
a
{- ^ /@table@/: a 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
-> m Int32
{- ^ __Returns:__ number of tags in /@table@/ -}
textTagTableGetSize table = liftIO $ do
table' <- unsafeManagedPtrCastPtr table
result <- gtk_text_tag_table_get_size table'
touchManagedPtr table
return result
#if ENABLE_OVERLOADING
data TextTagTableGetSizeMethodInfo
instance (signature ~ (m Int32), MonadIO m, IsTextTagTable a) => O.MethodInfo TextTagTableGetSizeMethodInfo a signature where
overloadedMethod _ = textTagTableGetSize
#endif
-- method TextTagTable::lookup
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "table", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTable"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTagTable", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "name", argType = TBasicType TUTF8, direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "name of a tag", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Just (TInterface (Name {namespace = "Gtk", name = "TextTag"}))
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_lookup" gtk_text_tag_table_lookup ::
Ptr TextTagTable -> -- table : TInterface (Name {namespace = "Gtk", name = "TextTagTable"})
CString -> -- name : TBasicType TUTF8
IO (Ptr Gtk.TextTag.TextTag)
{- |
Look up a named tag.
-}
textTagTableLookup ::
(B.CallStack.HasCallStack, MonadIO m, IsTextTagTable a) =>
a
{- ^ /@table@/: a 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
-> T.Text
{- ^ /@name@/: name of a tag -}
-> m (Maybe Gtk.TextTag.TextTag)
{- ^ __Returns:__ The tag, or 'Nothing' if none by that
name is in the table. -}
textTagTableLookup table name = liftIO $ do
table' <- unsafeManagedPtrCastPtr table
name' <- textToCString name
result <- gtk_text_tag_table_lookup table' name'
maybeResult <- convertIfNonNull result $ \result' -> do
result'' <- (newObject Gtk.TextTag.TextTag) result'
return result''
touchManagedPtr table
freeMem name'
return maybeResult
#if ENABLE_OVERLOADING
data TextTagTableLookupMethodInfo
instance (signature ~ (T.Text -> m (Maybe Gtk.TextTag.TextTag)), MonadIO m, IsTextTagTable a) => O.MethodInfo TextTagTableLookupMethodInfo a signature where
overloadedMethod _ = textTagTableLookup
#endif
-- method TextTagTable::remove
-- method type : OrdinaryMethod
-- Args : [Arg {argCName = "table", argType = TInterface (Name {namespace = "Gtk", name = "TextTagTable"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTagTable", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing},Arg {argCName = "tag", argType = TInterface (Name {namespace = "Gtk", name = "TextTag"}), direction = DirectionIn, mayBeNull = False, argDoc = Documentation {rawDocText = Just "a #GtkTextTag", sinceVersion = Nothing}, argScope = ScopeTypeInvalid, argClosure = -1, argDestroy = -1, argCallerAllocates = False, transfer = TransferNothing}]
-- Lengths : []
-- returnType : Nothing
-- throws : False
-- Skip return : False
foreign import ccall "gtk_text_tag_table_remove" gtk_text_tag_table_remove ::
Ptr TextTagTable -> -- table : TInterface (Name {namespace = "Gtk", name = "TextTagTable"})
Ptr Gtk.TextTag.TextTag -> -- tag : TInterface (Name {namespace = "Gtk", name = "TextTag"})
IO ()
{- |
Remove a tag from the table. If a 'GI.Gtk.Objects.TextBuffer.TextBuffer' has /@table@/ as its tag table,
the tag is removed from the buffer. The table’s reference to the tag is
removed, so the tag will end up destroyed if you don’t have a reference to
it.
-}
textTagTableRemove ::
(B.CallStack.HasCallStack, MonadIO m, IsTextTagTable a, Gtk.TextTag.IsTextTag b) =>
a
{- ^ /@table@/: a 'GI.Gtk.Objects.TextTagTable.TextTagTable' -}
-> b
{- ^ /@tag@/: a 'GI.Gtk.Objects.TextTag.TextTag' -}
-> m ()
textTagTableRemove table tag = liftIO $ do
table' <- unsafeManagedPtrCastPtr table
tag' <- unsafeManagedPtrCastPtr tag
gtk_text_tag_table_remove table' tag'
touchManagedPtr table
touchManagedPtr tag
return ()
#if ENABLE_OVERLOADING
data TextTagTableRemoveMethodInfo
instance (signature ~ (b -> m ()), MonadIO m, IsTextTagTable a, Gtk.TextTag.IsTextTag b) => O.MethodInfo TextTagTableRemoveMethodInfo a signature where
overloadedMethod _ = textTagTableRemove
#endif