12.6. Gtk2::TextTags and Gtk2::TextTagTables

12.6.1. Gtk2::TextTags

Gtk2::TextTags can be named or anonymous. A Gtk2::TextTag is created using the function:

texttag = Gtk2::TextTag->new ($name=undef) 
	* $name (string or undef)

If $name is not specified or is undef the tag will be anonymous. Gtk2::TextTags can also be created using the Gtk2::TextBuffer convenience method create_tag which also allows you specify the tag attributes and adds the tag to the buffer's tag table (see Section 12.3).

The attributes that can be contained in a Gtk2::TextTag are:

The attributes can be set by using Glib::Object's set_property method:

$object->set_property (key => $value, ...) 

Where key is a string containing the name of the property and $value is what the property should be set to.

Likewise the attribute value can be retrieved with Glib::Object's method:

list = $object->get_property (...) 

Since the tag does not have a value set for every attribute there are a set of boolean properties that indicate whether the attribute has been set in the tag:

Therefore to obtain the attribute from a tag, you have to first check whether the attribute has been set in the tag. For example to get a valid justification attribute you may have to do something like:

($object->get_property("justification-set"))&&
($justification = $object->get_property("justification")); 

The priority of a tag is by default the order in which they are added to the Gtk2::TextTagTable. The higher priority tag takes precedence if multiple tags try to set the same attribute for a range of text. The priority can be obtained and set with the methods:

integer = $tag->get_priority
 
$tag->set_priority ($priority) 
	* $priority (integer)

The priority of a tag must be between 0 and one less than the Gtk2::TextTagTable size.

12.6.2. Gtk2::TextTagTable

A Gtk2::TextTagTable will be created by default when a Gtk2::TextBuffer is created. A Gtk2::TextTagTable can also be created with the function:

texttagtable = Gtk2::TextTagTable->new 

A Gtk2::TextTag can be added to a Gtk2::TextTagTable using the method:

$table->add ($tag) 
	* $tag (Gtk2::TextTag)

The tag must not be in the table and must not have the same name as another tag in the table.

You can find a Gtk2::TextTag in a Gtk2::TextTagTable using the method:

texttag = $table->lookup ($name) 
	* $name (string)

The method returns the tag in the table with $name or undef if no tag has $name.

A Gtk2::TextTag can be removed from a Gtk2::TextTagTable with the method:

$table->remove ($tag) 
	* $tag (Gtk2::TextTag)

The size of the Gtk2::TextTagTable can be obtained with the method:

integer = $table->get_size