Class StyleScheme

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.StyleScheme

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class StyleScheme
extends GObject

Controls the appearance of View.

GtkSourceStyleScheme contains all the text styles to be used in View and Buffer. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, color for the line numbers, current line highlighting, bracket matching, etc.

Style schemes are stored in XML files. The format of a scheme file is documented in the style scheme reference.

The two style schemes with IDs "classic" and "tango" follow more closely the GTK theme (for example for the background color).

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
StyleScheme()	Create a new StyleScheme.
StyleScheme(MemorySegment address)	Create a StyleScheme instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected StyleScheme	asParent()	Return this instance as if it were its parent type.
static StyleScheme.Builder<? extends StyleScheme.Builder>	builder()	A StyleScheme.Builder object constructs a StyleScheme with the specified properties.
@Nullable String @Nullable []	getAuthors()
@Nullable String	getDescription()
@Nullable String	getFilename()
String	getId()
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable String	getMetadata(String name)	Gets a metadata property from the style scheme.
String	getName()
@Nullable Style	getStyle(String styleId)
static @Nullable Type	getType()	Get the GType of the StyleScheme class.

Methods inherited from class 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, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

StyleScheme

public StyleScheme(MemorySegment address)

Create a StyleScheme instance for the provided memory address.

Parameters:

address - the memory address of the native object

StyleScheme

public StyleScheme()

Create a new StyleScheme.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the StyleScheme class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected StyleScheme asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

getAuthors

public @Nullable String @Nullable [] getAuthors()

getDescription

public @Nullable String getDescription()

getFilename

public @Nullable String getFilename()

getId

public String getId()

getMetadata

public @Nullable String getMetadata(String name)

Gets a metadata property from the style scheme.

Parameters:

name - metadata property name.

Returns:

value of property name stored in the metadata of this StyleScheme or null if this StyleScheme does not contain the specified metadata property.

Since:

5.4

getName

public String getName()

getStyle

public @Nullable Style getStyle(String styleId)

builder

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

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

Returns:

the builder object