Package org.gnome.gtksourceview

Class Map

java.lang.Object

io.github.jwharm.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

org.gnome.gtksourceview.Map

All Implemented Interfaces:

Proxy, Accessible, AccessibleText, Buildable, ConstraintTarget, Scrollable

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

Widget that displays a map for a specific View.

GtkSourceMap is a widget that maps the content of a View into a smaller view so the user can have a quick overview of the whole document.

This works by connecting a View to to the GtkSourceMap using the Map:view property or setView(org.gnome.gtksourceview.View).

GtkSourceMap is a View object. This means that you can add a GutterRenderer to a gutter in the same way you would for a View. One example might be a GutterRenderer that shows which lines have changed in the document.

Additionally, it is desirable to match the font of the GtkSourceMap and the View used for editing. Therefore, Map:font-desc should be used to set the target font. You will need to adjust this to the desired font size for the map. A 1pt font generally seems to be an appropriate font size. "Monospace 1" is the default. See FontDescription.setSize(int) for how to alter the size of an existing Pango.FontDescription.

When FontConfig is available, GtkSourceMap will try to use a bundled "block" font to make the map more legible.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtksourceview.View

View.ChangeCaseCallback, View.ChangeNumberCallback, View.JoinLinesCallback, View.LineMarkActivatedCallback, View.MoveLinesCallback, View.MoveToMatchingBracketCallback, View.MoveWordsCallback, View.PushSnippetCallback, View.ShowCompletionCallback, View.SmartHomeEndCallback, 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.WidgetClass, Widget.WidgetImpl

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.AccessibleImpl, Accessible.AccessibleInterface

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

AccessibleText.AccessibleTextImpl, AccessibleText.AccessibleTextInterface

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

Buildable.BuildableIface, Buildable.BuildableImpl

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

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

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

Scrollable.ScrollableImpl, Scrollable.ScrollableInterface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Map	asParent()	Returns this instance as if it were its parent type.
static Map.Builder<? extends Map.Builder>	builder()	A Map.Builder object constructs a Map with the specified properties.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static Type	getType()	Get the GType of the Map class
View	getView()	Gets the Map:view property, which is the view this widget is mapping.
void	setView(View view)	Sets the view that this Map will be doing the mapping to.

Methods inherited from class org.gnome.gtksourceview.View

emitChangeCase, emitChangeNumber, emitJoinLines, emitLineMarkActivated, emitMoveLines, emitMoveToMatchingBracket, emitMoveWords, emitPushSnippet, emitShowCompletion, emitSmartHomeEnd, getAutoIndent, getBackgroundPattern, getCompletion, getEnableSnippets, getGutter, getHighlightCurrentLine, getHover, getIndenter, getIndentOnTab, getIndentWidth, getInsertSpacesInsteadOfTabs, getMarkAttributes, getRightMarginPosition, getShowLineMarks, getShowLineNumbers, getShowRightMargin, getSmartBackspace, getSmartHomeEnd, getSpaceDrawer, getTabWidth, getVisualColumn, indentLines, lineMarkActivated, moveLines, moveWords, onChangeCase, onChangeNumber, onJoinLines, onLineMarkActivated, onMoveLines, onMoveToMatchingBracket, onMoveWords, onPushSnippet, onShowCompletion, onSmartHomeEnd, pushSnippet, setAutoIndent, setBackgroundPattern, setEnableSnippets, setHighlightCurrentLine, setIndenter, setIndentOnTab, setIndentWidth, setInsertSpacesInsteadOfTabs, setMarkAttributes, setRightMarginPosition, setShowLineMarks, setShowLineNumbers, setShowRightMargin, setSmartBackspace, setSmartHomeEnd, setTabWidth, showCompletion, unindentLines, withBuffer

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

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, 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 io.github.jwharm.javagi.base.Proxy

handle

Methods inherited from interface org.gnome.gtk.Scrollable

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

Constructor Details

Map

public Map(MemorySegment address)

Create a Map proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Map

public Map()

Creates a new GtkSourceMap.

Method Details

getType

public static Type getType()

Get the GType of the Map class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getView

public View getView()

Gets the Map:view property, which is the view this widget is mapping.

Returns:

a GtkSourceView or null.

setView

public void setView(View view)

Sets the view that this Map will be doing the mapping to.

Parameters:

view - a GtkSourceView

builder

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

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