Struct sourceview5::MarkAttributes

pub struct MarkAttributes { /* private fields */ }

The source mark attributes object.

MarkAttributes is an object specifying attributes used by a View to visually show lines marked with Marks 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 set_background(). To check if any custom background color was defined and what color it is, use 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 render_icon() must be called. There are several ways to specify a base for an icon:

• set_icon_name()
• set_gicon()
• 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 query-tooltip-text or query-tooltip-markup where the latter takes precedence.

Properties

background

A color used for background of a line.

Readable | Writeable

gicon

A #GIcon that may be a base of a rendered icon.

Readable | Writeable

icon-name

An icon name that may be a base of a rendered icon.

Readable | Writeable

pixbuf

A #GdkPixbuf that may be a base of a rendered icon.

Readable | Writeable

Signals

query-tooltip-markup

The code should connect to this signal to provide a tooltip for given @mark. The tooltip can contain a markup.

query-tooltip-text

The code should connect to this signal to provide a tooltip for given @mark. The tooltip should be just a plain text.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl MarkAttributes

pub fn new() -> MarkAttributes

Creates a new source mark attributes.

Returns

a new source mark attributes.

pub fn builder() -> MarkAttributesBuilder

Creates a new builder-pattern struct instance to construct MarkAttributes objects.

This method returns an instance of MarkAttributesBuilder which can be used to create MarkAttributes objects.

pub fn background(&self) -> Option<RGBA>

Stores background color in @background.

Returns

whether background color for @self was set.

background

a #GdkRGBA.

pub fn gicon(&self) -> Icon

Gets a gio::Icon to be used as a base for rendered icon.

Note that the icon can be None if it wasn’t set earlier.

Returns

An icon. The icon belongs to @self and should not be unreffed.

pub fn icon_name(&self) -> GString

Gets a name of an icon to be used as a base for rendered icon.

Note that the icon name can be None if it wasn’t set earlier.

Returns

An icon name. The string belongs to @self and should not be freed.

pub fn pixbuf(&self) -> Pixbuf

Gets a gdk_pixbuf::Pixbuf to be used as a base for rendered icon.

Note that the pixbuf can be None if it wasn’t set earlier.

Returns

A pixbuf. The pixbuf belongs to @self and should not be unreffed.

pub fn tooltip_markup(&self, mark: &impl IsA<Mark>) -> GString

Queries for a tooltip by emitting a query-tooltip-markup signal.

The tooltip may contain a markup.

mark

a #GtkSourceMark.

Returns

A tooltip. The returned string should be freed by using g_free() when done with it.

pub fn tooltip_text(&self, mark: &impl IsA<Mark>) -> GString

Queries for a tooltip by emitting a query-tooltip-text signal.

The tooltip is a plain text.

mark

a #GtkSourceMark.

Returns

A tooltip. The returned string should be freed by using g_free() when done with it.

pub fn render_icon(&self, widget: &impl IsA<Widget>, size: i32) -> Paintable

Renders an icon of given size.

The base of the icon is set by the last call to one of:

• set_pixbuf()
• set_gicon()
• set_icon_name()

@size cannot be lower than 1.

widget

widget of which style settings may be used.

size

size of the rendered icon.

Returns

A #GdkPaintable. The paintable belongs to @self and should not be unreffed.

pub fn set_background(&self, background: &RGBA)

Sets background color to the one given in @background.

background

a #GdkRGBA.

pub fn set_gicon(&self, gicon: &impl IsA<Icon>)

Sets an icon to be used as a base for rendered icon.

gicon

a #GIcon to be used.

pub fn set_icon_name(&self, icon_name: &str)

Sets a name of an icon to be used as a base for rendered icon.

icon_name

name of an icon to be used.

pub fn set_pixbuf(&self, pixbuf: &Pixbuf)

Sets a pixbuf to be used as a base for rendered icon.

pixbuf

a #GdkPixbuf to be used.

pub fn connect_query_tooltip_markup<F: Fn(&Self, &Mark) -> String + 'static>( &self, f: F, ) -> SignalHandlerId

The code should connect to this signal to provide a tooltip for given @mark. The tooltip can contain a markup.

mark

The #GtkSourceMark.

Returns

A tooltip. The string should be freed with g_free() when done with it.

pub fn connect_query_tooltip_text<F: Fn(&Self, &Mark) -> String + 'static>( &self, f: F, ) -> SignalHandlerId

The code should connect to this signal to provide a tooltip for given @mark. The tooltip should be just a plain text.

mark

The #GtkSourceMark.

Returns

A tooltip. The string should be freed with g_free() when done with it.

pub fn connect_background_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_gicon_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_icon_name_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_pixbuf_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for MarkAttributes

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkAttributes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MarkAttributes

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for MarkAttributes

type ParamSpec = ParamSpecObject

type SetValue = MarkAttributes

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MarkAttributes>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MarkAttributes

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MarkAttributes

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for MarkAttributes

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for MarkAttributes

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for MarkAttributes

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MarkAttributes

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MarkAttributes