Package: gtk

Class gtk-text-tag

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)
Background color as a gdk-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)
Background color as a gdk-rgba.
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. right-to-left or 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. Since 3.16
Default value: true
fallback-set
The fallback-set property of type :boolean (Read / Write)
Whether this tag affects font fallback. Since 3.16
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 structure.
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)
Foreground color as a gdk-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)
Foreground color as a gdk-rgba.
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 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-get-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. Since 3.16
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. Since 3.16
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 as a as a gdk-rgba.
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 above 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 PANGO_SCALE_X_LARGE.
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 PangoStretch (Read / Write)
Font stretch as a pango-stretch enumeration, e. g. the value :condensed.
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. Since 3.16
strikethrough-rgba-set
The strikethrough-rgba-set property of type :boolean (Read / Write)
If the strikethrough-rgba property has been set. Since 3.16
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 as a value of the pango-style enumeration, e. g. :italic.
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 value :error of the pango-underline enumeration, an alternate color may be applied instead of the foreground. Setting this property will always override those defaults. Since 3.16
underline-rgba-set
The underline-rgba-set property of type :boolean (Read / Write)
If the underline-rgba property has been set. Since 3.16
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 as a value of the pango-variant enumeration, e. g. :small-caps.
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, :bold.
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 buffer.

The gtk-text-buffer-create-tag function is the best way to create tags. See gtk3-demo for numerous examples.

For each property of gtk-text-tag, 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 "event" signal is emitted when an event occurs on a region of the 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 object).
event
The event which triggered the signal.
iter
A gtk-text-iter 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.
 

Slot Access Functions

gtk-text-tag-accumulative-margin
gtk-text-tag-background
gtk-text-tag-background-full-height
gtk-text-tag-background-full-height-set
gtk-text-tag-background-gdk
gtk-text-tag-background-rgba
gtk-text-tag-background-set
gtk-text-tag-direction
gtk-text-tag-editable
gtk-text-tag-editable-set
gtk-text-tag-family
gtk-text-tag-family-set
gtk-text-tag-font
gtk-text-tag-font-desc
gtk-text-tag-foreground
gtk-text-tag-foreground-gdk
gtk-text-tag-foreground-rgba
gtk-text-tag-foreground-set
gtk-text-tag-indent
gtk-text-tag-indent-set
gtk-text-tag-invisible
gtk-text-tag-invisible-set
gtk-text-tag-justification
gtk-text-tag-justification-set
gtk-text-tag-language
gtk-text-tag-language-set
gtk-text-tag-left-margin
gtk-text-tag-left-margin-set
gtk-text-tag-name
gtk-text-tag-paragraph-background
gtk-text-tag-paragraph-background-gdk
gtk-text-tag-paragraph-background-rgba
gtk-text-tag-paragraph-background-set
gtk-text-tag-pixels-above-lines
gtk-text-tag-pixels-above-lines-set
gtk-text-tag-pixels-below-lines
gtk-text-tag-pixels-below-lines-set
gtk-text-tag-pixels-inside-wrap
gtk-text-tag-pixels-inside-wrap-set
gtk-text-tag-right-margin
gtk-text-tag-right-margin-set
gtk-text-tag-rise
gtk-text-tag-rise-set
gtk-text-tag-scale
gtk-text-tag-scale-set
gtk-text-tag-size
gtk-text-tag-size-points
gtk-text-tag-size-set
gtk-text-tag-stretch
gtk-text-tag-stretch-set
gtk-text-tag-strikethrough
gtk-text-tag-strikethrough-set
gtk-text-tag-style
gtk-text-tag-style-set
gtk-text-tag-tabs
gtk-text-tag-tabs-set
gtk-text-tag-underline
gtk-text-tag-underline-set
gtk-text-tag-variant
gtk-text-tag-variant-set
gtk-text-tag-weight
gtk-text-tag-weight-set
gtk-text-tag-wrap-mode
gtk-text-tag-wrap-mode-set

Inherited Slot Access Functions

2020-3-20