Package org.gnome.gtksourceview

Class Language

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.Language

All Implemented Interfaces:

Proxy

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

Represents a syntax highlighted language.

A GtkSourceLanguage represents a programming or markup language, affecting syntax highlighting and context classes.

Use LanguageManager to obtain a GtkSourceLanguage instance, and Buffer.setLanguage(org.gnome.gtksourceview.Language) to apply it to a Buffer.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Language	asParent()	Returns this instance as if it were its parent type.
static Language.Builder<? extends Language.Builder>	builder()	A Language.Builder object constructs a Language with the specified properties.
@Nullable String @Nullable []	getGlobs()	Returns the globs associated to this language.
boolean	getHidden()	Returns whether the language should be hidden from the user.
String	getId()	Returns the ID of the language.
@Nullable String	getMetadata(String name)
@Nullable String @Nullable []	getMimeTypes()	Returns the mime types associated to this language.
String	getName()	Returns the localized name of the language.
String	getSection()	Returns the localized section of the language.
@Nullable String	getStyleFallback(String styleId)	Returns the ID of the style to use if the specified styleId is not present in the current style scheme.
@Nullable String @Nullable []	getStyleIds()	Returns the ids of the styles defined by this language.
@Nullable String	getStyleName(String styleId)	Returns the name of the style with ID styleId defined by this language.
static @Nullable Type	getType()	Get the GType of the Language class

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, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Language

public Language(MemorySegment address)

Create a Language proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Language

public Language()

Creates a new Language.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Language class

Returns:

the GType

asParent

protected Language 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

getGlobs

public @Nullable String @Nullable [] getGlobs()

Returns the globs associated to this language.

This is just an utility wrapper around getMetadata(java.lang.String) to retrieve the "globs" metadata property and split it into an array.

Returns:

a newly-allocated null terminated array containing the globs or null if no globs are found. The returned array must be freed with g_strfreev().

getHidden

public boolean getHidden()

Returns whether the language should be hidden from the user.

Returns:

true if the language should be hidden, false otherwise.

getId

public String getId()

Returns the ID of the language.

The ID is not locale-dependent.The returned string is owned by this Language and should not be freed or modified.

Returns:

the ID of language.

getMetadata

public @Nullable String getMetadata(String name)

getMimeTypes

public @Nullable String @Nullable [] getMimeTypes()

Returns the mime types associated to this language.

This is just an utility wrapper around getMetadata(java.lang.String) to retrieve the "mimetypes" metadata property and split it into an array.

Returns:

a newly-allocated null terminated array containing the mime types or null if no mime types are found. The returned array must be freed with g_strfreev().

getName

public String getName()

Returns the localized name of the language.

The returned string is owned by this Language and should not be freed or modified.

Returns:

the name of language.

getSection

public String getSection()

Returns the localized section of the language.

Each language belong to a section (ex. HTML belongs to the Markup section). The returned string is owned by this Language and should not be freed or modified.

Returns:

the section of language.

getStyleFallback

public @Nullable String getStyleFallback(String styleId)

Returns the ID of the style to use if the specified styleId is not present in the current style scheme.

Parameters:

styleId - a style ID.

Returns:

the ID of the style to use if the specified styleId is not present in the current style scheme or null if the style has no fallback defined. The returned string is owned by the this Language and must not be modified.

getStyleIds

public @Nullable String @Nullable [] getStyleIds()

Returns the ids of the styles defined by this language.

Returns:

a newly-allocated null terminated array containing ids of the styles defined by this this Language or null if no style is defined. The returned array must be freed with g_strfreev().

getStyleName

public @Nullable String getStyleName(String styleId)

Returns the name of the style with ID styleId defined by this language.

Parameters:

styleId - a style ID.

Returns:

the name of the style with ID styleId defined by this this Language or null if the style has no name or there is no style with ID styleId defined by this language. The returned string is owned by the this Language and must not be modified.

builder

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

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

Returns:

the builder object