.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::TextTag 3pm"
.TH Gtk2::TextTag 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Gtk2::TextTag \- wrapper for GtkTextTag
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 2
\&  Glib::Object
\&  +\-\-\-\-Gtk2::TextTag
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "texttag = Gtk2::TextTag\->\fBnew\fP ($name=undef)"
.IX Subsection "texttag = Gtk2::TextTag->new ($name=undef)"
.IP "\(bu" 4
\&\f(CW$name\fR (string or undef)
.ie n .SS "boolean = $tag\->\fBevent\fP ($event_object, $event, $iter)"
.el .SS "boolean = \f(CW$tag\fP\->\fBevent\fP ($event_object, \f(CW$event\fP, \f(CW$iter\fP)"
.IX Subsection "boolean = $tag->event ($event_object, $event, $iter)"
.IP "\(bu" 4
\&\f(CW$event_object\fR (Glib::Object)
.IP "\(bu" 4
\&\f(CW$event\fR (Gtk2::Gdk::Event)
.IP "\(bu" 4
\&\f(CW$iter\fR (Gtk2::TextIter)
.ie n .SS "integer = $tag\->\fBget_priority\fP"
.el .SS "integer = \f(CW$tag\fP\->\fBget_priority\fP"
.IX Subsection "integer = $tag->get_priority"
.ie n .SS "$tag\->\fBset_priority\fP ($priority)"
.el .SS "\f(CW$tag\fP\->\fBset_priority\fP ($priority)"
.IX Subsection "$tag->set_priority ($priority)"
.IP "\(bu" 4
\&\f(CW$priority\fR (integer)
.SH "PROPERTIES"
.IX Header "PROPERTIES"
.IP "'accumulative\-margin' (boolean : default false : readable / writable / private)" 4
.IX Item "'accumulative-margin' (boolean : default false : readable / writable / private)"
Whether left and right margins accumulate.
.IP "'background' (string : default undef : writable / private)" 4
.IX Item "'background' (string : default undef : writable / private)"
Background color as a string
.IP "'background\-full\-height' (boolean : default false : readable / writable / private)" 4
.IX Item "'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
.IP "'background\-full\-height\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'background-full-height-set' (boolean : default false : readable / writable / private)"
Whether this tag affects background height
.IP "'background\-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)" 4
.IX Item "'background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)"
Background color as a (possibly unallocated) GdkColor
.IP "'background\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'background-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the background color
.IP "'background\-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)" 4
.IX Item "'background-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)"
Bitmap to use as a mask when drawing the text background
.IP "'background\-stipple\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'background-stipple-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the background stipple
.ie n .IP "'direction' (Gtk2::TextDirection : default ""none"" : readable / writable / private)" 4
.el .IP "'direction' (Gtk2::TextDirection : default ``none'' : readable / writable / private)" 4
.IX Item "'direction' (Gtk2::TextDirection : default none : readable / writable / private)"
Text direction, e.g. right-to-left or left-to-right
.IP "'editable' (boolean : default true : readable / writable / private)" 4
.IX Item "'editable' (boolean : default true : readable / writable / private)"
Whether the text can be modified by the user
.IP "'editable\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'editable-set' (boolean : default false : readable / writable / private)"
Whether this tag affects text editability
.IP "'family' (string : default undef : readable / writable / private)" 4
.IX Item "'family' (string : default undef : readable / writable / private)"
Name of the font family, e.g. Sans, Helvetica, Times, Monospace
.IP "'family\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'family-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font family
.IP "'font' (string : default undef : readable / writable / private)" 4
.IX Item "'font' (string : default undef : readable / writable / private)"
Font description as a string, e.g. \*(L"Sans Italic 12\*(R"
.IP "'font\-desc' (Pango::FontDescription : default undef : readable / writable / private)" 4
.IX Item "'font-desc' (Pango::FontDescription : default undef : readable / writable / private)"
Font description as a PangoFontDescription struct
.IP "'foreground' (string : default undef : writable / private)" 4
.IX Item "'foreground' (string : default undef : writable / private)"
Foreground color as a string
.IP "'foreground\-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)" 4
.IX Item "'foreground-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)"
Foreground color as a (possibly unallocated) GdkColor
.IP "'foreground\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'foreground-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the foreground color
.IP "'foreground\-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)" 4
.IX Item "'foreground-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private)"
Bitmap to use as a mask when drawing the text foreground
.IP "'foreground\-stipple\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'foreground-stipple-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the foreground stipple
.IP "'indent' (integer : default 0 : readable / writable / private)" 4
.IX Item "'indent' (integer : default 0 : readable / writable / private)"
Amount to indent the paragraph, in pixels
.IP "'indent\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'indent-set' (boolean : default false : readable / writable / private)"
Whether this tag affects indentation
.IP "'invisible' (boolean : default false : readable / writable / private)" 4
.IX Item "'invisible' (boolean : default false : readable / writable / private)"
Whether this text is hidden.
.IP "'invisible\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'invisible-set' (boolean : default false : readable / writable / private)"
Whether this tag affects text visibility
.ie n .IP "'justification' (Gtk2::Justification : default ""left"" : readable / writable / private)" 4
.el .IP "'justification' (Gtk2::Justification : default ``left'' : readable / writable / private)" 4
.IX Item "'justification' (Gtk2::Justification : default left : readable / writable / private)"
Left, right, or center justification
.IP "'justification\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'justification-set' (boolean : default false : readable / writable / private)"
Whether this tag affects paragraph justification
.IP "'language' (string : default undef : readable / writable / private)" 4
.IX Item "'language' (string : default undef : readable / writable / private)"
The language this text is in, as an \s-1ISO\s0 code. Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used.
.IP "'language\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'language-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the language the text is rendered as
.IP "'left\-margin' (integer : default 0 : readable / writable / private)" 4
.IX Item "'left-margin' (integer : default 0 : readable / writable / private)"
Width of the left margin in pixels
.IP "'left\-margin\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'left-margin-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the left margin
.IP "'name' (string : default undef : readable / writable / construct-only / private)" 4
.IX Item "'name' (string : default undef : readable / writable / construct-only / private)"
Name used to refer to the text tag. \s-1NULL\s0 for anonymous tags
.IP "'paragraph\-background' (string : default undef : writable / private)" 4
.IX Item "'paragraph-background' (string : default undef : writable / private)"
Paragraph background color as a string
.IP "'paragraph\-background\-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)" 4
.IX Item "'paragraph-background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)"
Paragraph background color as a (possibly unallocated) GdkColor
.IP "'paragraph\-background\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'paragraph-background-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the paragraph background color
.IP "'pixels\-above\-lines' (integer : default 0 : readable / writable / private)" 4
.IX Item "'pixels-above-lines' (integer : default 0 : readable / writable / private)"
Pixels of blank space above paragraphs
.IP "'pixels\-above\-lines\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'pixels-above-lines-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the number of pixels above lines
.IP "'pixels\-below\-lines' (integer : default 0 : readable / writable / private)" 4
.IX Item "'pixels-below-lines' (integer : default 0 : readable / writable / private)"
Pixels of blank space below paragraphs
.IP "'pixels\-below\-lines\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'pixels-below-lines-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the number of pixels above lines
.IP "'pixels\-inside\-wrap' (integer : default 0 : readable / writable / private)" 4
.IX Item "'pixels-inside-wrap' (integer : default 0 : readable / writable / private)"
Pixels of blank space between wrapped lines in a paragraph
.IP "'pixels\-inside\-wrap\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'pixels-inside-wrap-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the number of pixels between wrapped lines
.IP "'right\-margin' (integer : default 0 : readable / writable / private)" 4
.IX Item "'right-margin' (integer : default 0 : readable / writable / private)"
Width of the right margin in pixels
.IP "'right\-margin\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'right-margin-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the right margin
.IP "'rise' (integer : default 0 : readable / writable / private)" 4
.IX Item "'rise' (integer : default 0 : readable / writable / private)"
Offset of text above the baseline (below the baseline if rise is negative) in Pango units
.IP "'rise\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'rise-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the rise
.IP "'scale' (double : default 1 : readable / writable / private)" 4
.IX Item "'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 \s-1PANGO_SCALE_X_LARGE\s0
.IP "'scale\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'scale-set' (boolean : default false : readable / writable / private)"
Whether this tag scales the font size by a factor
.IP "'size' (integer : default 0 : readable / writable / private)" 4
.IX Item "'size' (integer : default 0 : readable / writable / private)"
Font size in Pango units
.IP "'size\-points' (double : default 0 : readable / writable / private)" 4
.IX Item "'size-points' (double : default 0 : readable / writable / private)"
Font size in points
.IP "'size\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'size-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font size
.ie n .IP "'stretch' (Pango::Stretch : default ""normal"" : readable / writable / private)" 4
.el .IP "'stretch' (Pango::Stretch : default ``normal'' : readable / writable / private)" 4
.IX Item "'stretch' (Pango::Stretch : default normal : readable / writable / private)"
Font stretch as a PangoStretch, e.g. \s-1PANGO_STRETCH_CONDENSED\s0
.IP "'stretch\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'stretch-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font stretch
.IP "'strikethrough' (boolean : default false : readable / writable / private)" 4
.IX Item "'strikethrough' (boolean : default false : readable / writable / private)"
Whether to strike through the text
.IP "'strikethrough\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'strikethrough-set' (boolean : default false : readable / writable / private)"
Whether this tag affects strikethrough
.ie n .IP "'style' (Pango::Style : default ""normal"" : readable / writable / private)" 4
.el .IP "'style' (Pango::Style : default ``normal'' : readable / writable / private)" 4
.IX Item "'style' (Pango::Style : default normal : readable / writable / private)"
Font style as a PangoStyle, e.g. \s-1PANGO_STYLE_ITALIC\s0
.IP "'style\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'style-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font style
.IP "'tabs' (Pango::TabArray : default undef : readable / writable / private)" 4
.IX Item "'tabs' (Pango::TabArray : default undef : readable / writable / private)"
Custom tabs for this text
.IP "'tabs\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'tabs-set' (boolean : default false : readable / writable / private)"
Whether this tag affects tabs
.ie n .IP "'underline' (Pango::Underline : default ""none"" : readable / writable / private)" 4
.el .IP "'underline' (Pango::Underline : default ``none'' : readable / writable / private)" 4
.IX Item "'underline' (Pango::Underline : default none : readable / writable / private)"
Style of underline for this text
.IP "'underline\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'underline-set' (boolean : default false : readable / writable / private)"
Whether this tag affects underlining
.ie n .IP "'variant' (Pango::Variant : default ""normal"" : readable / writable / private)" 4
.el .IP "'variant' (Pango::Variant : default ``normal'' : readable / writable / private)" 4
.IX Item "'variant' (Pango::Variant : default normal : readable / writable / private)"
Font variant as a PangoVariant, e.g. \s-1PANGO_VARIANT_SMALL_CAPS\s0
.IP "'variant\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'variant-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font variant
.IP "'weight' (integer : default 400 : readable / writable / private)" 4
.IX Item "'weight' (integer : default 400 : readable / writable / private)"
Font weight as an integer, see predefined values in PangoWeight; for example, \s-1PANGO_WEIGHT_BOLD\s0
.IP "'weight\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'weight-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the font weight
.ie n .IP "'wrap\-mode' (Gtk2::WrapMode : default ""none"" : readable / writable / private)" 4
.el .IP "'wrap\-mode' (Gtk2::WrapMode : default ``none'' : readable / writable / private)" 4
.IX Item "'wrap-mode' (Gtk2::WrapMode : default none : readable / writable / private)"
Whether to wrap lines never, at word boundaries, or at character boundaries
.IP "'wrap\-mode\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'wrap-mode-set' (boolean : default false : readable / writable / private)"
Whether this tag affects line wrap mode
.SH "SIGNALS"
.IX Header "SIGNALS"
.IP "boolean = \fBevent\fR (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event, Gtk2::TextIter)" 4
.IX Item "boolean = event (Gtk2::TextTag, Glib::Object, Gtk2::Gdk::Event, Gtk2::TextIter)"
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::Justification"
.IX Subsection "enum Gtk2::Justification"
.PD 0
.IP "\(bu" 4
.PD
\&'left' / '\s-1GTK_JUSTIFY_LEFT\s0'
.IP "\(bu" 4
\&'right' / '\s-1GTK_JUSTIFY_RIGHT\s0'
.IP "\(bu" 4
\&'center' / '\s-1GTK_JUSTIFY_CENTER\s0'
.IP "\(bu" 4
\&'fill' / '\s-1GTK_JUSTIFY_FILL\s0'
.SS "enum Gtk2::TextDirection"
.IX Subsection "enum Gtk2::TextDirection"
.IP "\(bu" 4
\&'none' / '\s-1GTK_TEXT_DIR_NONE\s0'
.IP "\(bu" 4
\&'ltr' / '\s-1GTK_TEXT_DIR_LTR\s0'
.IP "\(bu" 4
\&'rtl' / '\s-1GTK_TEXT_DIR_RTL\s0'
.SS "enum Gtk2::WrapMode"
.IX Subsection "enum Gtk2::WrapMode"
.IP "\(bu" 4
\&'none' / '\s-1GTK_WRAP_NONE\s0'
.IP "\(bu" 4
\&'char' / '\s-1GTK_WRAP_CHAR\s0'
.IP "\(bu" 4
\&'word' / '\s-1GTK_WRAP_WORD\s0'
.IP "\(bu" 4
\&'word\-char' / '\s-1GTK_WRAP_WORD_CHAR\s0'
.SS "enum Pango::Stretch"
.IX Subsection "enum Pango::Stretch"
.IP "\(bu" 4
\&'ultra\-condensed' / '\s-1PANGO_STRETCH_ULTRA_CONDENSED\s0'
.IP "\(bu" 4
\&'extra\-condensed' / '\s-1PANGO_STRETCH_EXTRA_CONDENSED\s0'
.IP "\(bu" 4
\&'condensed' / '\s-1PANGO_STRETCH_CONDENSED\s0'
.IP "\(bu" 4
\&'semi\-condensed' / '\s-1PANGO_STRETCH_SEMI_CONDENSED\s0'
.IP "\(bu" 4
\&'normal' / '\s-1PANGO_STRETCH_NORMAL\s0'
.IP "\(bu" 4
\&'semi\-expanded' / '\s-1PANGO_STRETCH_SEMI_EXPANDED\s0'
.IP "\(bu" 4
\&'expanded' / '\s-1PANGO_STRETCH_EXPANDED\s0'
.IP "\(bu" 4
\&'extra\-expanded' / '\s-1PANGO_STRETCH_EXTRA_EXPANDED\s0'
.IP "\(bu" 4
\&'ultra\-expanded' / '\s-1PANGO_STRETCH_ULTRA_EXPANDED\s0'
.SS "enum Pango::Style"
.IX Subsection "enum Pango::Style"
.IP "\(bu" 4
\&'normal' / '\s-1PANGO_STYLE_NORMAL\s0'
.IP "\(bu" 4
\&'oblique' / '\s-1PANGO_STYLE_OBLIQUE\s0'
.IP "\(bu" 4
\&'italic' / '\s-1PANGO_STYLE_ITALIC\s0'
.SS "enum Pango::Underline"
.IX Subsection "enum Pango::Underline"
.IP "\(bu" 4
\&'none' / '\s-1PANGO_UNDERLINE_NONE\s0'
.IP "\(bu" 4
\&'single' / '\s-1PANGO_UNDERLINE_SINGLE\s0'
.IP "\(bu" 4
\&'double' / '\s-1PANGO_UNDERLINE_DOUBLE\s0'
.IP "\(bu" 4
\&'low' / '\s-1PANGO_UNDERLINE_LOW\s0'
.IP "\(bu" 4
\&'error' / '\s-1PANGO_UNDERLINE_ERROR\s0'
.SS "enum Pango::Variant"
.IX Subsection "enum Pango::Variant"
.IP "\(bu" 4
\&'normal' / '\s-1PANGO_VARIANT_NORMAL\s0'
.IP "\(bu" 4
\&'small\-caps' / '\s-1PANGO_VARIANT_SMALL_CAPS\s0'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gtk2 for a full notice.