Package org.gnome.gtksourceview

Class View

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.gtk.TextView

org.gnome.gtksourceview.View

All Implemented Interfaces:

Accessible, AccessibleText, Buildable, ConstraintTarget, Scrollable, Proxy

Direct Known Subclasses:

Map

@Generated("io.github.jwharm.JavaGI")
public class View
extends TextView
implements Accessible, AccessibleText, Buildable, ConstraintTarget, Scrollable

Subclass of TextView.

GtkSourceView is the main class of the GtkSourceView library. Use a Buffer to display text with a GtkSourceView.

This class provides:

• Show the line numbers;
• Show a right margin;
• Highlight the current line;
• Indentation settings;
• Configuration for the Home and End keyboard keys;
• Configure and show line marks;
• And a few other things.

An easy way to test all these features is to use the test-widget mini-program provided in the GtkSourceView repository, in the tests/ directory.

GtkSourceView as GtkBuildable
The GtkSourceView implementation of the Buildable interface exposes the View:completion object with the internal-child "completion".

An example of a UI definition fragment with GtkSourceView:

<object class="GtkSourceView" id="source_view">
   <property name="tab-width">4</property>
   <property name="auto-indent">True</property>
   <child internal-child="completion">
     <object class="GtkSourceCompletion">
       <property name="select-on-show">False</property>
     </object>
   </child>
 </object>
 

Changing the Font
Gtk CSS provides the best way to change the font for a GtkSourceView in a manner that allows for components like Map to scale the desired font.

GtkCssProvider *provider = gtk_css_provider_new ();
 gtk_css_provider_load_from_string (provider,
                                   "textview { font-family: Monospace; font-size: 8pt; }");
 gtk_style_context_add_provider (gtk_widget_get_style_context (view),
                                 GTK_STYLE_PROVIDER (provider),
                                 GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
 g_object_unref (provider);
 

provider = Gtk.CssProvider()
 provider.load_from_string("textview { font-family: Monospace; font-size: 8pt; }")
 style_context = view.get_style_context()
 style_context.add_provider(provider, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION)
 

If you need to adjust the font or size of font within a portion of the document only, you should use a TextTag with the Gtk.TextTag:family or Gtk.TextTag:scale set so that the font size may be scaled relative to the default font set in CSS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	View.Builder<B extends View.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	View.ChangeCaseCallback	Functional interface declaration of the ChangeCaseCallback callback.
static interface	View.ChangeNumberCallback	Functional interface declaration of the ChangeNumberCallback callback.
static interface	View.JoinLinesCallback	Functional interface declaration of the JoinLinesCallback callback.
static interface	View.LineMarkActivatedCallback	Functional interface declaration of the LineMarkActivatedCallback callback.
static interface	View.MoveLinesCallback	Functional interface declaration of the MoveLinesCallback callback.
static interface	View.MoveToMatchingBracketCallback	Functional interface declaration of the MoveToMatchingBracketCallback callback.
static interface	View.MoveWordsCallback	Functional interface declaration of the MoveWordsCallback callback.
static interface	View.PushSnippetCallback	Functional interface declaration of the PushSnippetCallback callback.
static interface	View.ShowCompletionCallback	Functional interface declaration of the ShowCompletionCallback callback.
static interface	View.SmartHomeEndCallback	Functional interface declaration of the SmartHomeEndCallback callback.
static class	View.ViewClass

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

TextView.BackspaceCallback, TextView.CopyClipboardCallback, TextView.CutClipboardCallback, TextView.DeleteFromCursorCallback, TextView.ExtendSelectionCallback, TextView.InsertAtCursorCallback, TextView.InsertEmojiCallback, TextView.MoveCursorCallback, TextView.MoveViewportCallback, TextView.PasteClipboardCallback, TextView.PreeditChangedCallback, TextView.SelectAllCallback, TextView.SetAnchorCallback, TextView.TextViewClass, TextView.ToggleCursorVisibleCallback, TextView.ToggleOverwriteCallback

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

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.Widget$Impl, Widget.WidgetClass

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

InitiallyUnowned.InitiallyUnownedClass

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.Accessible$Impl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.AccessibleText

AccessibleText.AccessibleText$Impl, AccessibleText.AccessibleTextInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.Buildable$Impl, Buildable.BuildableIface

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTarget$Impl, ConstraintTarget.ConstraintTargetInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Scrollable

Scrollable.Scrollable$Impl, Scrollable.ScrollableInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected View	asParent()	Returns this instance as if it were its parent type.
static View.Builder<? extends View.Builder>	builder()	A View.Builder object constructs a View with the specified properties.
void	emitChangeCase(ChangeCaseType caseType)	Emits the "change-case" signal.
void	emitChangeNumber(int count)	Emits the "change-number" signal.
void	emitJoinLines()	Emits the "join-lines" signal.
void	emitLineMarkActivated(@Nullable TextIter iter, int button, Set<ModifierType> state, int nPresses)	Emits the "line-mark-activated" signal.
void	emitMoveLines(boolean down)	Emits the "move-lines" signal.
void	emitMoveToMatchingBracket(boolean extendSelection)	Emits the "move-to-matching-bracket" signal.
void	emitMoveWords(int count)	Emits the "move-words" signal.
void	emitPushSnippet(@Nullable Snippet snippet, @Nullable TextIter location)	Emits the "push-snippet" signal.
void	emitShowCompletion()	Emits the "show-completion" signal.
void	emitSmartHomeEnd(@Nullable TextIter iter, int count)	Emits the "smart-home-end" signal.
Annotations	getAnnotations()	Gets the Annotations associated with view.
boolean	getAutoIndent()	Returns whether auto-indentation of text is enabled.
BackgroundPatternType	getBackgroundPattern()	Returns the GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this view.
Completion	getCompletion()	Gets the Completion associated with view.
boolean	getEnableSnippets()	Gets the View:enable-snippets property.
Gutter	getGutter(TextWindowType windowType)	Returns the Gutter object associated with windowType for view.
boolean	getHighlightCurrentLine()	Returns whether the current line is highlighted.
Hover	getHover()	Gets the Hover associated with view.
@Nullable Indenter	getIndenter()	Gets the View:indenter property.
boolean	getIndentOnTab()	Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \\t character.
int	getIndentWidth()	Returns the number of spaces to use for each step of indent.
boolean	getInsertSpacesInsteadOfTabs()	Returns whether when inserting a tabulator character it should be replaced by a group of space characters.
MarkAttributes	getMarkAttributes(String category, MemorySegment priority)	Gets attributes and priority for the category.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	getRightMarginPosition()	Gets the position of the right margin in the given view.
boolean	getShowLineMarks()	Returns whether line marks are displayed beside the text.
boolean	getShowLineNumbers()	Returns whether line numbers are displayed beside the text.
boolean	getShowRightMargin()	Returns whether a right margin is displayed.
boolean	getSmartBackspace()	Returns true if pressing the Backspace key will try to delete spaces up to the previous tab stop.
SmartHomeEndType	getSmartHomeEnd()	Returns a SmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.
SpaceDrawer	getSpaceDrawer()	Gets the SpaceDrawer associated with view.
int	getTabWidth()	Returns the width of tabulation in characters.
static @Nullable Type	getType()	Get the GType of the View class
int	getVisualColumn(TextIter iter)	Determines the visual column at iter taking into consideration the View:tab-width of view.
void	indentLines(TextIter start, TextIter end)	Inserts one indentation level at the beginning of the specified lines.
protected void	lineMarkActivated(TextIter iter, int button, Set<ModifierType> state, int nPresses)
protected void	moveLines(boolean down)
protected void	moveWords(int step)
SignalConnection<View.ChangeCaseCallback>	onChangeCase(View.ChangeCaseCallback handler)	Keybinding signal to change case of the text at the current cursor position.
SignalConnection<View.ChangeNumberCallback>	onChangeNumber(View.ChangeNumberCallback handler)	Keybinding signal to edit a number at the current cursor position.
SignalConnection<View.JoinLinesCallback>	onJoinLines(View.JoinLinesCallback handler)	Keybinding signal to join the lines currently selected.
SignalConnection<View.LineMarkActivatedCallback>	onLineMarkActivated(View.LineMarkActivatedCallback handler)	Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).
SignalConnection<View.MoveLinesCallback>	onMoveLines(View.MoveLinesCallback handler)	The signal is a keybinding which gets emitted when the user initiates moving a line.
SignalConnection<View.MoveToMatchingBracketCallback>	onMoveToMatchingBracket(View.MoveToMatchingBracketCallback handler)	Keybinding signal to move the cursor to the matching bracket.
SignalConnection<View.MoveWordsCallback>	onMoveWords(View.MoveWordsCallback handler)	The signal is a keybinding which gets emitted when the user initiates moving a word.
SignalConnection<View.PushSnippetCallback>	onPushSnippet(View.PushSnippetCallback handler)	The signal is emitted to insert a new snippet into the view.
SignalConnection<View.ShowCompletionCallback>	onShowCompletion(View.ShowCompletionCallback handler)	The signal is a key binding signal which gets emitted when the user requests a completion, by pressing <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>.
SignalConnection<View.SmartHomeEndCallback>	onSmartHomeEnd(View.SmartHomeEndCallback handler)	Emitted when a the cursor was moved according to the smart home end setting.
void	pushSnippet(Snippet snippet, @Nullable TextIter location)	Inserts a new snippet at location
void	setAutoIndent(boolean enable)	If true auto-indentation of text is enabled.
void	setBackgroundPattern(BackgroundPatternType backgroundPattern)	Set if and how the background pattern should be displayed.
void	setEnableSnippets(boolean enableSnippets)	Sets the View:enable-snippets property.
void	setHighlightCurrentLine(boolean highlight)	If highlight is true the current line will be highlighted.
void	setIndenter(@Nullable Indenter indenter)	Sets the indenter for this View to indenter.
void	setIndentOnTab(boolean enable)	If true, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a \\t character.
void	setIndentWidth(int width)	Sets the number of spaces to use for each step of indent when the tab key is pressed.
void	setInsertSpacesInsteadOfTabs(boolean enable)	If true a tab key pressed is replaced by a group of space characters.
void	setMarkAttributes(String category, MarkAttributes attributes, int priority)	Sets attributes and priority for the category.
void	setRightMarginPosition(int pos)	Sets the position of the right margin in the given view.
void	setShowLineMarks(boolean show)	If true line marks will be displayed beside the text.
void	setShowLineNumbers(boolean show)	If true line numbers will be displayed beside the text.
void	setShowRightMargin(boolean show)	If true a right margin is displayed.
void	setSmartBackspace(boolean smartBackspace)	When set to true, pressing the Backspace key will try to delete spaces up to the previous tab stop.
void	setSmartHomeEnd(SmartHomeEndType smartHomeEnd)	Set the desired movement of the cursor when HOME and END keys are pressed.
void	setTabWidth(int width)	Sets the width of tabulation in characters.
protected void	showCompletion()
void	unindentLines(TextIter start, TextIter end)	Removes one indentation level at the beginning of the specified lines.
static View	withBuffer(Buffer buffer)	Creates a new GtkSourceView widget displaying the buffer buffer.

Methods inherited from class org.gnome.gtk.TextView

addChildAtAnchor, addOverlay, backspace, backwardDisplayLine, backwardDisplayLineStart, bufferToWindowCoords, copyClipboard, createBuffer, cutClipboard, deleteFromCursor, emitBackspace, emitCopyClipboard, emitCutClipboard, emitDeleteFromCursor, emitExtendSelection, emitInsertAtCursor, emitInsertEmoji, emitMoveCursor, emitMoveViewport, emitPasteClipboard, emitPreeditChanged, emitSelectAll, emitSetAnchor, emitToggleCursorVisible, emitToggleOverwrite, extendSelection, forwardDisplayLine, forwardDisplayLineEnd, getAcceptsTab, getBottomMargin, getBuffer, getCursorLocations, getCursorVisible, getEditable, getExtraMenu, getIndent, getInputHints, getInputPurpose, getIterAtLocation, getIterAtPosition, getIterLocation, getJustification, getLeftMargin, getLineAtY, getLineYrange, getLtrContext, getMonospace, getOverwrite, getPixelsAboveLines, getPixelsBelowLines, getPixelsInsideWrap, getRightMargin, getRtlContext, getTabs, getTopMargin, getVisibleOffset, getVisibleRect, getWrapMode, imContextFilterKeypress, insertAtCursor, insertEmoji, moveCursor, moveMarkOnscreen, moveOverlay, moveVisually, onBackspace, onCopyClipboard, onCutClipboard, onDeleteFromCursor, onExtendSelection, onInsertAtCursor, onInsertEmoji, onMoveCursor, onMoveViewport, onPasteClipboard, onPreeditChanged, onSelectAll, onSetAnchor, onToggleCursorVisible, onToggleOverwrite, pasteClipboard, placeCursorOnscreen, remove, resetCursorBlink, resetImContext, scrollMarkOnscreen, scrollToIter, scrollToMark, setAcceptsTab, setAnchor, setBottomMargin, setBuffer, setCursorVisible, setEditable, setExtraMenu, setGutter, setIndent, setInputHints, setInputHints, setInputPurpose, setJustification, setLeftMargin, setMonospace, setOverwrite, setPixelsAboveLines, setPixelsBelowLines, setPixelsInsideWrap, setRightMargin, setTabs, setTopMargin, setWrapMode, snapshotLayer, startsDisplayLine, toggleOverwrite, windowToBufferCoords, withBuffer

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.AccessibleText

updateCaretPosition, updateContents, updateSelectionBound

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface org.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.Scrollable

getBorder, getHadjustment, getHscrollPolicy, getVadjustment, getVscrollPolicy, setHadjustment, setHscrollPolicy, setVadjustment, setVscrollPolicy

Constructor Details

View

public View(MemorySegment address)

Create a View proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

View

public View()

Creates a new View.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the View class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected View 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 TextView

withBuffer

public static View withBuffer(Buffer buffer)

Creates a new GtkSourceView widget displaying the buffer buffer.

One buffer can be shared among many widgets.

Parameters:

buffer - a GtkSourceBuffer.

Returns:

a new GtkSourceView.

getAnnotations

public Annotations getAnnotations()

Gets the Annotations associated with view.

The returned object is guaranteed to be the same for the lifetime of view. Each View object has a different Annotations.

Returns:

the GtkSourceAnnotations associated with view.

Since:

5.18

getAutoIndent

public boolean getAutoIndent()

Returns whether auto-indentation of text is enabled.

Returns:

true if auto indentation is enabled.

getBackgroundPattern

public BackgroundPatternType getBackgroundPattern()

Returns the GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this view.

Returns:

the GtkSourceBackgroundPatternType.

getCompletion

public Completion getCompletion()

Gets the Completion associated with view.

The returned object is guaranteed to be the same for the lifetime of view. Each GtkSourceView object has a different Completion.

Returns:

the GtkSourceCompletion associated with view.

getEnableSnippets

public boolean getEnableSnippets()

Gets the View:enable-snippets property.

If true, matching snippets found in the SnippetManager may be expanded when the user presses Tab after a word in the View.

Returns:

true if enabled

getGutter

public Gutter getGutter(TextWindowType windowType)

Returns the Gutter object associated with windowType for view.

Only TextWindowType.LEFT and TextWindowType.RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the left gutter.

Overrides:

getGutter in class TextView

Parameters:

windowType - the gutter window type.

Returns:

the GtkSourceGutter.

getHighlightCurrentLine

public boolean getHighlightCurrentLine()

Returns whether the current line is highlighted.

Returns:

true if the current line is highlighted.

getHover

public Hover getHover()

Gets the Hover associated with view.

The returned object is guaranteed to be the same for the lifetime of view. Each View object has a different Hover.

Returns:

a GtkSourceHover associated with view.

getIndentOnTab

public boolean getIndentOnTab()

Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \\t character.

Returns:

true if the selection is indented when tab is pressed.

getIndentWidth

public int getIndentWidth()

Returns the number of spaces to use for each step of indent.

See setIndentWidth(int) for details.

Returns:

indent width.

getIndenter

public @Nullable Indenter getIndenter()

Gets the View:indenter property.

Returns:

a GtkSourceIndenter or null

getInsertSpacesInsteadOfTabs

public boolean getInsertSpacesInsteadOfTabs()

Returns whether when inserting a tabulator character it should be replaced by a group of space characters.

Returns:

true if spaces are inserted instead of tabs.

getMarkAttributes

public MarkAttributes getMarkAttributes(String category,
 MemorySegment priority)

Gets attributes and priority for the category.

Parameters:

category - the category.

priority - place where priority of the category will be stored.

Returns:

GtkSourceMarkAttributes for the category. The object belongs to view, so it must not be unreffed.

getRightMarginPosition

public int getRightMarginPosition()

Gets the position of the right margin in the given view.

Returns:

the position of the right margin.

getShowLineMarks

public boolean getShowLineMarks()

Returns whether line marks are displayed beside the text.

Returns:

true if the line marks are displayed.

getShowLineNumbers

public boolean getShowLineNumbers()

Returns whether line numbers are displayed beside the text.

Returns:

true if the line numbers are displayed.

getShowRightMargin

public boolean getShowRightMargin()

Returns whether a right margin is displayed.

Returns:

true if the right margin is shown.

getSmartBackspace

public boolean getSmartBackspace()

Returns true if pressing the Backspace key will try to delete spaces up to the previous tab stop.

Returns:

true if smart Backspace handling is enabled.

getSmartHomeEnd

public SmartHomeEndType getSmartHomeEnd()

Returns a SmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.

Returns:

a GtkSourceSmartHomeEndType value.

getSpaceDrawer

public SpaceDrawer getSpaceDrawer()

Gets the SpaceDrawer associated with view.

The returned object is guaranteed to be the same for the lifetime of view. Each View object has a different SpaceDrawer.

Returns:

the GtkSourceSpaceDrawer associated with view.

getTabWidth

public int getTabWidth()

Returns the width of tabulation in characters.

Returns:

width of tab.

getVisualColumn

public int getVisualColumn(TextIter iter)

Determines the visual column at iter taking into consideration the View:tab-width of view.

Parameters:

iter - a position in view.

Returns:

the visual column at iter.

indentLines

public void indentLines(TextIter start,
 TextIter end)

Inserts one indentation level at the beginning of the specified lines. The empty lines are not indented.

Parameters:

start - GtkTextIter of the first line to indent

end - GtkTextIter of the last line to indent

pushSnippet

public void pushSnippet(Snippet snippet,
 @Nullable TextIter location)

Inserts a new snippet at location

If another snippet was already active, it will be paused and the new snippet will become active. Once the focus positions of snippet have been exhausted, editing will return to the previous snippet.

Parameters:

snippet - a GtkSourceSnippet

location - a GtkTextIter or null for the cursor position

setAutoIndent

public void setAutoIndent(boolean enable)

If true auto-indentation of text is enabled.

When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is not a "smart indentation" where an indentation level is added or removed depending on the context.

Parameters:

enable - whether to enable auto indentation.

setBackgroundPattern

public void setBackgroundPattern(BackgroundPatternType backgroundPattern)

Set if and how the background pattern should be displayed.

Parameters:

backgroundPattern - the GtkSourceBackgroundPatternType.

setEnableSnippets

public void setEnableSnippets(boolean enableSnippets)

Sets the View:enable-snippets property.

If enableSnippets is true, matching snippets found in the SnippetManager may be expanded when the user presses Tab after a word in the View.

Parameters:

enableSnippets - if snippets should be enabled

setHighlightCurrentLine

public void setHighlightCurrentLine(boolean highlight)

If highlight is true the current line will be highlighted.

Parameters:

highlight - whether to highlight the current line.

setIndentOnTab

public void setIndentOnTab(boolean enable)

If true, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a \\t character. Shift+Tab unindents the selection.

If the first or last line is not selected completely, it is also indented or unindented.

When the selection doesn't span several lines, the tab key always replaces the selection with a normal \\t character.

Parameters:

enable - whether to indent a block when tab is pressed.

setIndentWidth

public void setIndentWidth(int width)

Sets the number of spaces to use for each step of indent when the tab key is pressed.

If width is -1, the value of the View:tab-width property will be used.

The View:indent-width interacts with the View:insert-spaces-instead-of-tabs property and View:tab-width. An example will be clearer:

If the View:indent-width is 4 and View:tab-width is 8 and View:insert-spaces-instead-of-tabs is false, then pressing the tab key at the beginning of a line will insert 4 spaces. So far so good. Pressing the tab key a second time will remove the 4 spaces and insert a \\t character instead (since View:tab-width is 8). On the other hand, if View:insert-spaces-instead-of-tabs is true, the second tab key pressed will insert 4 more spaces for a total of 8 spaces in the TextBuffer.

The test-widget program (available in the GtkSourceView repository) may be useful to better understand the indentation settings (enable the space drawing!).

Parameters:

width - indent width in characters.

setIndenter

public void setIndenter(@Nullable Indenter indenter)

Sets the indenter for this View to indenter.

Note that the indenter will not be used unless GtkSourceView:auto-indent has been set to true.

Parameters:

indenter - a GtkSourceIndenter or null

setInsertSpacesInsteadOfTabs

public void setInsertSpacesInsteadOfTabs(boolean enable)

If true a tab key pressed is replaced by a group of space characters.

Of course it is still possible to insert a real \\t programmatically with the TextBuffer API.

Parameters:

enable - whether to insert spaces instead of tabs.

setMarkAttributes

public void setMarkAttributes(String category,
 MarkAttributes attributes,
 int priority)

Sets attributes and priority for the category.

Parameters:

category - the category.

attributes - mark attributes.

priority - priority of the category.

setRightMarginPosition

public void setRightMarginPosition(int pos)

Sets the position of the right margin in the given view.

Parameters:

pos - the width in characters where to position the right margin.

setShowLineMarks

public void setShowLineMarks(boolean show)

If true line marks will be displayed beside the text.

Parameters:

show - whether line marks should be displayed.

setShowLineNumbers

public void setShowLineNumbers(boolean show)

If true line numbers will be displayed beside the text.

Parameters:

show - whether line numbers should be displayed.

setShowRightMargin

public void setShowRightMargin(boolean show)

If true a right margin is displayed.

Parameters:

show - whether to show a right margin.

setSmartBackspace

public void setSmartBackspace(boolean smartBackspace)

When set to true, pressing the Backspace key will try to delete spaces up to the previous tab stop.

Parameters:

smartBackspace - whether to enable smart Backspace handling.

setSmartHomeEnd

public void setSmartHomeEnd(SmartHomeEndType smartHomeEnd)

Set the desired movement of the cursor when HOME and END keys are pressed.

Parameters:

smartHomeEnd - the desired behavior among GtkSourceSmartHomeEndType.

setTabWidth

public void setTabWidth(int width)

Sets the width of tabulation in characters.

The GtkTextBuffer still contains \\t characters, but they can take a different visual width in a View widget.

Parameters:

width - width of tab in characters.

unindentLines

public void unindentLines(TextIter start,
 TextIter end)

Removes one indentation level at the beginning of the specified lines.

Parameters:

start - GtkTextIter of the first line to indent

end - GtkTextIter of the last line to indent

lineMarkActivated

protected void lineMarkActivated(TextIter iter,
 int button,
 Set<ModifierType> state,
 int nPresses)

moveLines

protected void moveLines(boolean down)

moveWords

protected void moveWords(int step)

showCompletion

protected void showCompletion()

onChangeCase

public SignalConnection<View.ChangeCaseCallback> onChangeCase(View.ChangeCaseCallback handler)

Keybinding signal to change case of the text at the current cursor position.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.ChangeCaseCallback.run(org.gnome.gtksourceview.ChangeCaseType)

emitChangeCase

public void emitChangeCase(ChangeCaseType caseType)

Emits the "change-case" signal. See onChangeCase(org.gnome.gtksourceview.View.ChangeCaseCallback).

onChangeNumber

public SignalConnection<View.ChangeNumberCallback> onChangeNumber(View.ChangeNumberCallback handler)

Keybinding signal to edit a number at the current cursor position.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.ChangeNumberCallback.run(int)

emitChangeNumber

public void emitChangeNumber(int count)

Emits the "change-number" signal. See onChangeNumber(org.gnome.gtksourceview.View.ChangeNumberCallback).

onJoinLines

public SignalConnection<View.JoinLinesCallback> onJoinLines(View.JoinLinesCallback handler)

Keybinding signal to join the lines currently selected.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.JoinLinesCallback.run()

emitJoinLines

public void emitJoinLines()

Emits the "join-lines" signal. See onJoinLines(org.gnome.gtksourceview.View.JoinLinesCallback).

onLineMarkActivated

public SignalConnection<View.LineMarkActivatedCallback> onLineMarkActivated(View.LineMarkActivatedCallback handler)

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).

You can use iter to determine on which line the activation took place.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.LineMarkActivatedCallback.run(org.gnome.gtk.TextIter, int, java.util.Set<org.gnome.gdk.ModifierType>, int)

emitLineMarkActivated

public void emitLineMarkActivated(@Nullable TextIter iter,
 int button,
 Set<ModifierType> state,
 int nPresses)

Emits the "line-mark-activated" signal. See onLineMarkActivated(org.gnome.gtksourceview.View.LineMarkActivatedCallback).

onMoveLines

public SignalConnection<View.MoveLinesCallback> onMoveLines(View.MoveLinesCallback handler)

The signal is a keybinding which gets emitted when the user initiates moving a line.

The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line up or down by one line.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.MoveLinesCallback.run(boolean)

emitMoveLines

public void emitMoveLines(boolean down)

Emits the "move-lines" signal. See onMoveLines(org.gnome.gtksourceview.View.MoveLinesCallback).

onMoveToMatchingBracket

public SignalConnection<View.MoveToMatchingBracketCallback> onMoveToMatchingBracket(View.MoveToMatchingBracketCallback handler)

Keybinding signal to move the cursor to the matching bracket.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.MoveToMatchingBracketCallback.run(boolean)

emitMoveToMatchingBracket

public void emitMoveToMatchingBracket(boolean extendSelection)

Emits the "move-to-matching-bracket" signal. See onMoveToMatchingBracket(org.gnome.gtksourceview.View.MoveToMatchingBracketCallback).

onMoveWords

public SignalConnection<View.MoveWordsCallback> onMoveWords(View.MoveWordsCallback handler)

The signal is a keybinding which gets emitted when the user initiates moving a word.

The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current word by one word.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.MoveWordsCallback.run(int)

emitMoveWords

public void emitMoveWords(int count)

Emits the "move-words" signal. See onMoveWords(org.gnome.gtksourceview.View.MoveWordsCallback).

onPushSnippet

public SignalConnection<View.PushSnippetCallback> onPushSnippet(View.PushSnippetCallback handler)

The signal is emitted to insert a new snippet into the view.

If another snippet was active, it will be paused until all focus positions of snippet have been exhausted.

location will be updated to point at the end of the snippet.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.PushSnippetCallback.run(org.gnome.gtksourceview.Snippet, org.gnome.gtk.TextIter)

emitPushSnippet

public void emitPushSnippet(@Nullable Snippet snippet,
 @Nullable TextIter location)

Emits the "push-snippet" signal. See onPushSnippet(org.gnome.gtksourceview.View.PushSnippetCallback).

onShowCompletion

public SignalConnection<View.ShowCompletionCallback> onShowCompletion(View.ShowCompletionCallback handler)

The signal is a key binding signal which gets emitted when the user requests a completion, by pressing <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo>.

This will create a CompletionContext with the activation type as CompletionActivation.USER_REQUESTED.

Applications should not connect to it, but may emit it with GObjects.signalEmitByName(org.gnome.gobject.GObject, java.lang.String, java.lang.Object...) if they need to activate the completion by another means, for example with another key binding or a menu entry.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.ShowCompletionCallback.run()

emitShowCompletion

public void emitShowCompletion()

Emits the "show-completion" signal. See onShowCompletion(org.gnome.gtksourceview.View.ShowCompletionCallback).

onSmartHomeEnd

public SignalConnection<View.SmartHomeEndCallback> onSmartHomeEnd(View.SmartHomeEndCallback handler)

Emitted when a the cursor was moved according to the smart home end setting.

The signal is emitted after the cursor is moved, but during the Gtk.TextView::move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• View.SmartHomeEndCallback.run(org.gnome.gtk.TextIter, int)

emitSmartHomeEnd

public void emitSmartHomeEnd(@Nullable TextIter iter,
 int count)

Emits the "smart-home-end" signal. See onSmartHomeEnd(org.gnome.gtksourceview.View.SmartHomeEndCallback).

builder

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

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

Returns:

the builder object