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:

xml code

<object class="GtkTextTagTable">
 <child type="tag">
   <object class="GtkTextTag"/>
 </child>
</object>

Exported types

newtype TextTagTable

Memory-managed wrapper type.

Constructors

TextTagTable (ManagedPtr TextTagTable)

Instances

Eq TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

Methods

(==) :: TextTagTable -> TextTagTable -> Bool

(/=) :: TextTagTable -> TextTagTable -> Bool

GObject TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

ManagedPtrNewtype TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

Methods

toManagedPtr :: TextTagTable -> ManagedPtr TextTagTable

TypedObject TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

Methods

glibType :: IO GType

HasParentTypes TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

IsGValue (Maybe TextTagTable)

Convert TextTagTable to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.TextTagTable

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TextTagTable -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TextTagTable)

type ParentTypes TextTagTable

Defined in GI.Gtk.Objects.TextTagTable

type ParentTypes TextTagTable = '[Object, Buildable]

class (GObject o, IsDescendantOf TextTagTable o) => IsTextTagTable o

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

Instances

(GObject o, IsDescendantOf TextTagTable o) => IsTextTagTable o

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.

Methods

Click to display all available methods, including inherited ones

Methods

add, addChild, bindProperty, bindPropertyFull, constructChild, customFinished, customTagEnd, customTagStart, forceFloating, foreach, freezeNotify, getv, isFloating, lookup, notify, notifyByPspec, parserFinished, ref, refSink, remove, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getInternalChild, getName, getProperty, getQdata, getSize.

Setters

setBuildableProperty, setData, setDataFull, setName, setProperty.

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 TextTagTableTagAddedCallback

Arguments

 = TextTag

tag: the added tag.

-> IO ()

No description available in the introspection data.

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

Connect a signal handler for the tagAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagAdded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

Connect a signal handler for the tagAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagAdded callback

tagChanged

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 -> ((?self :: a) => TextTagTableTagChangedCallback) -> m SignalHandlerId

Connect a signal handler for the tagChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

Connect a signal handler for the tagChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagChanged callback

tagRemoved

type TextTagTableTagRemovedCallback

Arguments

 = TextTag

tag: the removed tag.

-> IO ()

No description available in the introspection data.

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

Connect a signal handler for the tagRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagRemoved callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

Connect a signal handler for the tagRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagRemoved callback