Package org.gnome.gtksourceview

Class Mark

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.TextMark

org.gnome.gtksourceview.Mark

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class Mark
extends TextMark

Mark object for Buffer.

A GtkSourceMark marks a position in the text where you want to display additional info. It is based on TextMark and thus is still valid after the text has changed though its position may change.

GtkSourceMarks are organized in categories which you have to set when you create the mark. Each category can have a priority, a pixbuf and other associated attributes. See View.setMarkAttributes(java.lang.String, org.gnome.gtksourceview.MarkAttributes, int). The pixbuf will be displayed in the margin at the line where the mark residents if the View:show-line-marks property is set to true. If there are multiple marks in the same line, the pixbufs will be drawn on top of each other. The mark with the highest priority will be drawn on top.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.TextMark

TextMark.TextMarkClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Mark()	Creates a new Mark.
Mark(@Nullable String name, String category)	Creates a text mark.
Mark(MemorySegment address)	Create a Mark proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Mark	asParent()	Returns this instance as if it were its parent type.
static Mark.Builder<? extends Mark.Builder>	builder()	A Mark.Builder object constructs a Mark with the specified properties.
String	getCategory()	Returns the mark category.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Mark class
@Nullable Mark	next(@Nullable String category)	Returns the next GtkSourceMark in the buffer or null if the mark was not added to a buffer.
@Nullable Mark	prev(@Nullable String category)	Returns the previous GtkSourceMark in the buffer or null if the mark was not added to a buffer.

Methods inherited from class org.gnome.gtk.TextMark

getBuffer, getDeleted, getLeftGravity, getName, getVisible, setVisible

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, 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

Mark

public Mark(MemorySegment address)

Create a Mark proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Mark

public Mark(@Nullable String name,
 String category)

Creates a text mark.

Add it to a buffer using TextBuffer.addMark(org.gnome.gtk.TextMark, org.gnome.gtk.TextIter). If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved by name using TextBuffer.getMark(java.lang.String). Normally marks are created using the utility function Buffer.createSourceMark(java.lang.String, java.lang.String, org.gnome.gtk.TextIter).

Parameters:

name - Name of the GtkSourceMark or null

category - is used to classify marks according to common characteristics (e.g. all the marks representing a bookmark could belong to the "bookmark" category, or all the marks representing a compilation error could belong to "error" category).

Mark

public Mark()

Creates a new Mark.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Mark class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Mark 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 TextMark

getCategory

public String getCategory()

Returns the mark category.

Returns:

the category of the GtkSourceMark.

next

public @Nullable Mark next(@Nullable String category)

Returns the next GtkSourceMark in the buffer or null if the mark was not added to a buffer.

If there is no next mark, null will be returned.

If category is null, looks for marks of any category.

Parameters:

category - a string specifying the mark category, or null.

Returns:

the next GtkSourceMark, or null.

prev

public @Nullable Mark prev(@Nullable String category)

Returns the previous GtkSourceMark in the buffer or null if the mark was not added to a buffer.

If there is no previous mark, null is returned.

If category is null, looks for marks of any category

Parameters:

category - a string specifying the mark category, or null.

Returns:

the previous GtkSourceMark, or null.

builder

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

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

Returns:

the builder object