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

Memory-managed wrapper type.

Constructors

TextTagTable (ManagedPtr TextTagTable)

Instances

GObject TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

Methods

gobjectType :: TextTagTable -> IO GType

IsObject TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

IsBuildable TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

IsTextTagTable TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

class GObject o => IsTextTagTable o

Type class for types which can be safely cast to TextTagTable, for instance with toTextTagTable.

Instances

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

Defined in GI.Gtk.Objects.TextTagTable

IsTextTagTable TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

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

Cast to TextTagTable, for types for which this is known to be safe. For general casts, use castTo.

noTextTagTable :: Maybe TextTagTable

A convenience alias for Nothing :: 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 for the callback on the (unwrapped) C side.

type TextTagTableTagAddedCallback

Arguments

 = TextTag

tag: the added tag.

-> IO ()

No description available in the introspection data.

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

Connect a signal handler for the “tag-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagAdded callback

genClosure_TextTagTableTagAdded :: TextTagTableTagAddedCallback -> IO Closure

Wrap the callback into a Closure.

mk_TextTagTableTagAddedCallback :: C_TextTagTableTagAddedCallback -> IO (FunPtr C_TextTagTableTagAddedCallback)

Generate a function pointer callable from C code, from a C_TextTagTableTagAddedCallback.

noTextTagTableTagAddedCallback :: Maybe TextTagTableTagAddedCallback

A convenience synonym for Nothing :: Maybe TextTagTableTagAddedCallback.

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

Connect a signal handler for the “tag-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagAdded callback

wrap_TextTagTableTagAddedCallback :: TextTagTableTagAddedCallback -> C_TextTagTableTagAddedCallback

Wrap a TextTagTableTagAddedCallback into a C_TextTagTableTagAddedCallback.

tagChanged

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

Type for the callback on the (unwrapped) C side.

type TextTagTableTagChangedCallback

Arguments

 = TextTag

tag: the changed tag.

-> Bool

sizeChanged: whether the change affects the TextView layout.

-> IO ()

No description available in the introspection data.

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

Connect a signal handler for the “tag-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagChanged callback

genClosure_TextTagTableTagChanged :: TextTagTableTagChangedCallback -> IO Closure

Wrap the callback into a Closure.

mk_TextTagTableTagChangedCallback :: C_TextTagTableTagChangedCallback -> IO (FunPtr C_TextTagTableTagChangedCallback)

Generate a function pointer callable from C code, from a C_TextTagTableTagChangedCallback.

noTextTagTableTagChangedCallback :: Maybe TextTagTableTagChangedCallback

A convenience synonym for Nothing :: Maybe TextTagTableTagChangedCallback.

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

Connect a signal handler for the “tag-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagChanged callback

wrap_TextTagTableTagChangedCallback :: TextTagTableTagChangedCallback -> C_TextTagTableTagChangedCallback

Wrap a TextTagTableTagChangedCallback into a C_TextTagTableTagChangedCallback.

tagRemoved

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

Type for the callback on the (unwrapped) C side.

type TextTagTableTagRemovedCallback

Arguments

 = TextTag

tag: the removed tag.

-> IO ()

No description available in the introspection data.

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

Connect a signal handler for the “tag-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagRemoved callback

genClosure_TextTagTableTagRemoved :: TextTagTableTagRemovedCallback -> IO Closure

Wrap the callback into a Closure.

mk_TextTagTableTagRemovedCallback :: C_TextTagTableTagRemovedCallback -> IO (FunPtr C_TextTagTableTagRemovedCallback)

Generate a function pointer callable from C code, from a C_TextTagTableTagRemovedCallback.

noTextTagTableTagRemovedCallback :: Maybe TextTagTableTagRemovedCallback

A convenience synonym for Nothing :: Maybe TextTagTableTagRemovedCallback.

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

Connect a signal handler for the “tag-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagRemoved callback

wrap_TextTagTableTagRemovedCallback :: TextTagTableTagRemovedCallback -> C_TextTagTableTagRemovedCallback

Wrap a TextTagTableTagRemovedCallback into a C_TextTagTableTagRemovedCallback.