
@c %start of fragment

@deftp Class <gtk-text-tag>
Derives from @code{<gobject>}.

This class defines the following properties:

@table @code
@item name
Name used to refer to the text tag. NULL for anonymous tags

@item background
Background color as a string

@item foreground
Foreground color as a string

@item background-gdk
Background color as a (possibly unallocated) GdkColor

@item foreground-gdk
Foreground color as a (possibly unallocated) GdkColor

@item background-stipple
Bitmap to use as a mask when drawing the text background

@item foreground-stipple
Bitmap to use as a mask when drawing the text foreground

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

@item font-desc
Font description as a PangoFontDescription struct

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

@item style
Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC

@item variant
Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS

@item weight
Font weight as an integer, see predefined values in PangoWeight; for example,
PANGO_WEIGHT_BOLD

@item stretch
Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED

@item size
Font size in Pango units

@item size-points
Font size in points

@item scale
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

@item pixels-above-lines
Pixels of blank space above paragraphs

@item pixels-below-lines
Pixels of blank space below paragraphs

@item pixels-inside-wrap
Pixels of blank space between wrapped lines in a paragraph

@item editable
Whether the text can be modified by the user

@item wrap-mode
Whether to wrap lines never, at word boundaries, or at character boundaries

@item justification
Left, right, or center justification

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

@item left-margin
Width of the left margin in pixels

@item indent
Amount to indent the paragraph, in pixels

@item strikethrough
Whether to strike through the text

@item right-margin
Width of the right margin in pixels

@item underline
Style of underline for this text

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

@item background-full-height
Whether the background color fills the entire line height or only the height of
the tagged characters

@item language
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.

@item tabs
Custom tabs for this text

@item invisible
Whether this text is hidden.

@item paragraph-background
Paragraph background color as a string

@item paragraph-background-gdk
Paragraph background color as a (possibly unallocated) GdkColor

@item accumulative-margin
Whether left and right margins accumulate.

@item background-set
Whether this tag affects the background color

@item foreground-set
Whether this tag affects the foreground color

@item background-stipple-set
Whether this tag affects the background stipple

@item foreground-stipple-set
Whether this tag affects the foreground stipple

@item family-set
Whether this tag affects the font family

@item style-set
Whether this tag affects the font style

@item variant-set
Whether this tag affects the font variant

@item weight-set
Whether this tag affects the font weight

@item stretch-set
Whether this tag affects the font stretch

@item size-set
Whether this tag affects the font size

@item scale-set
Whether this tag scales the font size by a factor

@item pixels-above-lines-set
Whether this tag affects the number of pixels above lines

@item pixels-below-lines-set
Whether this tag affects the number of pixels above lines

@item pixels-inside-wrap-set
Whether this tag affects the number of pixels between wrapped lines

@item editable-set
Whether this tag affects text editability

@item wrap-mode-set
Whether this tag affects line wrap mode

@item justification-set
Whether this tag affects paragraph justification

@item left-margin-set
Whether this tag affects the left margin

@item indent-set
Whether this tag affects indentation

@item strikethrough-set
Whether this tag affects strikethrough

@item right-margin-set
Whether this tag affects the right margin

@item underline-set
Whether this tag affects underlining

@item rise-set
Whether this tag affects the rise

@item background-full-height-set
Whether this tag affects background height

@item language-set
Whether this tag affects the language the text is rendered as

@item tabs-set
Whether this tag affects tabs

@item invisible-set
Whether this tag affects text visibility

@item paragraph-background-set
Whether this tag affects the paragraph background color

@end table

@end deftp

@defop Signal <gtk-text-tag> event  (arg0@tie{}@code{<gobject>}) (arg1@tie{}@code{<gdk-event>}) (arg2@tie{}@code{<gtk-text-iter>}) @result{}@tie{}@code{<gboolean>}
@end defop

@deftp Class <gtk-text-attributes>
Derives from @code{<gboxed>}.

@end deftp

@deffn Function gtk-text-tag-new  (name@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-text-tag>})
Creates a @code{<gtk-text-tag>}. Configure the tag using object arguments, i.e.
using @code{g-object-set}.

@table @var
@item name
tag name, or @samp{@code{#f}}

@item ret
a new @code{<gtk-text-tag>}

@end table

@end deffn

@deffn Function gtk-text-tag-get-priority  (self@tie{}@code{<gtk-text-tag>}) @result{}@tie{} (ret@tie{}@code{int})
@deffnx Method get-priority
Get the tag priority.

@table @var
@item tag
a @code{<gtk-text-tag>}

@item ret
The tag's priority.

@end table

@end deffn

@deffn Function gtk-text-tag-set-priority  (self@tie{}@code{<gtk-text-tag>}) (priority@tie{}@code{int})
@deffnx Method set-priority
Sets the priority of a @code{<gtk-text-tag>}. Valid priorities are start at 0
and go to one less than @code{gtk-text-tag-table-get-size}. Each tag in a table
has a unique priority; setting the priority of one tag shifts the priorities of
all the other tags in the table to maintain a unique priority for each tag.
Higher priority tags "win" if two tags both set the same text attribute. When
adding a tag to a tag table, it will be assigned the highest priority in the
table by default; so normally the precedence of a set of tags is the order in
which they were added to the table, or created with
@code{gtk-text-buffer-create-tag}, which adds the tag to the buffer's table
automatically.

@table @var
@item tag
a @code{<gtk-text-tag>}

@item priority
the new priority

@end table

@end deffn

@deffn Function gtk-text-tag-event  (self@tie{}@code{<gtk-text-tag>}) (event_object@tie{}@code{<gobject>}) (event@tie{}@code{<gdk-event>}) (iter@tie{}@code{<gtk-text-iter>}) @result{}@tie{} (ret@tie{}@code{bool})
@deffnx Method event
Emits the "event" signal on the @code{<gtk-text-tag>}.

@table @var
@item tag
a @code{<gtk-text-tag>}

@item event-object
object that received the event, such as a widget

@item event
the event

@item iter
location where the event was received

@item ret
result of signal emission (whether the event was handled)

@end table

@end deffn

@deffn Function gtk-text-attributes-new  @result{}@tie{} (ret@tie{}@code{<gtk-text-attributes>})
Creates a @code{<gtk-text-attributes>}, which describes a set of properties on
some text.

@table @var
@item ret
a new @code{<gtk-text-attributes>}

@end table

@end deffn

@deffn Function gtk-text-attributes-copy  (self@tie{}@code{<gtk-text-attributes>}) @result{}@tie{} (ret@tie{}@code{<gtk-text-attributes>})
Copies @var{src} and returns a new @code{<gtk-text-attributes>}.

@table @var
@item src
a @code{<gtk-text-attributes>} to be copied

@item ret
a copy of @var{src}

@end table

@end deffn

@deffn Function gtk-text-attributes-copy-values  (self@tie{}@code{<gtk-text-attributes>}) (dest@tie{}@code{<gtk-text-attributes>})
Copies the values from @var{src} to @var{dest} so that @var{dest} has the same
values as @var{src}. Frees existing values in @var{dest}.

@table @var
@item src
a @code{<gtk-text-attributes>}

@item dest
another @code{<gtk-text-attributes>}

@end table

@end deffn


@c %end of fragment
