GtkTextTag — A tag that can be applied to text in a GtkTextBuffer
GtkTextTag * | gtk_text_tag_new () |
int | gtk_text_tag_get_priority () |
void | gtk_text_tag_set_priority () |
void | gtk_text_tag_changed () |
gboolean | accumulative-margin | Read / Write |
gboolean | allow-breaks | Read / Write |
gboolean | allow-breaks-set | Read / Write |
char * | background | Write |
gboolean | background-full-height | Read / Write |
gboolean | background-full-height-set | Read / Write |
GdkRGBA * | background-rgba | Read / Write |
gboolean | background-set | Read / Write |
GtkTextDirection | direction | Read / Write |
gboolean | editable | Read / Write |
gboolean | editable-set | Read / Write |
gboolean | fallback | Read / Write |
gboolean | fallback-set | Read / Write |
char * | family | Read / Write |
gboolean | family-set | Read / Write |
char * | font | Read / Write |
PangoFontDescription * | font-desc | Read / Write |
char * | font-features | Read / Write |
gboolean | font-features-set | Read / Write |
char * | foreground | Write |
GdkRGBA * | foreground-rgba | Read / Write |
gboolean | foreground-set | Read / Write |
int | indent | Read / Write |
gboolean | indent-set | Read / Write |
gboolean | insert-hyphens | Read / Write |
gboolean | insert-hyphens-set | Read / Write |
gboolean | invisible | Read / Write |
gboolean | invisible-set | Read / Write |
GtkJustification | justification | Read / Write |
gboolean | justification-set | Read / Write |
char * | language | Read / Write |
gboolean | language-set | Read / Write |
int | left-margin | Read / Write |
gboolean | left-margin-set | Read / Write |
int | letter-spacing | Read / Write |
gboolean | letter-spacing-set | Read / Write |
char * | name | Read / Write / Construct Only |
PangoOverline | overline | Read / Write |
GdkRGBA * | overline-rgba | Read / Write |
gboolean | overline-rgba-set | Read / Write |
gboolean | overline-set | Read / Write |
char * | paragraph-background | Write |
GdkRGBA * | paragraph-background-rgba | Read / Write |
gboolean | paragraph-background-set | Read / Write |
int | pixels-above-lines | Read / Write |
gboolean | pixels-above-lines-set | Read / Write |
int | pixels-below-lines | Read / Write |
gboolean | pixels-below-lines-set | Read / Write |
int | pixels-inside-wrap | Read / Write |
gboolean | pixels-inside-wrap-set | Read / Write |
int | right-margin | Read / Write |
gboolean | right-margin-set | Read / Write |
int | rise | Read / Write |
gboolean | rise-set | Read / Write |
double | scale | Read / Write |
gboolean | scale-set | Read / Write |
PangoShowFlags | show-spaces | Read / Write |
gboolean | show-spaces-set | Read / Write |
int | size | Read / Write |
double | size-points | Read / Write |
gboolean | size-set | Read / Write |
PangoStretch | stretch | Read / Write |
gboolean | stretch-set | Read / Write |
gboolean | strikethrough | Read / Write |
GdkRGBA * | strikethrough-rgba | Read / Write |
gboolean | strikethrough-rgba-set | Read / Write |
gboolean | strikethrough-set | Read / Write |
PangoStyle | style | Read / Write |
gboolean | style-set | Read / Write |
PangoTabArray * | tabs | Read / Write |
gboolean | tabs-set | Read / Write |
PangoUnderline | underline | Read / Write |
GdkRGBA * | underline-rgba | Read / Write |
gboolean | underline-rgba-set | Read / Write |
gboolean | underline-set | Read / Write |
PangoVariant | variant | Read / Write |
gboolean | variant-set | Read / Write |
int | weight | Read / Write |
gboolean | weight-set | Read / Write |
GtkWrapMode | wrap-mode | Read / Write |
gboolean | wrap-mode-set | Read / Write |
struct | GtkTextTag |
GObject ╰── GtkTextTag
#include <gtk/gtk.h>
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 GtkTextTagTable for a given GtkTextBuffer before using them with that buffer.
gtk_text_buffer_create_tag() is the best way to create tags. See “gtk4-demo” for numerous examples.
For each property of GtkTextTag, 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.
GtkTextTag *
gtk_text_tag_new (const char *name
);
Creates a GtkTextTag. Configure the tag using object arguments, i.e. using g_object_set()
.
name | tag name, or | [allow-none] |
a new GtkTextTag
int
gtk_text_tag_get_priority (GtkTextTag *tag
);
Get the tag priority.
tag |
The tag’s priority.
void gtk_text_tag_set_priority (GtkTextTag *tag
,int priority
);
Sets the priority of a GtkTextTag. Valid priorities start at 0 and go to one less than 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 gtk_text_buffer_create_tag()
, which adds the tag to the buffer’s table automatically.
tag | ||
priority | the new priority |
void gtk_text_tag_changed (GtkTextTag *tag
,gboolean size_changed
);
Emits the “tag-changed” signal on the GtkTextTagTable where the tag is included.
The signal is already emitted when setting a GtkTextTag property. This function is useful for a GtkTextTag subclass.
tag | a GtkTextTag. | |
size_changed | whether the change affects the GtkTextView layout. |
struct GtkTextTag;
“accumulative-margin”
property“accumulative-margin” gboolean
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).
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“allow-breaks”
property“allow-breaks” gboolean
Whether breaks are allowed.
Owner: GtkTextTag
Flags: Read / Write
Default value: TRUE
“allow-breaks-set”
property“allow-breaks-set” gboolean
Whether this tag affects line breaks.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“background”
property“background” char *
Background color as a string.
Owner: GtkTextTag
Flags: Write
Default value: NULL
“background-full-height”
property“background-full-height” gboolean
Whether the background color fills the entire line height or only the height of the tagged characters.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“background-full-height-set”
property“background-full-height-set” gboolean
Whether this tag affects background height.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“background-rgba”
property“background-rgba” GdkRGBA *
Background color as a GdkRGBA.
Owner: GtkTextTag
Flags: Read / Write
“background-set”
property“background-set” gboolean
Whether this tag affects the background color.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“direction”
property“direction” GtkTextDirection
Text direction, e.g. right-to-left or left-to-right.
Owner: GtkTextTag
Flags: Read / Write
Default value: GTK_TEXT_DIR_NONE
“editable”
property“editable” gboolean
Whether the text can be modified by the user.
Owner: GtkTextTag
Flags: Read / Write
Default value: TRUE
“editable-set”
property“editable-set” gboolean
Whether this tag affects text editability.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“fallback”
property“fallback” gboolean
Whether font fallback is enabled.
When set to TRUE
, other fonts will be substituted where the current font is missing glyphs.
Owner: GtkTextTag
Flags: Read / Write
Default value: TRUE
“fallback-set”
property“fallback-set” gboolean
Whether this tag affects font fallback.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“family”
property“family” char *
Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
Owner: GtkTextTag
Flags: Read / Write
Default value: NULL
“family-set”
property“family-set” gboolean
Whether this tag affects the font family.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“font”
property“font” char *
Font description as string, e.g. \"Sans Italic 12\".
Note that the initial value of this property depends on the internals of PangoFontDescription.
Owner: GtkTextTag
Flags: Read / Write
Default value: NULL
“font-desc”
property“font-desc” PangoFontDescription *
Font description as a PangoFontDescription struct.
Owner: GtkTextTag
Flags: Read / Write
“font-features”
property“font-features” char *
OpenType font features, as a string.
Owner: GtkTextTag
Flags: Read / Write
Default value: NULL
“font-features-set”
property“font-features-set” gboolean
Whether this tag affects font features.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“foreground”
property“foreground” char *
Foreground color as a string.
Owner: GtkTextTag
Flags: Write
Default value: NULL
“foreground-rgba”
property“foreground-rgba” GdkRGBA *
Foreground color as a GdkRGBA.
Owner: GtkTextTag
Flags: Read / Write
“foreground-set”
property“foreground-set” gboolean
Whether this tag affects the foreground color.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“indent”
property“indent” int
Amount to indent the paragraph, in pixels.
Owner: GtkTextTag
Flags: Read / Write
Default value: 0
“indent-set”
property“indent-set” gboolean
Whether this tag affects indentation.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“insert-hyphens”
property“insert-hyphens” gboolean
Whether to insert hyphens at breaks.
Owner: GtkTextTag
Flags: Read / Write
Default value: TRUE
“insert-hyphens-set”
property“insert-hyphens-set” gboolean
Whether this tag affects insertion of hyphens.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“invisible”
property“invisible” gboolean
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.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“invisible-set”
property“invisible-set” gboolean
Whether this tag affects text visibility.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“justification”
property“justification” GtkJustification
Left, right, or center justification.
Owner: GtkTextTag
Flags: Read / Write
Default value: GTK_JUSTIFY_LEFT
“justification-set”
property“justification-set” gboolean
Whether this tag affects paragraph justification.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“language”
property“language” char *
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 gtk_get_default_language()
.
Owner: GtkTextTag
Flags: Read / Write
Default value: NULL
“language-set”
property“language-set” gboolean
Whether this tag affects the language the text is rendered as.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“left-margin”
property“left-margin” int
Width of the left margin in pixels.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“left-margin-set”
property“left-margin-set” gboolean
Whether this tag affects the left margin.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“letter-spacing”
property“letter-spacing” int
Extra spacing between graphemes, in Pango units.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“letter-spacing-set”
property“letter-spacing-set” gboolean
Whether this tag affects letter spacing.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“name”
property“name” char *
Name used to refer to the text tag. NULL for anonymous tags.
Owner: GtkTextTag
Flags: Read / Write / Construct Only
Default value: NULL
“overline”
property“overline” PangoOverline
Style of overline for this text.
Owner: GtkTextTag
Flags: Read / Write
Default value: PANGO_OVERLINE_NONE
“overline-rgba”
property“overline-rgba” GdkRGBA *
Color of overline for this text.
Owner: GtkTextTag
Flags: Read / Write
“overline-rgba-set”
property“overline-rgba-set” gboolean
Whether this tag affects overlining color.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“overline-set”
property“overline-set” gboolean
Whether this tag affects overlining.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“paragraph-background”
property“paragraph-background” char *
The paragraph background color as a string.
Owner: GtkTextTag
Flags: Write
Default value: NULL
“paragraph-background-rgba”
property“paragraph-background-rgba” GdkRGBA *
The paragraph background color as a GdkRGBA.
Owner: GtkTextTag
Flags: Read / Write
“paragraph-background-set”
property“paragraph-background-set” gboolean
Whether this tag affects the paragraph background color.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“pixels-above-lines”
property“pixels-above-lines” int
Pixels of blank space above paragraphs.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“pixels-above-lines-set”
property“pixels-above-lines-set” gboolean
Whether this tag affects the number of pixels above lines.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“pixels-below-lines”
property“pixels-below-lines” int
Pixels of blank space below paragraphs.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“pixels-below-lines-set”
property“pixels-below-lines-set” gboolean
Whether this tag affects the number of pixels above lines.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“pixels-inside-wrap”
property“pixels-inside-wrap” int
Pixels of blank space between wrapped lines in a paragraph.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“pixels-inside-wrap-set”
property“pixels-inside-wrap-set” gboolean
Whether this tag affects the number of pixels between wrapped lines.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“right-margin”
property“right-margin” int
Width of the right margin in pixels.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“right-margin-set”
property“right-margin-set” gboolean
Whether this tag affects the right margin.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“rise”
property“rise” int
Offset of text above the baseline (below the baseline if rise is negative) in Pango units.
Owner: GtkTextTag
Flags: Read / Write
Default value: 0
“rise-set”
property“rise-set” gboolean
Whether this tag affects the rise.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“scale”
property“scale” double
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.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 1
“scale-set”
property“scale-set” gboolean
Whether this tag scales the font size by a factor.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“show-spaces”
property“show-spaces” PangoShowFlags
How to render invisible characters.
Owner: GtkTextTag
Flags: Read / Write
“show-spaces-set”
property“show-spaces-set” gboolean
Whether this tag affects rendering of invisible characters.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“size”
property“size” int
Font size in Pango units.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“size-points”
property“size-points” double
Font size in points.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“size-set”
property“size-set” gboolean
Whether this tag affects the font size.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“stretch”
property“stretch” PangoStretch
Font stretch as a PangoStretch, e.g. PANGO_STRETCH_CONDENSED.
Owner: GtkTextTag
Flags: Read / Write
Default value: PANGO_STRETCH_NORMAL
“stretch-set”
property“stretch-set” gboolean
Whether this tag affects the font stretch.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“strikethrough”
property“strikethrough” gboolean
Whether to strike through the text.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“strikethrough-rgba”
property“strikethrough-rgba” GdkRGBA *
This property modifies the color of strikeouts. If not set, strikeouts will use the foreground color.
Owner: GtkTextTag
Flags: Read / Write
“strikethrough-rgba-set”
property“strikethrough-rgba-set” gboolean
If the “strikethrough-rgba” property has been set.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“strikethrough-set”
property“strikethrough-set” gboolean
Whether this tag affects strikethrough.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“style”
property“style” PangoStyle
Font style as a PangoStyle, e.g. PANGO_STYLE_ITALIC.
Owner: GtkTextTag
Flags: Read / Write
Default value: PANGO_STYLE_NORMAL
“style-set”
property“style-set” gboolean
Whether this tag affects the font style.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“tabs”
property“tabs” PangoTabArray *
Custom tabs for this text.
Owner: GtkTextTag
Flags: Read / Write
“tabs-set”
property“tabs-set” gboolean
Whether this tag affects tabs.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“underline”
property“underline” PangoUnderline
Style of underline for this text.
Owner: GtkTextTag
Flags: Read / Write
Default value: PANGO_UNDERLINE_NONE
“underline-rgba”
property“underline-rgba” GdkRGBA *
This property modifies the color of underlines. If not set, underlines will use the foreground color.
If “underline” is set to PANGO_UNDERLINE_ERROR
, an alternate color may be applied instead of the foreground. Setting this property will always override those defaults.
Owner: GtkTextTag
Flags: Read / Write
“underline-rgba-set”
property“underline-rgba-set” gboolean
If the “underline-rgba” property has been set.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“underline-set”
property“underline-set” gboolean
Whether this tag affects underlining.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“variant”
property“variant” PangoVariant
Font variant as a PangoVariant, e.g. PANGO_VARIANT_SMALL_CAPS.
Owner: GtkTextTag
Flags: Read / Write
Default value: PANGO_VARIANT_NORMAL
“variant-set”
property“variant-set” gboolean
Whether this tag affects the font variant.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“weight”
property“weight” int
Font weight as an integer, see predefined values in PangoWeight; for example, PANGO_WEIGHT_BOLD.
Owner: GtkTextTag
Flags: Read / Write
Allowed values: >= 0
Default value: 400
“weight-set”
property“weight-set” gboolean
Whether this tag affects the font weight.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
“wrap-mode”
property“wrap-mode” GtkWrapMode
Whether to wrap lines never, at word boundaries, or at character boundaries.
Owner: GtkTextTag
Flags: Read / Write
Default value: GTK_WRAP_NONE
“wrap-mode-set”
property“wrap-mode-set” gboolean
Whether this tag affects line wrap mode.
Owner: GtkTextTag
Flags: Read / Write
Default value: FALSE
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkTextTag.html