MarkAttributes

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_source_mark_attributes_get_type ()" ) ]
public sealed class MarkAttributes : Object

The source mark attributes object.

`GtkSourceMarkAttributes` is an object specifying attributes used by a [class@View] to visually show lines marked with [class@Mark]s of a specific category. It allows you to define a background color of a line, an icon shown in gutter and tooltips.

The background color is used as a background of a line where a mark is placed and it can be set with [method@MarkAttributes.set_background]. To check if any custom background color was defined and what color it is, use [method@MarkAttributes.get_background].

An icon is a graphic element which is shown in the gutter of a view. An example use is showing a red filled circle in a debugger to show that a breakpoint was set in certain line. To get an icon that will be placed in a gutter, first a base for it must be specified and then [ method@MarkAttributes.render_icon] must be called. There are several ways to specify a base for an icon:

[method@MarkAttributes.set_icon_name]
[method@MarkAttributes.set_gicon]
[method@MarkAttributes.set_pixbuf]

Using any of the above functions overrides the one used earlier. But note that a getter counterpart of earlier used function can still return some value, but it is just not used when rendering the proper icon.

To provide meaningful tooltips for a given mark of a category, you should connect to [signal@MarkAttributes:GtkSourceMarkAttributes:query-tooltip-text] or [signal@MarkAttributes:GtkSourceMarkAttributes:query-tooltip-markup] where the latter takes precedence.

Namespace: GtkSource

Package: gtksourceview-5

Content:

Properties:

public RGBA background { owned get; set; }
A color used for background of a line.
public Icon gicon { get; set; }
A Icon that may be a base of a rendered icon.
public string icon_name { get; set; }
An icon name that may be a base of a rendered icon.
public Pixbuf pixbuf { get; set; }
A Pixbuf that may be a base of a rendered icon.

Creation methods:

public MarkAttributes ()
Creates a new source mark attributes.

Methods:

public bool get_background (out RGBA background)
Stores background color in background.
public unowned Icon get_gicon ()
Gets a [iface@Gio.
public unowned string get_icon_name ()
Gets a name of an icon to be used as a base for rendered icon.
public unowned Pixbuf get_pixbuf ()
Gets a [class@GdkPixbuf.
public string get_tooltip_markup (Mark mark)
Queries for a tooltip by emitting a [signal@MarkAttributes:GtkSourceMarkAttributes:query-tooltip-markup] signal.
public string get_tooltip_text (Mark mark)
Queries for a tooltip by emitting a [signal@MarkAttributes:GtkSourceMarkAttributes:query-tooltip-text] signal.
public unowned Paintable render_icon (Widget widget, int size)
Renders an icon of given size.
public void set_background (RGBA background)
Sets background color to the one given in background.
public void set_gicon (Icon gicon)
Sets an icon to be used as a base for rendered icon.
public void set_icon_name (string icon_name)
Sets a name of an icon to be used as a base for rendered icon.
public void set_pixbuf (Pixbuf pixbuf)
Sets a pixbuf to be used as a base for rendered icon.

Signals:

public signal string query_tooltip_markup (Mark mark)
The code should connect to this signal to provide a tooltip for given mark.
public signal string query_tooltip_text (Mark mark)
The code should connect to this signal to provide a tooltip for given mark.

Inherited Members:

All known members inherited from class GLib.Object