---
name: "Gtk2::TextTag"
section: "3pm"
platform: "linux"
package: "libgtk2-perl-doc"
version: "2:1.24992-1"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/Gtk2::TextTag"
---

# Gtk2::TextTag(3pm)

wrapper for GtkTextTag

## NAME

Gtk2::TextTag - wrapper for GtkTextTag

## HIERARCHY

```
  Glib::Object
  +----Gtk2::TextTag
```

## METHODS

### texttag = Gtk2::TextTag-\>new ($name=undef)

- •

  `$name` (string or undef)

### boolean = $tag-\>event ($event\_object, $event, $iter)

- •

  `$event_object` (Glib::Object)

- •

  `$event` (Gtk2::Gdk::Event)

- •

  `$iter` (Gtk2::TextIter)

### integer = $tag-\>get\_priority

### $tag-\>set\_priority ($priority)

- •

  `$priority` (integer)

## PROPERTIES

- 'accumulative-margin' (boolean : default false : readable / writable / private)

  Whether left and right margins accumulate.

- 'background' (string : default undef : writable / private)

  Background color as a string

- 'background-full-height' (boolean : default false : readable / writable / private)

  Whether the background color fills the entire line height or only the height of the tagged characters

- 'background-full-height-set' (boolean : default false : readable / writable / private)

  Whether this tag affects background height

- 'background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)

  Background color as a (possibly unallocated) GdkColor

- 'background-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the background color

- 'background-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)

  Bitmap to use as a mask when drawing the text background

- 'background-stipple-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the background stipple

- 'direction' (Gtk2::TextDirection : default "none" : readable / writable / private)

  Text direction, e.g. right-to-left or left-to-right

- 'editable' (boolean : default true : readable / writable / private)

  Whether the text can be modified by the user

- 'editable-set' (boolean : default false : readable / writable / private)

  Whether this tag affects text editability

- 'family' (string : default undef : readable / writable / private)

  Name of the font family, e.g. Sans, Helvetica, Times, Monospace

- 'family-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font family

- 'font' (string : default undef : readable / writable / private)

  Font description as a string, e.g. "Sans Italic 12"

- 'font-desc' (Pango::FontDescription : default undef : readable / writable / private)

  Font description as a PangoFontDescription struct

- 'foreground' (string : default undef : writable / private)

  Foreground color as a string

- 'foreground-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)

  Foreground color as a (possibly unallocated) GdkColor

- 'foreground-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the foreground color

- 'foreground-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)

  Bitmap to use as a mask when drawing the text foreground

- 'foreground-stipple-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the foreground stipple

- 'indent' (integer : default 0 : readable / writable / private)

  Amount to indent the paragraph, in pixels

- 'indent-set' (boolean : default false : readable / writable / private)

  Whether this tag affects indentation

- 'invisible' (boolean : default false : readable / writable / private)

  Whether this text is hidden.

- 'invisible-set' (boolean : default false : readable / writable / private)

  Whether this tag affects text visibility

- 'justification' (Gtk2::Justification : default "left" : readable / writable / private)

  Left, right, or center justification

- 'justification-set' (boolean : default false : readable / writable / private)

  Whether this tag affects paragraph justification

- 'language' (string : default undef : readable / writable / private)

  The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used.

- 'language-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the language the text is rendered as

- 'left-margin' (integer : default 0 : readable / writable / private)

  Width of the left margin in pixels

- 'left-margin-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the left margin

- 'name' (string : default undef : readable / writable / construct-only / private)

  Name used to refer to the text tag. NULL for anonymous tags

- 'paragraph-background' (string : default undef : writable / private)

  Paragraph background color as a string

- 'paragraph-background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)

  Paragraph background color as a (possibly unallocated) GdkColor

- 'paragraph-background-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the paragraph background color

- 'pixels-above-lines' (integer : default 0 : readable / writable / private)

  Pixels of blank space above paragraphs

- 'pixels-above-lines-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the number of pixels above lines

- 'pixels-below-lines' (integer : default 0 : readable / writable / private)

  Pixels of blank space below paragraphs

- 'pixels-below-lines-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the number of pixels above lines

- 'pixels-inside-wrap' (integer : default 0 : readable / writable / private)

  Pixels of blank space between wrapped lines in a paragraph

- 'pixels-inside-wrap-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the number of pixels between wrapped lines

- 'right-margin' (integer : default 0 : readable / writable / private)

  Width of the right margin in pixels

- 'right-margin-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the right margin

- 'rise' (integer : default 0 : readable / writable / private)

  Offset of text above the baseline (below the baseline if rise is negative) in Pango units

- 'rise-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the rise

- 'scale' (double : default 1 : readable / writable / private)

  Font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Pango predefines some scales such as PANGO\_SCALE\_X\_LARGE

- 'scale-set' (boolean : default false : readable / writable / private)

  Whether this tag scales the font size by a factor

- 'size' (integer : default 0 : readable / writable / private)

  Font size in Pango units

- 'size-points' (double : default 0 : readable / writable / private)

  Font size in points

- 'size-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font size

- 'stretch' (Pango::Stretch : default "normal" : readable / writable / private)

  Font stretch as a PangoStretch, e.g. PANGO\_STRETCH\_CONDENSED

- 'stretch-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font stretch

- 'strikethrough' (boolean : default false : readable / writable / private)

  Whether to strike through the text

- 'strikethrough-set' (boolean : default false : readable / writable / private)

  Whether this tag affects strikethrough

- 'style' (Pango::Style : default "normal" : readable / writable / private)

  Font style as a PangoStyle, e.g. PANGO\_STYLE\_ITALIC

- 'style-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font style

- 'tabs' (Pango::TabArray : default undef : readable / writable / private)

  Custom tabs for this text

- 'tabs-set' (boolean : default false : readable / writable / private)

  Whether this tag affects tabs

- 'underline' (Pango::Underline : default "none" : readable / writable / private)

  Style of underline for this text

- 'underline-set' (boolean : default false : readable / writable / private)

  Whether this tag affects underlining

- 'variant' (Pango::Variant : default "normal" : readable / writable / private)

  Font variant as a PangoVariant, e.g. PANGO\_VARIANT\_SMALL\_CAPS

- 'variant-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font variant

- 'weight' (integer : default 400 : readable / writable / private)

  Font weight as an integer, see predefined values in PangoWeight; for example, PANGO\_WEIGHT\_BOLD

- 'weight-set' (boolean : default false : readable / writable / private)

  Whether this tag affects the font weight

- 'wrap-mode' (Gtk2::WrapMode : default "none" : readable / writable / private)

  Whether to wrap lines never, at word boundaries, or at character boundaries

- 'wrap-mode-set' (boolean : default false : readable / writable / private)

  Whether this tag affects line wrap mode

## SIGNALS

- boolean = **event** (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event, Gtk2::TextIter)

  ## ENUMS AND FLAGS

### enum Gtk2::Justification

- •

  'left' / 'GTK\_JUSTIFY\_LEFT'

- •

  'right' / 'GTK\_JUSTIFY\_RIGHT'

- •

  'center' / 'GTK\_JUSTIFY\_CENTER'

- •

  'fill' / 'GTK\_JUSTIFY\_FILL'

### enum Gtk2::TextDirection

- •

  'none' / 'GTK\_TEXT\_DIR\_NONE'

- •

  'ltr' / 'GTK\_TEXT\_DIR\_LTR'

- •

  'rtl' / 'GTK\_TEXT\_DIR\_RTL'

### enum Gtk2::WrapMode

- •

  'none' / 'GTK\_WRAP\_NONE'

- •

  'char' / 'GTK\_WRAP\_CHAR'

- •

  'word' / 'GTK\_WRAP\_WORD'

- •

  'word-char' / 'GTK\_WRAP\_WORD\_CHAR'

### enum Pango::Stretch

- •

  'ultra-condensed' / 'PANGO\_STRETCH\_ULTRA\_CONDENSED'

- •

  'extra-condensed' / 'PANGO\_STRETCH\_EXTRA\_CONDENSED'

- •

  'condensed' / 'PANGO\_STRETCH\_CONDENSED'

- •

  'semi-condensed' / 'PANGO\_STRETCH\_SEMI\_CONDENSED'

- •

  'normal' / 'PANGO\_STRETCH\_NORMAL'

- •

  'semi-expanded' / 'PANGO\_STRETCH\_SEMI\_EXPANDED'

- •

  'expanded' / 'PANGO\_STRETCH\_EXPANDED'

- •

  'extra-expanded' / 'PANGO\_STRETCH\_EXTRA\_EXPANDED'

- •

  'ultra-expanded' / 'PANGO\_STRETCH\_ULTRA\_EXPANDED'

### enum Pango::Style

- •

  'normal' / 'PANGO\_STYLE\_NORMAL'

- •

  'oblique' / 'PANGO\_STYLE\_OBLIQUE'

- •

  'italic' / 'PANGO\_STYLE\_ITALIC'

### enum Pango::Underline

- •

  'none' / 'PANGO\_UNDERLINE\_NONE'

- •

  'single' / 'PANGO\_UNDERLINE\_SINGLE'

- •

  'double' / 'PANGO\_UNDERLINE\_DOUBLE'

- •

  'low' / 'PANGO\_UNDERLINE\_LOW'

- •

  'error' / 'PANGO\_UNDERLINE\_ERROR'

### enum Pango::Variant

- •

  'normal' / 'PANGO\_VARIANT\_NORMAL'

- •

  'small-caps' / 'PANGO\_VARIANT\_SMALL\_CAPS'

## SEE ALSO

Gtk2, Glib::Object

## COPYRIGHT

Copyright (C) 2003-2011 by the gtk2-perl team.

This software is licensed under the LGPL.  See Gtk2 for a full notice.