Gtk2::TextTag

Section: User Contributed Perl Documentation (3)
Updated: 2008-05-05
Index Return to Main Contents
 

NAME

Gtk2::TextTag  

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

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

* 'normal' / 'PANGO_STYLE_NORMAL'
* 'oblique' / 'PANGO_STYLE_OBLIQUE'
* 'italic' / 'PANGO_STYLE_ITALIC'
 

enum Gtk2::Pango::Underline

* 'none' / 'PANGO_UNDERLINE_NONE'
* 'single' / 'PANGO_UNDERLINE_SINGLE'
* 'double' / 'PANGO_UNDERLINE_DOUBLE'
* 'low' / 'PANGO_UNDERLINE_LOW'
* 'error' / 'PANGO_UNDERLINE_ERROR'
 

enum Gtk2::Pango::Variant

* 'normal' / 'PANGO_VARIANT_NORMAL'
* 'small-caps' / 'PANGO_VARIANT_SMALL_CAPS'
 

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'
 

SEE ALSO

Gtk2, Glib::Object  

COPYRIGHT

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

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


 

Index

NAME
HIERARCHY
METHODS
texttag = Gtk2::TextTag->new ($name=undef)
boolean = $tag->event ($event_object, $event, $iter)
integer = $tag->get_priority
$tag->set_priority ($priority)
PROPERTIES
SIGNALS
ENUMS AND FLAGS
enum Gtk2::Justification
enum Gtk2::Pango::Stretch
enum Gtk2::Pango::Style
enum Gtk2::Pango::Underline
enum Gtk2::Pango::Variant
enum Gtk2::TextDirection
enum Gtk2::WrapMode
SEE ALSO
COPYRIGHT

linux.jgfs.net manual pages