Struct sourceview5::SpaceDrawer

pub struct SpaceDrawer { /* private fields */ }

Represent white space characters with symbols.

#GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing symbols.

Call ViewExt::space_drawer() to get the SpaceDrawer instance of a certain View.

By default, no white spaces are drawn because the enable-matrix is false.

To draw white spaces, set_types_for_locations() can be called to set the matrix property (by default all space types are enabled at all locations). Then call set_enable_matrix().

For a finer-grained method, there is also the Tag’s draw-spaces property.

Example

To draw non-breaking spaces everywhere and draw all types of trailing spaces except newlines: ⚠️ The following code is in c ⚠️

gtk_source_space_drawer_set_types_for_locations (space_drawer,
                                                 GTK_SOURCE_SPACE_LOCATION_ALL,
                                                 GTK_SOURCE_SPACE_TYPE_NBSP);

gtk_source_space_drawer_set_types_for_locations (space_drawer,
                                                 GTK_SOURCE_SPACE_LOCATION_TRAILING,
                                                 GTK_SOURCE_SPACE_TYPE_ALL &
                                                 ~GTK_SOURCE_SPACE_TYPE_NEWLINE);

gtk_source_space_drawer_set_enable_matrix (space_drawer, TRUE);

Use-case: draw unwanted white spaces

A possible use-case is to draw only unwanted white spaces. Examples:

• Draw all trailing spaces.
• If the indentation and alignment must be done with spaces, draw tabs.

And non-breaking spaces can always be drawn, everywhere, to distinguish them from normal spaces.

Properties

enable-matrix

Whether the matrix property is enabled.

Readable | Writeable | Construct

matrix

The property is a glib::Variant property to specify where and what kind of white spaces to draw.

The glib::Variant is of type "au", an array of unsigned integers. Each integer is a combination of SpaceTypeFlags. There is one integer for each SpaceLocationFlags, in the same order as they are defined in the enum (SpaceLocationFlags::NONE and SpaceLocationFlags::ALL are not taken into account).

If the array is shorter than the number of locations, then the value for the missing locations will be SpaceTypeFlags::NONE.

By default, SpaceTypeFlags::ALL is set for all locations.4

Readable | Writeable | Construct

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SpaceDrawer

pub fn new() -> SpaceDrawer

Creates a new #GtkSourceSpaceDrawer object.

Useful for storing space drawing settings independently of a View.

Returns

a new #GtkSourceSpaceDrawer.

pub fn builder() -> SpaceDrawerBuilder

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

This method returns an instance of SpaceDrawerBuilder which can be used to create SpaceDrawer objects.

pub fn bind_matrix_setting( &self, settings: &impl IsA<Settings>, key: &str, flags: SettingsBindFlags, )

Binds the matrix property to a gio::Settings key.

The gio::Settings key must be of the same type as the matrix property, that is, "au".

The SettingsExtManual::bind() function cannot be used, because the default GIO mapping functions don’t support glib::Variant properties (maybe it will be supported by a future GIO version, in which case this function can be deprecated).

settings

a #GSettings object.

key

the @settings key to bind.

flags

flags for the binding.

pub fn enables_matrix(&self) -> bool

Returns

whether the #GtkSourceSpaceDrawer:matrix property is enabled.

pub fn matrix(&self) -> Variant

Gets the value of the matrix property, as a glib::Variant.

An empty array can be returned in case the matrix is a zero matrix.

The types_for_locations() function may be more convenient to use.

Returns

the #GtkSourceSpaceDrawer:matrix value as a new floating #GVariant instance.

pub fn types_for_locations( &self, locations: SpaceLocationFlags, ) -> SpaceTypeFlags

If only one location is specified, this function returns what kind of white spaces are drawn at that location.

The value is retrieved from the matrix property.

If several locations are specified, this function returns the logical AND for those locations. Which means that if a certain kind of white space is present in the return value, then that kind of white space is drawn at all the specified @locations.

locations

one or several #GtkSourceSpaceLocationFlags.

Returns

a combination of #GtkSourceSpaceTypeFlags.

pub fn set_enable_matrix(&self, enable_matrix: bool)

Sets whether the matrix property is enabled.

enable_matrix

the new value.

pub fn set_matrix(&self, matrix: Option<&Variant>)

Sets a new value to the matrix property, as a glib::Variant.

If @matrix is None, then an empty array is set.

If @matrix is floating, it is consumed.

The set_types_for_locations() function may be more convenient to use.

matrix

the new matrix value, or None.

pub fn set_types_for_locations( &self, locations: SpaceLocationFlags, types: SpaceTypeFlags, )

Modifies the matrix property at the specified @locations.

locations

one or several #GtkSourceSpaceLocationFlags.

types

a combination of #GtkSourceSpaceTypeFlags.

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

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

Trait Implementations

impl Clone for SpaceDrawer

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 SpaceDrawer

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

Formats the value using the given formatter.

impl Default for SpaceDrawer

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SpaceDrawer

type ParamSpec = ParamSpecObject

type SetValue = SpaceDrawer

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SpaceDrawer

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 SpaceDrawer

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 SpaceDrawer

type Parent = Object

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

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 SpaceDrawer

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 SpaceDrawer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SpaceDrawer