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 / static-nick / static-blurb): Whether left and right margins accumulate.
'background' (string : default undef : writable / private / static-nick / static-blurb): Background color as a string
'background-full-height' (boolean : default false : readable / writable / private / static-nick / static-blurb): 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 / static-nick / static-blurb): Whether this tag affects background height
'background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private / static-nick / static-blurb): Background color as a (possibly unallocated) GdkColor
'background-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the background color
'background-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb): Bitmap to use as a mask when drawing the text background
'background-stipple-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the background stipple
'direction' (Gtk2::TextDirection : default "none" : readable / writable / private / static-nick / static-blurb): Text direction, e.g. right-to-left or left-to-right
'editable' (boolean : default true : readable / writable / private / static-nick / static-blurb): Whether the text can be modified by the user
'editable-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects text editability
'family' (string : default undef : readable / writable / private / static-nick / static-blurb): Name of the font family, e.g. Sans, Helvetica, Times, Monospace
'family-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font family
'font' (string : default undef : readable / writable / private / static-nick / static-blurb): Font description as a string, e.g. "Sans Italic 12"
'font-desc' (Pango::FontDescription : default undef : readable / writable / private / static-nick / static-blurb): Font description as a PangoFontDescription struct
'foreground' (string : default undef : writable / private / static-nick / static-blurb): Foreground color as a string
'foreground-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private / static-nick / static-blurb): Foreground color as a (possibly unallocated) GdkColor
'foreground-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the foreground color
'foreground-stipple' (Gtk2::Gdk::Pixmap : default undef : readable / writable / private / static-nick / static-blurb): Bitmap to use as a mask when drawing the text foreground
'foreground-stipple-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the foreground stipple
'indent' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Amount to indent the paragraph, in pixels
'indent-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects indentation
'invisible' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this text is hidden.
'invisible-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects text visibility
'justification' (Gtk2::Justification : default "left" : readable / writable / private / static-nick / static-blurb): Left, right, or center justification
'justification-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects paragraph justification
'language' (string : default undef : readable / writable / private / static-nick / static-blurb): 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 / static-nick / static-blurb): Whether this tag affects the language the text is rendered as
'left-margin' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Width of the left margin in pixels
'left-margin-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the left margin
'name' (string : default undef : readable / writable / construct-only / private / static-nick / static-blurb): Name used to refer to the text tag. NULL for anonymous tags
'paragraph-background' (string : default undef : writable / private / static-nick / static-blurb): Paragraph background color as a string
'paragraph-background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private / static-nick / static-blurb): Paragraph background color as a (possibly unallocated) GdkColor
'paragraph-background-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the paragraph background color
'pixels-above-lines' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Pixels of blank space above paragraphs
'pixels-above-lines-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the number of pixels above lines
'pixels-below-lines' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Pixels of blank space below paragraphs
'pixels-below-lines-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the number of pixels above lines
'pixels-inside-wrap' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Pixels of blank space between wrapped lines in a paragraph
'pixels-inside-wrap-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the number of pixels between wrapped lines
'right-margin' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Width of the right margin in pixels
'right-margin-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the right margin
'rise' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Offset of text above the baseline (below the baseline if rise is negative) in Pango units
'rise-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the rise
'scale' (double : default 1 : readable / writable / private / static-nick / static-blurb): 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 / static-nick / static-blurb): Whether this tag scales the font size by a factor
'size' (integer : default 0 : readable / writable / private / static-nick / static-blurb): Font size in Pango units
'size-points' (double : default 0 : readable / writable / private / static-nick / static-blurb): Font size in points
'size-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font size
'stretch' (Pango::Stretch : default "normal" : readable / writable / private / static-nick / static-blurb): Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED
'stretch-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font stretch
'strikethrough' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether to strike through the text
'strikethrough-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects strikethrough
'style' (Pango::Style : default "normal" : readable / writable / private / static-nick / static-blurb): Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC
'style-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font style
'tabs' (Pango::TabArray : default undef : readable / writable / private / static-nick / static-blurb): Custom tabs for this text
'tabs-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects tabs
'underline' (Pango::Underline : default "none" : readable / writable / private / static-nick / static-blurb): Style of underline for this text
'underline-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects underlining
'variant' (Pango::Variant : default "normal" : readable / writable / private / static-nick / static-blurb): Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS
'variant-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font variant
'weight' (integer : default 400 : readable / writable / private / static-nick / static-blurb): Font weight as an integer, see predefined values in PangoWeight; for example, PANGO_WEIGHT_BOLD
'weight-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): Whether this tag affects the font weight
'wrap-mode' (Gtk2::WrapMode : default "none" : readable / writable / private / static-nick / static-blurb): Whether to wrap lines never, at word boundaries, or at character boundaries
'wrap-mode-set' (boolean : default false : readable / writable / private / static-nick / static-blurb): 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'
'single-line' / 'PANGO_UNDERLINE_SINGLE_LINE'
'double-line' / 'PANGO_UNDERLINE_DOUBLE_LINE'
'error-line' / 'PANGO_UNDERLINE_ERROR_LINE'

enum Pango::Variant

'normal' / 'PANGO_VARIANT_NORMAL'
'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
'all-small-caps' / 'PANGO_VARIANT_ALL_SMALL_CAPS'
'petite-caps' / 'PANGO_VARIANT_PETITE_CAPS'
'all-petite-caps' / 'PANGO_VARIANT_ALL_PETITE_CAPS'
'unicase' / 'PANGO_VARIANT_UNICASE'
'title-caps' / 'PANGO_VARIANT_TITLE_CAPS'

COPYRIGHT

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