Package org.gnome.gtk

Class TextTagTable

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.TextTagTable

All Implemented Interfaces:

Proxy, Buildable

@Generated("io.github.jwharm.JavaGI")
public class TextTagTable
extends GObject
implements Buildable

The collection of tags in a GtkTextBuffer

You may wish to begin by reading the text widget conceptual overview, 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>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TextTagTable.Builder<B extends TextTagTable.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	TextTagTable.TagAddedCallback	Functional interface declaration of the TagAddedCallback callback.
static interface	TextTagTable.TagChangedCallback	Functional interface declaration of the TagChangedCallback callback.
static interface	TextTagTable.TagRemovedCallback	Functional interface declaration of the TagRemovedCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Constructor Summary

Constructors

Constructor	Description
TextTagTable()	Creates a new GtkTextTagTable.
TextTagTable(MemorySegment address)	Create a TextTagTable proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
boolean	add(TextTag tag)	Add a tag to the table.
protected TextTagTable	asParent()	Returns this instance as if it were its parent type.
static TextTagTable.Builder<? extends TextTagTable.Builder>	builder()	A TextTagTable.Builder object constructs a TextTagTable with the specified properties.
void	emitTagAdded(TextTag tag)	Emits the "tag-added" signal.
void	emitTagChanged(TextTag tag, boolean sizeChanged)	Emits the "tag-changed" signal.
void	emitTagRemoved(TextTag tag)	Emits the "tag-removed" signal.
void	foreach(TextTagTableForeach func)	Calls func on each tag in this TextTagTable, with user data data.
int	getSize()	Returns the size of the table (number of tags)
static Type	getType()	Get the GType of the TextTagTable class
TextTag	lookup(String name)	Look up a named tag.
SignalConnection<TextTagTable.TagAddedCallback>	onTagAdded(TextTagTable.TagAddedCallback handler)	Emitted every time a new tag is added in the GtkTextTagTable.
SignalConnection<TextTagTable.TagChangedCallback>	onTagChanged(TextTagTable.TagChangedCallback handler)	Emitted every time a tag in the GtkTextTagTable changes.
SignalConnection<TextTagTable.TagRemovedCallback>	onTagRemoved(TextTagTable.TagRemovedCallback handler)	Emitted every time a tag is removed from the GtkTextTagTable.
void	remove(TextTag tag)	Remove a tag from the table.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

TextTagTable

public TextTagTable(MemorySegment address)

Create a TextTagTable proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

TextTagTable

public TextTagTable()

Creates a new GtkTextTagTable.

The table contains no tags by default.

Method Details

getType

public static Type getType()

Get the GType of the TextTagTable class

Returns:

the GType

asParent

protected TextTagTable asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

add

public boolean add(TextTag tag)

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.

Parameters:

tag - a GtkTextTag

Returns:

true on success.

foreach

public void foreach(TextTagTableForeach func)

Calls func on each tag in this TextTagTable, with user data data.

Note that the table may not be modified while iterating over it (you can’t add/remove tags).

Parameters:

func - a function to call on each tag

getSize

public int getSize()

Returns the size of the table (number of tags)

Returns:

number of tags in this TextTagTable

lookup

public TextTag lookup(String name)

Look up a named tag.

Parameters:

name - name of a tag

Returns:

The tag

remove

public void remove(TextTag tag)

Remove a tag from the table.

If a GtkTextBuffer has this TextTagTable 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.

Parameters:

tag - a GtkTextTag

onTagAdded

public SignalConnection<TextTagTable.TagAddedCallback> onTagAdded(TextTagTable.TagAddedCallback handler)

Emitted every time a new tag is added in the GtkTextTagTable.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• TextTagTable.TagAddedCallback.run(org.gnome.gtk.TextTag)

emitTagAdded

public void emitTagAdded(TextTag tag)

Emits the "tag-added" signal. See onTagAdded(org.gnome.gtk.TextTagTable.TagAddedCallback).

onTagChanged

public SignalConnection<TextTagTable.TagChangedCallback> onTagChanged(TextTagTable.TagChangedCallback handler)

Emitted every time a tag in the GtkTextTagTable changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• TextTagTable.TagChangedCallback.run(org.gnome.gtk.TextTag, boolean)

emitTagChanged

public void emitTagChanged(TextTag tag,
 boolean sizeChanged)

Emits the "tag-changed" signal. See onTagChanged(org.gnome.gtk.TextTagTable.TagChangedCallback).

onTagRemoved

public SignalConnection<TextTagTable.TagRemovedCallback> onTagRemoved(TextTagTable.TagRemovedCallback handler)

Emitted every time a tag is removed from the GtkTextTagTable.

The tag is still valid by the time the signal is emitted, but it is not associated with a tag table any more.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• TextTagTable.TagRemovedCallback.run(org.gnome.gtk.TextTag)

emitTagRemoved

public void emitTagRemoved(TextTag tag)

Emits the "tag-removed" signal. See onTagRemoved(org.gnome.gtk.TextTagTable.TagRemovedCallback).

builder

public static TextTagTable.Builder<? extends TextTagTable.Builder> builder()

A TextTagTable.Builder object constructs a TextTagTable with the specified properties. Use the various set...() methods to set properties, and finish construction with TextTagTable.Builder.build().