Package org.gnome.gtksourceview

Class SpaceDrawer

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.SpaceDrawer

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class SpaceDrawer
extends GObject

Represent white space characters with symbols.

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

Call View.getSpaceDrawer() to get the GtkSourceSpaceDrawer instance of a certain View.

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

To draw white spaces, setTypesForLocations(java.util.Set<org.gnome.gtksourceview.SpaceLocationFlags>, java.util.Set<org.gnome.gtksourceview.SpaceTypeFlags>) can be called to set the SpaceDrawer:matrix property (by default all space types are enabled at all locations). Then call setEnableMatrix(boolean).

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

Example
To draw non-breaking spaces everywhere and draw all types of trailing spaces except newlines:

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpaceDrawer.Builder<B extends SpaceDrawer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	SpaceDrawer.SpaceDrawerClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
SpaceDrawer()	Creates a new GtkSourceSpaceDrawer object.
SpaceDrawer(MemorySegment address)	Create a SpaceDrawer proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected SpaceDrawer	asParent()	Returns this instance as if it were its parent type.
void	bindMatrixSetting(Settings settings, String key, Set<SettingsBindFlags> flags)	Binds the SpaceDrawer:matrix property to a Settings key.
void	bindMatrixSetting(Settings settings, String key, SettingsBindFlags... flags)	Binds the SpaceDrawer:matrix property to a Settings key.
static SpaceDrawer.Builder<? extends SpaceDrawer.Builder>	builder()	A SpaceDrawer.Builder object constructs a SpaceDrawer with the specified properties.
boolean	getEnableMatrix()
Variant	getMatrix()	Gets the value of the SpaceDrawer:matrix property, as a GLib.Variant.
static Type	getType()	Get the GType of the SpaceDrawer class
Set<SpaceTypeFlags>	getTypesForLocations(Set<SpaceLocationFlags> locations)	If only one location is specified, this function returns what kind of white spaces are drawn at that location.
Set<SpaceTypeFlags>	getTypesForLocations(SpaceLocationFlags... locations)	If only one location is specified, this function returns what kind of white spaces are drawn at that location.
void	setEnableMatrix(boolean enableMatrix)	Sets whether the SpaceDrawer:matrix property is enabled.
void	setMatrix(@Nullable Variant matrix)	Sets a new value to the SpaceDrawer:matrix property, as a GLib.Variant.
void	setTypesForLocations(Set<SpaceLocationFlags> locations, Set<SpaceTypeFlags> types)	Modifies the SpaceDrawer:matrix property at the specified locations.
void	setTypesForLocations(SpaceLocationFlags locations, SpaceTypeFlags... types)	Modifies the SpaceDrawer:matrix property at the specified locations.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SpaceDrawer

public SpaceDrawer(MemorySegment address)

Create a SpaceDrawer proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SpaceDrawer

public SpaceDrawer()

Creates a new GtkSourceSpaceDrawer object.

Useful for storing space drawing settings independently of a View.

Method Details

getType

public static Type getType()

Get the GType of the SpaceDrawer class

Returns:

the GType

asParent

protected SpaceDrawer asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

bindMatrixSetting

public void bindMatrixSetting(Settings settings,
 String key,
 Set<SettingsBindFlags> flags)

Binds the SpaceDrawer:matrix property to a Settings key.

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

The Settings.bind(java.lang.String, org.gnome.gobject.GObject, java.lang.String, java.util.Set<org.gnome.gio.SettingsBindFlags>) 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).

Parameters:

settings - a GSettings object.

key - the settings key to bind.

flags - flags for the binding.

bindMatrixSetting

public void bindMatrixSetting(Settings settings,
 String key,
 SettingsBindFlags... flags)

Binds the SpaceDrawer:matrix property to a Settings key.

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

The Settings.bind(java.lang.String, org.gnome.gobject.GObject, java.lang.String, java.util.Set<org.gnome.gio.SettingsBindFlags>) 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).

Parameters:

settings - a GSettings object.

key - the settings key to bind.

flags - flags for the binding.

getEnableMatrix

public boolean getEnableMatrix()

getMatrix

public Variant getMatrix()

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

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

The getTypesForLocations(java.util.Set<org.gnome.gtksourceview.SpaceLocationFlags>) function may be more convenient to use.

Returns:

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

getTypesForLocations

public Set<SpaceTypeFlags> getTypesForLocations(Set<SpaceLocationFlags> locations)

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 SpaceDrawer: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.

Parameters:

locations - one or several GtkSourceSpaceLocationFlags.

Returns:

a combination of GtkSourceSpaceTypeFlags.

getTypesForLocations

public Set<SpaceTypeFlags> getTypesForLocations(SpaceLocationFlags... locations)

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 SpaceDrawer: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.

Parameters:

locations - one or several GtkSourceSpaceLocationFlags.

Returns:

a combination of GtkSourceSpaceTypeFlags.

setEnableMatrix

public void setEnableMatrix(boolean enableMatrix)

Sets whether the SpaceDrawer:matrix property is enabled.

Parameters:

enableMatrix - the new value.

setMatrix

public void setMatrix(@Nullable
 @Nullable Variant matrix)

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

If matrix is null, then an empty array is set.

If matrix is floating, it is consumed.

The setTypesForLocations(java.util.Set<org.gnome.gtksourceview.SpaceLocationFlags>, java.util.Set<org.gnome.gtksourceview.SpaceTypeFlags>) function may be more convenient to use.

Parameters:

matrix - the new matrix value, or null.

setTypesForLocations

public void setTypesForLocations(Set<SpaceLocationFlags> locations,
 Set<SpaceTypeFlags> types)

Modifies the SpaceDrawer:matrix property at the specified locations.

Parameters:

locations - one or several GtkSourceSpaceLocationFlags.

types - a combination of GtkSourceSpaceTypeFlags.

setTypesForLocations

public void setTypesForLocations(SpaceLocationFlags locations,
 SpaceTypeFlags... types)

Modifies the SpaceDrawer:matrix property at the specified locations.

Parameters:

locations - one or several GtkSourceSpaceLocationFlags.

types - a combination of GtkSourceSpaceTypeFlags.

builder

public static SpaceDrawer.Builder<? extends SpaceDrawer.Builder> builder()

A SpaceDrawer.Builder object constructs a SpaceDrawer with the specified properties. Use the various set...() methods to set properties, and finish construction with SpaceDrawer.Builder.build().