CtkTextTag: CTK+ 3 Reference Manual

CtkTextTag

CtkTextTag — A tag that can be applied to text in a CtkTextBuffer

Functions

CtkTextTag *	ctk_text_tag_new ()
gint	ctk_text_tag_get_priority ()
void	ctk_text_tag_set_priority ()
gboolean	ctk_text_tag_event ()
void	ctk_text_tag_changed ()
CtkTextAttributes *	ctk_text_attributes_new ()
CtkTextAttributes *	ctk_text_attributes_copy ()
void	ctk_text_attributes_copy_values ()
void	ctk_text_attributes_unref ()
CtkTextAttributes *	ctk_text_attributes_ref ()

Properties

gboolean	accumulative-margin	Read / Write
char *	background	Write
CdkColor *	background-cdk	Read / Write
gboolean	background-full-height	Read / Write
gboolean	background-full-height-set	Read / Write
CdkRGBA *	background-rgba	Read / Write
gboolean	background-set	Read / Write
CtkTextDirection	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
CdkColor *	foreground-cdk	Read / Write
CdkRGBA *	foreground-rgba	Read / Write
gboolean	foreground-set	Read / Write
int	indent	Read / Write
gboolean	indent-set	Read / Write
gboolean	invisible	Read / Write
gboolean	invisible-set	Read / Write
CtkJustification	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
char *	paragraph-background	Write
CdkColor *	paragraph-background-cdk	Read / Write
CdkRGBA *	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
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
CdkRGBA *	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
CdkRGBA *	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
CtkWrapMode	wrap-mode	Read / Write
gboolean	wrap-mode-set	Read / Write

Signals

gboolean

event

Run Last

Types and Values

struct	CtkTextTag
struct	CtkTextAttributes
struct	CtkTextAppearance

Object Hierarchy

    GObject
    ╰── CtkTextTag

Includes

#include <ctk/ctk.h>

Description

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 CtkTextTagTable for a given CtkTextBuffer before using them with that buffer.

ctk_text_buffer_create_tag() is the best way to create tags. See “ctk3-demo” for numerous examples.

For each property of CtkTextTag, 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 CTK+ and you should not set them independently.

Functions

ctk_text_tag_new ()

CtkTextTag *
ctk_text_tag_new (const gchar *name);

Creates a CtkTextTag. Configure the tag using object arguments, i.e. using g_object_set().

Parameters

name

tag name, or NULL.

[allow-none]

Returns

a new CtkTextTag

ctk_text_tag_get_priority ()

gint
ctk_text_tag_get_priority (CtkTextTag *tag);

Get the tag priority.

Parameters

tag

a CtkTextTag

Returns

The tag’s priority.

ctk_text_tag_set_priority ()

void
ctk_text_tag_set_priority (CtkTextTag *tag,
                           gint priority);

Sets the priority of a CtkTextTag. Valid priorities start at 0 and go to one less than ctk_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 ctk_text_buffer_create_tag(), which adds the tag to the buffer’s table automatically.

Parameters

tag	a CtkTextTag
priority	the new priority

ctk_text_tag_event ()

gboolean
ctk_text_tag_event (CtkTextTag *tag,
                    GObject *event_object,
                    CdkEvent *event,
                    const CtkTextIter *iter);

Emits the “event” signal on the CtkTextTag.

Parameters

tag	a CtkTextTag
event_object	object that received the event, such as a widget
event	the event
iter	location where the event was received

Returns

result of signal emission (whether the event was handled)

ctk_text_tag_changed ()

void
ctk_text_tag_changed (CtkTextTag *tag,
                      gboolean size_changed);

Emits the “tag-changed” signal on the CtkTextTagTable where the tag is included.

The signal is already emitted when setting a CtkTextTag property. This function is useful for a CtkTextTag subclass.

Parameters

tag	a CtkTextTag.
size_changed	whether the change affects the CtkTextView layout.

Since: 3.20

ctk_text_attributes_new ()

CtkTextAttributes *
ctk_text_attributes_new (void);

Creates a CtkTextAttributes, which describes a set of properties on some text.

Returns

a new CtkTextAttributes, free with ctk_text_attributes_unref().

ctk_text_attributes_copy ()

CtkTextAttributes *
ctk_text_attributes_copy (CtkTextAttributes *src);

Copies src and returns a new CtkTextAttributes.

Parameters

src

a CtkTextAttributes to be copied

Returns

a copy of src , free with ctk_text_attributes_unref()

ctk_text_attributes_copy_values ()

void
ctk_text_attributes_copy_values (CtkTextAttributes *src,
                                 CtkTextAttributes *dest);

Copies the values from src to dest so that dest has the same values as src . Frees existing values in dest .

Parameters

src	a CtkTextAttributes
dest	another CtkTextAttributes

ctk_text_attributes_unref ()

void
ctk_text_attributes_unref (CtkTextAttributes *values);

Decrements the reference count on values , freeing the structure if the reference count reaches 0.

Parameters

values

a CtkTextAttributes

ctk_text_attributes_ref ()

CtkTextAttributes *
ctk_text_attributes_ref (CtkTextAttributes *values);

Increments the reference count on values .

Parameters

values

a CtkTextAttributes

Returns

the CtkTextAttributes that were passed in

Types and Values

struct CtkTextTag

struct CtkTextTag;

struct CtkTextAttributes

struct CtkTextAttributes {
  CtkTextAppearance appearance;

  CtkJustification justification;
  CtkTextDirection direction;

  PangoFontDescription *font;

  gdouble font_scale;

  gint left_margin;
  gint right_margin;
  gint indent;

  gint pixels_above_lines;
  gint pixels_below_lines;
  gint pixels_inside_wrap;

  PangoTabArray *tabs;

  CtkWrapMode wrap_mode;

  PangoLanguage *language;

  guint invisible : 1;
  guint bg_full_height : 1;
  guint editable : 1;
  guint no_fallback: 1;

  gint letter_spacing;

#ifdef __GI_SCANNER__
  /* The scanner should only see the transparent union, so that its
   * content does not vary across architectures.
   */
  union {
    gchar *font_features;
};

Using CtkTextAttributes directly should rarely be necessary. It’s primarily useful with ctk_text_iter_get_attributes(). As with most CTK+ structs, the fields in this struct should only be read, never modified directly.

Members

CtkTextAppearance `appearance`;	CtkTextAppearance for text.
CtkJustification `justification`;	CtkJustification for text.
CtkTextDirection `direction`;	CtkTextDirection for text.
PangoFontDescription *`font`;	PangoFontDescription for text.
gdouble `font_scale`;	Font scale factor.
gint `left_margin`;	Width of the left margin in pixels.
gint `right_margin`;	Width of the right margin in pixels.
gint `indent`;	Amount to indent the paragraph, in pixels.
gint `pixels_above_lines`;	Pixels of blank space above paragraphs.
gint `pixels_below_lines`;	Pixels of blank space below paragraphs.
gint `pixels_inside_wrap`;	Pixels of blank space between wrapped lines in a paragraph.
PangoTabArray *`tabs`;	Custom PangoTabArray for this text.
CtkWrapMode `wrap_mode`;	CtkWrapMode for text.
PangoLanguage *`language`;	PangoLanguage for text.
guint `invisible` : 1;	Hide the text.
guint `bg_full_height` : 1;	Background is fit to full line height rather than baseline +/- ascent/descent (font height).
guint `editable` : 1;	Can edit this text.
guint `no_fallback` : 1;	Whether to disable font fallback.
gint `letter_spacing`;	Extra space to insert between graphemes, in Pango units
gchar *`font_features`;	OpenType font features, as a string.

struct CtkTextAppearance

struct CtkTextAppearance {
  CdkColor bg_color; /* pixel is taken for underline color */
  CdkColor fg_color; /* pixel is taken for strikethrough color */

  /* super/subscript rise, can be negative */
  gint rise;

  guint underline : 4;          /* PangoUnderline */
  guint strikethrough : 1;

  /* Whether to use background-related values; this is irrelevant for
   * the values struct when in a tag, but is used for the composite
   * values struct; it's true if any of the tags being composited
   * had background stuff set.
   */
  guint draw_bg : 1;

  /* These are only used when we are actually laying out and rendering
   * a paragraph; not when a CtkTextAppearance is part of a
   * CtkTextAttributes.
   */
  guint inside_selection : 1;
  guint is_text : 1;

  /* For the sad story of this bit of code, see
   * https://bugzilla.gnome.org/show_bug.cgi?id=711158
   */
#ifdef __GI_SCANNER__
  /* The scanner should only see the transparent union, so that its
   * content does not vary across architectures.
   */
  union {
    CdkRGBA *rgba[2];
};

Members

CdkColor `bg_color`;	Background CdkColor.
CdkColor `fg_color`;	Foreground CdkColor.
gint `rise`;	Super/subscript rise, can be negative.
guint `underline` : 4;	PangoUnderline
guint `strikethrough` : 1;	Strikethrough style
guint `draw_bg` : 1;	Whether to use background-related values; this is irrelevant for the values struct when in a tag, but is used for the composite values struct; it’s true if any of the tags being composited had background stuff set.
guint `inside_selection` : 1;	This are only used when we are actually laying out and rendering a paragraph; not when a CtkTextAppearance is part of a CtkTextAttributes.
guint `is_text` : 1;	This are only used when we are actually laying out and rendering a paragraph; not when a CtkTextAppearance is part of a CtkTextAttributes.
CdkRGBA *`rgba`[2];	CdkRGBA

Property Details

The `“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: CtkTextTag

Flags: Read / Write

Default value: FALSE

Since: 2.12

The `“background”` property

  “background”               char *

Background color as a string.

Owner: CtkTextTag

Flags: Write

Default value: NULL

The `“background-cdk”` property

  “background-cdk”           CdkColor *

Background color as a CdkColor.

CtkTextTag:background-cdk has been deprecated since version 3.4 and should not be used in newly-written code.

Use “background-rgba” instead.

Owner: CtkTextTag

Flags: Read / Write

The `“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: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“background-full-height-set”` property

  “background-full-height-set” gboolean

Whether this tag affects background height.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“background-rgba”` property

  “background-rgba”          CdkRGBA *

Background color as a CdkRGBA.

Owner: CtkTextTag

Flags: Read / Write

Since: 3.2

The `“background-set”` property

  “background-set”           gboolean

Whether this tag affects the background color.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“direction”` property

  “direction”                CtkTextDirection

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

Owner: CtkTextTag

Flags: Read / Write

Default value: CTK_TEXT_DIR_NONE

The `“editable”` property

  “editable”                 gboolean

Whether the text can be modified by the user.

Owner: CtkTextTag

Flags: Read / Write

Default value: TRUE

The `“editable-set”` property

  “editable-set”             gboolean

Whether this tag affects text editability.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“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: CtkTextTag

Flags: Read / Write

Default value: TRUE

Since: 3.16

The `“fallback-set”` property

  “fallback-set”             gboolean

Whether this tag affects font fallback.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“family”` property

  “family”                   char *

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

Owner: CtkTextTag

Flags: Read / Write

Default value: NULL

The `“family-set”` property

  “family-set”               gboolean

Whether this tag affects the font family.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“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: CtkTextTag

Flags: Read / Write

Default value: NULL

The `“font-desc”` property

  “font-desc”                PangoFontDescription *

Font description as a PangoFontDescription struct.

Owner: CtkTextTag

Flags: Read / Write

The `“font-features”` property

  “font-features”            char *

OpenType font features, as a string.

Owner: CtkTextTag

Flags: Read / Write

Default value: NULL

Since: 3.18

The `“font-features-set”` property

  “font-features-set”        gboolean

Whether this tag affects font features.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“foreground”` property

  “foreground”               char *

Foreground color as a string.

Owner: CtkTextTag

Flags: Write

Default value: NULL

The `“foreground-cdk”` property

  “foreground-cdk”           CdkColor *

Foreground color as a CdkColor.

CtkTextTag:foreground-cdk has been deprecated since version 3.4 and should not be used in newly-written code.

Use “foreground-rgba” instead.

Owner: CtkTextTag

Flags: Read / Write

The `“foreground-rgba”` property

  “foreground-rgba”          CdkRGBA *

Foreground color as a CdkRGBA.

Owner: CtkTextTag

Flags: Read / Write

Since: 3.2

The `“foreground-set”` property

  “foreground-set”           gboolean

Whether this tag affects the foreground color.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“indent”` property

  “indent”                   int

Amount to indent the paragraph, in pixels.

Owner: CtkTextTag

Flags: Read / Write

Default value: 0

The `“indent-set”` property

  “indent-set”               gboolean

Whether this tag affects indentation.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“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: CtkTextTag

Flags: Read / Write

Default value: FALSE

Since: 2.8

The `“invisible-set”` property

  “invisible-set”            gboolean

Whether this tag affects text visibility.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“justification”` property

  “justification”            CtkJustification

Left, right, or center justification.

Owner: CtkTextTag

Flags: Read / Write

Default value: CTK_JUSTIFY_LEFT

The `“justification-set”` property

  “justification-set”        gboolean

Whether this tag affects paragraph justification.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“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 ctk_get_default_language().

Owner: CtkTextTag

Flags: Read / Write

Default value: NULL

The `“language-set”` property

  “language-set”             gboolean

Whether this tag affects the language the text is rendered as.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“left-margin”` property

  “left-margin”              int

Width of the left margin in pixels.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“left-margin-set”` property

  “left-margin-set”          gboolean

Whether this tag affects the left margin.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“letter-spacing”` property

  “letter-spacing”           int

Extra spacing between graphemes, in Pango units.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 3.16

The `“letter-spacing-set”` property

  “letter-spacing-set”       gboolean

Whether this tag affects letter spacing.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“name”` property

  “name”                     char *

Name used to refer to the text tag. NULL for anonymous tags.

Owner: CtkTextTag

Flags: Read / Write / Construct Only

Default value: NULL

The `“paragraph-background”` property

  “paragraph-background”     char *

The paragraph background color as a string.

Owner: CtkTextTag

Flags: Write

Default value: NULL

Since: 2.8

The `“paragraph-background-cdk”` property

  “paragraph-background-cdk” CdkColor *

The paragraph background color as a CdkColor.

CtkTextTag:paragraph-background-cdk has been deprecated since version 3.4 and should not be used in newly-written code.

Use “paragraph-background-rgba” instead.

Owner: CtkTextTag

Flags: Read / Write

Since: 2.8

The `“paragraph-background-rgba”` property

  “paragraph-background-rgba” CdkRGBA *

The paragraph background color as a CdkRGBA.

Owner: CtkTextTag

Flags: Read / Write

Since: 3.2

The `“paragraph-background-set”` property

  “paragraph-background-set” gboolean

Whether this tag affects the paragraph background color.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“pixels-above-lines”` property

  “pixels-above-lines”       int

Pixels of blank space above paragraphs.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“pixels-above-lines-set”` property

  “pixels-above-lines-set”   gboolean

Whether this tag affects the number of pixels above lines.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“pixels-below-lines”` property

  “pixels-below-lines”       int

Pixels of blank space below paragraphs.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“pixels-below-lines-set”` property

  “pixels-below-lines-set”   gboolean

Whether this tag affects the number of pixels above lines.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“pixels-inside-wrap”` property

  “pixels-inside-wrap”       int

Pixels of blank space between wrapped lines in a paragraph.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“pixels-inside-wrap-set”` property

  “pixels-inside-wrap-set”   gboolean

Whether this tag affects the number of pixels between wrapped lines.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“right-margin”` property

  “right-margin”             int

Width of the right margin in pixels.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“right-margin-set”` property

  “right-margin-set”         gboolean

Whether this tag affects the right margin.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“rise”` property

  “rise”                     int

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

Owner: CtkTextTag

Flags: Read / Write

Default value: 0

The `“rise-set”` property

  “rise-set”                 gboolean

Whether this tag affects the rise.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“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: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 1

The `“scale-set”` property

  “scale-set”                gboolean

Whether this tag scales the font size by a factor.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“size”` property

  “size”                     int

Font size in Pango units.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“size-points”` property

  “size-points”              double

Font size in points.

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 0

The `“size-set”` property

  “size-set”                 gboolean

Whether this tag affects the font size.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“stretch”` property

  “stretch”                  PangoStretch

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

Owner: CtkTextTag

Flags: Read / Write

Default value: PANGO_STRETCH_NORMAL

The `“stretch-set”` property

  “stretch-set”              gboolean

Whether this tag affects the font stretch.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“strikethrough”` property

  “strikethrough”            gboolean

Whether to strike through the text.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“strikethrough-rgba”` property

  “strikethrough-rgba”       CdkRGBA *

This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.

Owner: CtkTextTag

Flags: Read / Write

Since: 3.16

The `“strikethrough-rgba-set”` property

  “strikethrough-rgba-set”   gboolean

If the “strikethrough-rgba” property has been set.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

Since: 3.16

The `“strikethrough-set”` property

  “strikethrough-set”        gboolean

Whether this tag affects strikethrough.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“style”` property

  “style”                    PangoStyle

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

Owner: CtkTextTag

Flags: Read / Write

Default value: PANGO_STYLE_NORMAL

The `“style-set”` property

  “style-set”                gboolean

Whether this tag affects the font style.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“tabs”` property

  “tabs”                     PangoTabArray *

Custom tabs for this text.

Owner: CtkTextTag

Flags: Read / Write

The `“tabs-set”` property

  “tabs-set”                 gboolean

Whether this tag affects tabs.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“underline”` property

  “underline”                PangoUnderline

Style of underline for this text.

Owner: CtkTextTag

Flags: Read / Write

Default value: PANGO_UNDERLINE_NONE

The `“underline-rgba”` property

  “underline-rgba”           CdkRGBA *

This property modifies the color of underlines. If not set, underlines will use the forground 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: CtkTextTag

Flags: Read / Write

Since: 3.16

The `“underline-rgba-set”` property

  “underline-rgba-set”       gboolean

If the “underline-rgba” property has been set.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

Since: 3.16

The `“underline-set”` property

  “underline-set”            gboolean

Whether this tag affects underlining.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“variant”` property

  “variant”                  PangoVariant

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

Owner: CtkTextTag

Flags: Read / Write

Default value: PANGO_VARIANT_NORMAL

The `“variant-set”` property

  “variant-set”              gboolean

Whether this tag affects the font variant.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“weight”` property

  “weight”                   int

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

Owner: CtkTextTag

Flags: Read / Write

Allowed values: >= 0

Default value: 400

The `“weight-set”` property

  “weight-set”               gboolean

Whether this tag affects the font weight.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

The `“wrap-mode”` property

  “wrap-mode”                CtkWrapMode

Whether to wrap lines never, at word boundaries, or at character boundaries.

Owner: CtkTextTag

Flags: Read / Write

Default value: CTK_WRAP_NONE

The `“wrap-mode-set”` property

  “wrap-mode-set”            gboolean

Whether this tag affects line wrap mode.

Owner: CtkTextTag

Flags: Read / Write

Default value: FALSE

Signal Details

The `“event”` signal

gboolean
user_function (CtkTextTag  *tag,
               GObject     *object,
               CdkEvent    *event,
               CtkTextIter *iter,
               gpointer     user_data)

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

Parameters

tag	the CtkTextTag on which the signal is emitted
object	the object the event was fired from (typically a CtkTextView)
event	the event which triggered the signal
iter	a CtkTextIter pointing at the location the event occurred
user_data	user data set when the signal handler was connected.

Returns

TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.

Flags: Run Last

CtkTextTag

Functions

Properties

Signals

Types and Values

Object Hierarchy

Includes

Description

Functions

ctk_text_tag_new ()

Parameters

Returns

ctk_text_tag_get_priority ()

Parameters

Returns

ctk_text_tag_set_priority ()

Parameters

ctk_text_tag_event ()

Parameters

Returns

ctk_text_tag_changed ()

Parameters

ctk_text_attributes_new ()

Returns

ctk_text_attributes_copy ()

Parameters

Returns

ctk_text_attributes_copy_values ()

Parameters

ctk_text_attributes_unref ()

Parameters

ctk_text_attributes_ref ()

Parameters

Returns

Types and Values

struct CtkTextTag

struct CtkTextAttributes

Members

struct CtkTextAppearance

Members

Property Details

The “accumulative-margin” property

The “background” property

The “background-cdk” property

The “background-full-height” property

The “background-full-height-set” property

The “background-rgba” property

The “background-set” property

The “direction” property

The “editable” property

The “editable-set” property

The “fallback” property

The “fallback-set” property

The “family” property

The “family-set” property

The “font” property

The “font-desc” property

The “font-features” property

The “font-features-set” property

The “foreground” property

The “foreground-cdk” property

The “foreground-rgba” property

The “foreground-set” property

The “indent” property

The “indent-set” property

The “invisible” property

The “invisible-set” property

The “justification” property

The “justification-set” property

The “language” property

The “language-set” property

The “left-margin” property

The “left-margin-set” property

The “letter-spacing” property

The “letter-spacing-set” property

The “name” property

The “paragraph-background” property

The “paragraph-background-cdk” property

The “paragraph-background-rgba” property

The “paragraph-background-set” property

The `“accumulative-margin”` property

The `“background”` property

The `“background-cdk”` property

The `“background-full-height”` property

The `“background-full-height-set”` property

The `“background-rgba”` property

The `“background-set”` property

The `“direction”` property

The `“editable”` property

The `“editable-set”` property

The `“fallback”` property

The `“fallback-set”` property

The `“family”` property

The `“family-set”` property

The `“font”` property

The `“font-desc”` property

The `“font-features”` property

The `“font-features-set”` property

The `“foreground”` property

The `“foreground-cdk”` property

The `“foreground-rgba”` property

The `“foreground-set”` property

The `“indent”` property

The `“indent-set”` property

The `“invisible”` property

The `“invisible-set”` property

The `“justification”` property

The `“justification-set”` property

The `“language”` property

The `“language-set”` property

The `“left-margin”` property

The `“left-margin-set”` property

The `“letter-spacing”` property

The `“letter-spacing-set”` property

The `“name”` property

The `“paragraph-background”` property

The `“paragraph-background-cdk”` property

The `“paragraph-background-rgba”` property

The `“paragraph-background-set”` property

The `“pixels-above-lines”` property

The `“pixels-above-lines-set”` property

The `“pixels-below-lines”` property

The `“pixels-below-lines-set”` property

The `“pixels-inside-wrap”` property

The `“pixels-inside-wrap-set”` property

The `“right-margin”` property

The `“right-margin-set”` property

The `“rise”` property

The `“rise-set”` property

The `“scale”` property

The `“scale-set”` property

The `“size”` property

The `“size-points”` property

The `“size-set”` property

The `“stretch”` property

The `“stretch-set”` property

The `“strikethrough”` property

The `“strikethrough-rgba”` property

The `“strikethrough-rgba-set”` property

The `“strikethrough-set”` property

The `“style”` property

The `“style-set”` property

The `“tabs”` property

The `“tabs-set”` property

The `“underline”` property

The `“underline-rgba”` property

The `“underline-rgba-set”` property

The `“underline-set”` property

The `“variant”` property

The `“variant-set”` property

The `“weight”` property

The `“weight-set”` property

The `“wrap-mode”` property

The `“wrap-mode-set”` property

The `“event”` signal