GI.Gtk.Objects.TextTagTable

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: > >class="GtkTextTagTable" > type="tag" > class="GtkTextTag"/ > /child >/object

Exported types

newtype TextTagTable

Constructors

TextTagTable (ManagedPtr TextTagTable)

Instances

GObject TextTagTable

Methods

gobjectType :: TextTagTable -> IO GType

IsObject TextTagTable

IsTextTagTable TextTagTable

IsBuildable TextTagTable

class GObject o => IsTextTagTable o

Instances

(GObject a, UnknownAncestorError Constraint TextTagTable a) => IsTextTagTable a

IsTextTagTable TextTagTable

toTextTagTable :: (MonadIO m, IsTextTagTable o) => o -> m TextTagTable

noTextTagTable :: Maybe TextTagTable

Methods

add

textTagTableAdd

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b)

=> a

table: a TextTagTable

-> b

tag: a TextTag

-> m Bool

Returns: True on success.

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.

foreach

textTagTableForeach

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a)

=> a

table: a TextTagTable

-> TextTagTableForeach

func: a function to call on each tag

-> m ()

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).

getSize

textTagTableGetSize

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a)

=> a

table: a TextTagTable

-> m Int32

Returns: number of tags in table

Returns the size of the table (number of tags)

lookup

textTagTableLookup

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a)

=> a

table: a TextTagTable

-> Text

name: name of a tag

-> m (Maybe TextTag)

Returns: The tag, or Nothing if none by that name is in the table.

Look up a named tag.

new

textTagTableNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextTagTable

Returns: a new TextTagTable

Creates a new TextTagTable. The table contains no tags by default.

remove

textTagTableRemove

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b)

=> a

table: a TextTagTable

-> b

tag: a TextTag

-> m ()

Remove a tag from the table. If a 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.

Signals

tagAdded

type C_TextTagTableTagAddedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO ()

type TextTagTableTagAddedCallback = TextTag -> IO ()

afterTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId

genClosure_TextTagTableTagAdded :: TextTagTableTagAddedCallback -> IO Closure

mk_TextTagTableTagAddedCallback :: C_TextTagTableTagAddedCallback -> IO (FunPtr C_TextTagTableTagAddedCallback)

noTextTagTableTagAddedCallback :: Maybe TextTagTableTagAddedCallback

onTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId

wrap_TextTagTableTagAddedCallback :: TextTagTableTagAddedCallback -> Ptr () -> Ptr TextTag -> Ptr () -> IO ()

tagChanged

type C_TextTagTableTagChangedCallback = Ptr () -> Ptr TextTag -> CInt -> Ptr () -> IO ()

type TextTagTableTagChangedCallback = TextTag -> Bool -> IO ()

afterTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId

genClosure_TextTagTableTagChanged :: TextTagTableTagChangedCallback -> IO Closure

mk_TextTagTableTagChangedCallback :: C_TextTagTableTagChangedCallback -> IO (FunPtr C_TextTagTableTagChangedCallback)

noTextTagTableTagChangedCallback :: Maybe TextTagTableTagChangedCallback

onTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId

wrap_TextTagTableTagChangedCallback :: TextTagTableTagChangedCallback -> Ptr () -> Ptr TextTag -> CInt -> Ptr () -> IO ()

tagRemoved

type C_TextTagTableTagRemovedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO ()

type TextTagTableTagRemovedCallback = TextTag -> IO ()

afterTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId

genClosure_TextTagTableTagRemoved :: TextTagTableTagRemovedCallback -> IO Closure

mk_TextTagTableTagRemovedCallback :: C_TextTagTableTagRemovedCallback -> IO (FunPtr C_TextTagTableTagRemovedCallback)

noTextTagTableTagRemovedCallback :: Maybe TextTagTableTagRemovedCallback

onTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId

wrap_TextTagTableTagRemovedCallback :: TextTagTableTagRemovedCallback -> Ptr () -> Ptr TextTag -> Ptr () -> IO ()