Class gtk-text-tag

Package: gtk

Superclasses

g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

accumulative-margin

The accumulative-margin property of type :boolean (Read / Write)
Whether the margins accumulate or override each other. When set to true the margins of this tag are added to the margins of any other non-accumulative margins present. When set to false the margins override one another (the default).
Default value: false

background

The background property of type :string (Write)
Background color as a string.
Default value: nil

background-full-height

The background-full-height property of type :boolean (Read / Write)
Whether the background color fills the entire line height or only the height of the tagged characters.
Default value: false

background-full-height-set

The background-full-height-set property of type :boolean (Read / Write)
Whether this tag affects background height.
Default value: false

background-gdk

The background-gdk property of type gdk-color (Read / Write)
The background color.
Warning: The background-gdk property has been deprecated since version 3.4 and should not be used in newly written code. Use the background-rgba property instead.

background-rgba

The background-rgba property of type gdk-rgba (Read / Write)
The background color.

background-set

The background-set property of type :boolean (Read / Write)
Whether this tag affects the background color.
Default value: false

direction

The direction property of type gtk-text-direction (Read / Write)
Text direction, e.g. the :ltr value for left-to-right.
Default value: :none

editable

The editable property of type :boolean (Read / Write)
Whether the text can be modified by the user.
Default value: true

editable-set

The editable-set property of type :boolean (Read / Write)
Whether this tag affects text editability.
Default value: false

fallback

The fallback property of type :boolean (Read / Write)
Whether font fallback is enabled. When set to true, other fonts will be substituted where the current font is missing glyphs.
Default value: true

fallback-set

The fallback-set property of type :boolean (Read / Write)
Whether this tag affects font fallback.
Default value: false

family

The family property of type :string (Read / Write)
Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
Default value: nil

family-set

The family-set property of type :boolean (Read / Write)
Whether this tag affects the font family.
Default value: false

font

The font property of type :string (Read / Write)
Font description as string, e.g. "Sans Italic 12". Note that the initial value of this property depends on the internals of the pango-font-description structure.
Default value: nil

font-desc

The font-desc property of type pango-font-description (Read / Write)
Font description as a Pango font description.

font-features

The font-features property of type :string (Read / Write)
OpenType font features, as a string. Since 3.18
Default value: nil

font-features-set

The font-features-set property of type :boolean (Read / Write)
Whether this tag affects font features. Since 3.18
Default value: false

foreground

The foreground property of type :string (Write)
Foreground color as a string.
Default value: nil

foreground-gdk

The foreground-gdk property of type gdk-color (Read / Write)
The foreground color.
Warning: The foreground-gdk property has been deprecated since version 3.4 and should not be used in newly written code. Use the foreground-rgba property instead.

foreground-rgba

The foreground-rgba property of type gdk-rgba (Read / Write)
The foreground color.

foreground-set

The foreground-set property of type :boolean (Read / Write)
Whether this tag affects the foreground color.
Default value: false

indent

The indent property of type :int (Read / Write)
Amount to indent the paragraph, in pixels.
Default value: 0

indent-set

The indent-set property of type :boolean (Read / Write)
Whether this tag affects indentation.
Default value: false

invisible

The invisible property of type :boolean (Read / Write)
Whether this text is hidden. Note that there may still be problems with the support for invisible text, in particular when navigating programmatically inside a text buffer containing invisible segments.
Default value: false

invisible-set

The invisible-set property of type :boolean (Read / Write)
Whether this tag affects text visibility.
Default value: false

justification

The justification property of type gtk-justification (Read / Write)
Left, right, or center justification.
Default value: :left

justification-set

The justification-set property of type :boolean (Read / Write)
Whether this tag affects paragraph justification.
Default value: false

language

The language property of type :string (Read / Write)
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. Note that the initial value of this property depends on the current locale, see also the gtk-default-language function.
Default value: nil

language-set

The language-set property of type :boolean (Read / Write)
Whether this tag affects the language the text is rendered as.
Default value: false

left-margin

The left-margin property of type :int (Read / Write)
Width of the left margin in pixels.
Allowed values: >= 0
Default value: 0

left-margin-set

The left-margin-set property of type :boolean (Read / Write)
Whether this tag affects the left margin.
Default value: false

letter-spacing

The letter-spacing property of type :int (Read / Write)
Extra spacing between graphemes, in Pango units.
Allowed values: >= 0
Default value: 0

letter-spacing-set

The letter-spacing-set property of type :boolean (Read / Write)
Whether this tag affects letter spacing.
Default value: false

name

The name property of type :string (Read / Write / Construct)
Name used to refer to the text tag, nil for anonymous tags.
Default value: nil

paragraph-background

The paragraph-background property of type :string (Write)
The paragraph background color as a string.
Default value: nil

paragraph-background-gdk

The paragraph-background-gdk property of type gdk-color (Read / Write)
The paragraph background color as a as a gdk-color.
Warning: The paragraph-background-gdk property has been deprecated since version 3.4 and should not be used in newly written code. Use the paragraph-background-rgba property instead.

paragraph-background-rgba

The paragraph-background-rgba property of type gdk-rgba (Read / Write)
The paragraph background color.

paragraph-background-set

The paragraph-background-set property of type :boolean (Read / Write)
Whether this tag affects the paragraph background color.
Default value: false

pixels-above-lines

The pixels-above-lines property of type :int (Read / Write)
Pixels of blank space above paragraphs.
Allowed values: >= 0
Default value: 0

pixels-above-lines-set

The pixels-above-lines-set property of type :boolean (Read / Write)
Whether this tag affects the number of pixels above lines.
Default value: false

pixels-below-lines

The pixels-below-lines property of type :int (Read / Write)
Pixels of blank space below paragraphs.
Allowed values: >= 0
Default value: 0

pixels-below-lines-set

The pixels-below-lines-set property of type :boolean (Read / Write)
Whether this tag affects the number of pixels below lines.
Default value: false

pixels-inside-wrap

The pixels-inside-wrap property of type :int (Read / Write)
Pixels of blank space between wrapped lines in a paragraph.
Allowed values: >= 0
Default value: 0

pixels-inside-wrap-set

The pixels-inside-wrap-set property of type :boolean (Read / Write)
Whether this tag affects the number of pixels between wrapped lines.
Default value: false

right-margin

The right-margin property of type :int (Read / Write)
Width of the right margin in pixels.
Allowed values: >= 0
Default value: 0

right-margin-set

The right-margin-set property of type :boolean Read / Write)
Whether this tag affects the right margin.
Default value: false

rise

The rise property of type :int (Read / Write)
Offset of text above the baseline (below the baseline if rise is negative) in Pango units.
Default value: 0

rise-set

The rise-set property of type :boolean (Read / Write)
Whether this tag affects the rise.
Default value: false

scale

The scale property of type :double (Read / Write)
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 the +pango-scale-x-large+ value.
Allowed values: >= 0
Default value: 1

scale-set

The scale-set property of type :boolean (Read / Write)
Whether this tag scales the font size by a factor.
Default value: false

size

The size property of type :int (Read / Write)
Font size in Pango units.
Allowed values: >= 0
Default value: 0

size-points

The size-points property of type :double (Read / Write)
Font size in points.
Allowed values: >= 0
Default value: 0

size-set

The size-set property of type :boolean (Read / Write)
Whether this tag affects the font size.
Default value: false

stretch

The stretch property of type pango-stretch (Read / Write)
Font stretch, e.g. the :condensed value.
Default value: :normal

stretch-set

The stretch-set property of type :boolean (Read / Write)
Whether this tag affects the font stretch.
Default value: false

strikethrough

The strikethrough property of type :boolean (Read / Write)
Whether to strike through the text.
Default value: false

strikethrough-rgba

The strikethrough-rgba property of type gdk-rgba (Read / Write)
This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.

strikethrough-rgba-set

The strikethrough-rgba-set property of type :boolean (Read / Write)
If the strikethrough-rgba property has been set.
Default value: false

strikethrough-set

The strikethrough-set property of type :boolean (Read / Write)
Whether this tag affects strikethrough.
Default value: false

style

The style property of type pango-style (Read / Write)
Font style, e.g. the :italic value.
Default value: :normal

style-set

The style-set property of type :boolean (Read / Write)
Whether this tag affects the font style.
Default value: false

tabs

The tabs property of type pango-tab-array (Read / Write)
Custom tabs for this text.

tabs-set

The tabs-set property of type :boolean (Read / Write)
Whether this tag affects tabs.
Default value: false

underline

The underline property of type pango-underline (Read / Write)
Style of underline for this text.
Default value: :none

underline-rgba

The underline-rgba property of type gdk-rgba (Read / Write)
This property modifies the color of underlines. If not set, underlines will use the forground color. If the underline property is set to the :error value of the pango-underline enumeration, an alternate color may be applied instead of the foreground. Setting this property will always override those defaults.

underline-rgba-set

The underline-rgba-set property of type :boolean (Read / Write)
If the underline-rgba property has been set.
Default value: false

underline-set

The underline-set property of type :boolean (Read / Write)
Whether this tag affects underlining.
Default value: false

variant

The variant property of type pango-variant (Read / Write)
Font variant, e.g. the :small-caps value.
Default value: :normal

variant-set

The variant-set property of type :boolean (Read / Write)
Whether this tag affects the font variant.
Default value: false

weight

The weight property of type :int (Read / Write)
Font weight as an integer, see predefined values in the pango-weight enumeration, for example, the :bold value.
Allowed values: >= 0
Default value: 400

weight-set

The weight-set property of type :boolean (Read / Write)
Whether this tag affects the font weight.
Default value: false

wrap-mode

The wrap-mode property of type gtk-wrap-mode (Read / Write)
Whether to wrap lines never, at word boundaries, or at character boundaries.
Default value: :none

wrap-mode-set

The wrap-mode-set property of type :boolean (Read / Write)
Whether this tag affects line wrap mode.
Default value: false

Details

You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together.

Tags should be in the gtk-text-tag-table object for a given gtk-text-buffer object before using them with that text buffer. The gtk-text-buffer-create-tag function is the best way to create tags.

For each property of the gtk-text-tag class, there is a "set" property, e.g. "font-set" corresponds to "font". These "set" properties reflect whether a property has been set or not. They are maintained by GTK and you should not set them independently.

Signal Details

The "event" signal

 lambda (tag object event iter)    :run-last

The signal is emitted when an event occurs on a region of the text buffer marked with this tag.

tag: The gtk-text-tag object on which the signal is emitted.
object: The object the event was fired from, typically a gtk-text-view widget.
event: The gdk-event event which triggered the signal.
iter: A gtk-text-iter iterator pointing at the location the event occured.
Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.