Package: gtk

Class gtk:text-tag

Superclasses

gobject: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
allow-breaks
The allow-breaks property of type :boolean (Read / Write)
Whether breaks are allowed.
Default value: true
allow-breaks-set
The allow-breaks-set property of type :boolean (Read / Write)
Whether this tag affects line breaks.
Default value: false
background
The background property of type :string (Write)
The 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-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)
The text direction, for example, 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)
The name of the font family, for example, 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)
The font description as string, for example, "Sans Italic 12". Note that the initial value of this property depends on the internals of the Pango font description.
Default value: nil
font-desc
The font-desc property of type pango:font-description (Read / Write)
The font description as a Pango font description.
font-features
The font-features property of type :string (Read / Write)
The OpenType font features, as a string.
Default value: nil
font-features-set
The font-features-set property of type :boolean (Read / Write)
Whether this tag affects font features.
Default value: false
foreground
The foreground property of type :string (Write)
The foreground color as a string.
Default value: nil
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)
The 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
insert-hyphens
The insert-hyphens property of type :boolean (Read / Write)
Whether to insert hyphens at breaks.
Default value: true
insert-hyphens-set
The insert-hyphens-set property of type :boolean (Read / Write)
Whether this tag affects insertion of hyphens.
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)
The 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)
The 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)
The 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
line-height
The line-height property of type :float (Read / Write)
The factor to scale line height by. Since 4.6
line-height-set
The line-height-set property of type :boolean (Read / Write)
Whether this tag affects line height. Since 4.6
Default value: false
name
The name property of type :string (Read / Write / Construct)
The name used to refer to the text tag, nil for anonymous tags.
Default value: nil
overline
The overline property of type pango:overline (Read / Write)
The style of overline for this text.
Default value: :none
overline-rgba
The overline-rgba property of type gdk:rgba (Read / Write)
The color of overline for this text.
overline-rgba-set
The overline-rgba-set property of type :boolean (Read / Write)
Whether this tag affects overlining color.
Default value: false
overline-set
The overline-set property of type :boolean (Read / Write)
Whether this tag affects overlining.
Default value: false
paragraph-background
The paragraph-background property of type :string (Write)
The paragraph background color as a string.
Default value: nil
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)
The 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)
The 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)
The 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)
The 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)
The 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)
The 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
sentence
The sentence property of type :boolean (Read / Write)
Whether this tag represents a single sentence. This affects cursor movement. Since 4.6
Default value: false
sentence-set
The sentence-set property of type :boolean (Read / Write)
Whether this tag affects the sentence property. Since 4.6
Default value: false
show-spaces
The show-spaces property of type pango:show-flags (Read / Write)
How to render invisible characters.
show-spaces-set
The show-spaces-set property of type :boolean (Read / Write)
Whether this tag affects rendering of invisible characters.
Default value: false
size
The size property of type :int (Read / Write)
The font size in Pango units.
Allowed values: >= 0
Default value: 0
size-points
The size-points property of type :double (Read / Write)
The 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)
The font stretch, for example, 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)
Whether 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)
The font style, for example, 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)
The custom tabs for this text.
tabs-set
The tabs-set property of type :boolean (Read / Write)
Whether this tag affects tabs.
Default value: false
text-transform
The text-transform property of type pango:text-transform (Read / Write)
How to transform the text for display. Since 4.6
Default value: :none
text-transform-set
The text-transform-set property of type :boolean (Read / Write)
Whether this tag affects the text-transform property. Since 4.6
Default value: false
underline
The underline property of type pango:underline (Read / Write)
The 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)
Whether 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)
The font variant, for example, 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)
The 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
word
The word property of type :boolean (Read / Write)
Whether this tag represents a single word. This affects line breaks and cursor movement. Since 4.6
word-set
The word-set property of type :boolean (Read / Write)
Whether this tag affects the word property. Since 4.6
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

A tag that can be applied to text contained in a gtk:text-buffer object. 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, for example, 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.
 

Returned by

gtk:text-tag-new

Slot Access Functions

gtk:text-tag-accumulative-margin
gtk:text-tag-allow-breaks
gtk:text-tag-allow-breaks-set
gtk:text-tag-background
gtk:text-tag-background-full-height
gtk:text-tag-background-full-height-set
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-fallback
gtk:text-tag-fallback-set
gtk:text-tag-family
gtk:text-tag-family-set
gtk:text-tag-font
gtk:text-tag-font-desc
gtk:text-tag-font-features
gtk:text-tag-font-features-set
gtk:text-tag-foreground
gtk:text-tag-foreground-rgba
gtk:text-tag-foreground-set
gtk:text-tag-indent
gtk:text-tag-indent-set
gtk:text-tag-insert-hyphens
gtk:text-tag-insert-hyphens-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-letter-spacing
gtk:text-tag-letter-spacing-set
gtk:text-tag-line-height
gtk:text-tag-line-height-set
gtk:text-tag-name
gtk:text-tag-overline
gtk:text-tag-overline-rgba
gtk:text-tag-overline-rgba-set
gtk:text-tag-overline-set
gtk:text-tag-paragraph-background
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-sentence
gtk:text-tag-sentence-set
gtk:text-tag-show-spaces
gtk:text-tag-show-spaces-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-rgba
gtk:text-tag-strikethrough-rgba-set
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-text-transform
gtk:text-tag-text-transform-set
gtk:text-tag-underline
gtk:text-tag-underline-rgba
gtk:text-tag-underline-rgba-set
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-word
gtk:text-tag-word-set
gtk:text-tag-wrap-mode
gtk:text-tag-wrap-mode-set

Inherited Slot Access Functions

g:object-has-reference
g:object-pointer

See also

gtk:text-tag-table
gtk:text-buffer
2024-7-2