gtksource/org.gtkkn.bindings.gtksource/Map

Map

open class Map(pointer: <Error class: unknown class><<Error class: unknown class>>) : View

Widget that displays a map for a specific class@View.

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

This works by connecting a class@View to to the GtkSourceMap using the property@Map:view property or method@Map.set_view.

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

Additionally, it is desirable to match the font of the GtkSourceMap and the class@View used for editing. Therefore, property@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 method@Pango.FontDescription.set_size for how to alter the size of an existing struct@Pango.FontDescription.

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

Skipped during bindings generation

method font-desc: Property has no getter nor setter
method view: Property TypeInfo of getter and setter do not match

Constructors

Map

constructor()

Creates a new GtkSourceMap.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

autoIndent

open var autoIndent: Boolean

backgroundPattern

open var backgroundPattern: BackgroundPatternType

Draw a specific background pattern on the view.

completion

open val completion: Completion

The completion object associated with the view

enableSnippets

open var enableSnippets: Boolean

The property denotes if snippets should be expanded when the user presses Tab after having typed a word matching the snippets found in class@SnippetManager.

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkAccessibleTextPointer

open override val gtkAccessibleTextPointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

gtkScrollablePointer

open override val gtkScrollablePointer: <Error class: unknown class><<Error class: unknown class>>

gtksourceMapPointer

val gtksourceMapPointer: <Error class: unknown class><<Error class: unknown class>>

gtksourceViewPointer

val gtksourceViewPointer: <Error class: unknown class><<Error class: unknown class>>

highlightCurrentLine

open var highlightCurrentLine: Boolean

indenter

open var indenter: Indenter?

The property is a iface@Indenter to use to indent as the user types into the class@View.

indentOnTab

open var indentOnTab: Boolean

indentWidth

open var indentWidth: Int

Width of an indentation step expressed in number of spaces.

insertSpacesInsteadOfTabs

open var insertSpacesInsteadOfTabs: Boolean

rightMarginPosition

open var rightMarginPosition: <Error class: unknown class>

Position of the right margin.

showLineMarks

open var showLineMarks: Boolean

Whether to display line mark pixbufs

showLineNumbers

open var showLineNumbers: Boolean

Whether to display line numbers

showRightMargin

open var showRightMargin: Boolean

Whether to display the right margin.

smartBackspace

open var smartBackspace: Boolean

Whether smart Backspace should be used.

smartHomeEnd

open var smartHomeEnd: SmartHomeEndType

Set the behavior of the HOME and END keys.

spaceDrawer

open val spaceDrawer: SpaceDrawer

The class@SpaceDrawer object associated with the view.4

tabWidth

open var tabWidth: <Error class: unknown class>

Width of a tab character expressed in number of spaces.

Functions

connectChangeCase

fun connectChangeCase(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (caseType: ChangeCaseType) -> Unit): <Error class: unknown class>

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

connectChangeNumber

fun connectChangeNumber(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (count: Int) -> Unit): <Error class: unknown class>

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

connectJoinLines

fun connectJoinLines(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Keybinding signal to join the lines currently selected.

connectLineMarkActivated

fun connectLineMarkActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>, nPresses: Int) -> Unit): <Error class: unknown class>

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

connectMoveLines

fun connectMoveLines(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (down: Boolean) -> Unit): <Error class: unknown class>

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

connectMoveToMatchingBracket

fun connectMoveToMatchingBracket(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (extendSelection: Boolean) -> Unit): <Error class: unknown class>

Keybinding signal to move the cursor to the matching bracket.

connectMoveWords

fun connectMoveWords(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (count: Int) -> Unit): <Error class: unknown class>

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

connectShowCompletion

fun connectShowCompletion(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

The signal is a key binding signal which gets emitted when the user requests a completion, by pressing Controlspace.

connectSmartHomeEnd

fun connectSmartHomeEnd(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, count: Int) -> Unit): <Error class: unknown class>

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

getAutoIndent

open fun getAutoIndent(): Boolean

Returns whether auto-indentation of text is enabled.

getBackgroundPattern

open fun getBackgroundPattern(): BackgroundPatternType

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

getCompletion

open fun getCompletion(): Completion

Gets the class@Completion associated with @view.

getEnableSnippets

open fun getEnableSnippets(): Boolean

Gets the property@View:enable-snippets property.

getHighlightCurrentLine

open fun getHighlightCurrentLine(): Boolean

Returns whether the current line is highlighted.

getHover

open fun getHover(): Hover

Gets the class@Hover associated with @view.

getIndenter

open fun getIndenter(): Indenter?

Gets the property@View:indenter property.

getIndentOnTab

open fun getIndentOnTab(): Boolean

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

getIndentWidth

open fun getIndentWidth(): Int

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

getInsertSpacesInsteadOfTabs

open fun getInsertSpacesInsteadOfTabs(): Boolean

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

getRightMarginPosition

open fun getRightMarginPosition(): <Error class: unknown class>

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

getShowLineMarks

open fun getShowLineMarks(): Boolean

Returns whether line marks are displayed beside the text.

getShowLineNumbers

open fun getShowLineNumbers(): Boolean

Returns whether line numbers are displayed beside the text.

getShowRightMargin

open fun getShowRightMargin(): Boolean

Returns whether a right margin is displayed.

getSmartBackspace

open fun getSmartBackspace(): Boolean

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

getSmartHomeEnd

open fun getSmartHomeEnd(): SmartHomeEndType

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

getSpaceDrawer

open fun getSpaceDrawer(): SpaceDrawer

Gets the class@SpaceDrawer associated with @view.

getTabWidth

open fun getTabWidth(): <Error class: unknown class>

Returns the width of tabulation in characters.

getView

open fun getView(): View?

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

getVisualColumn

open fun getVisualColumn(iter: <Error class: unknown class>): <Error class: unknown class>

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

indentLines

open fun indentLines(start: <Error class: unknown class>, end: <Error class: unknown class>)

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

pushSnippet

open fun pushSnippet(snippet: Snippet, location: <Error class: unknown class>? = null)

Inserts a new snippet at @location

setAutoIndent

open fun setAutoIndent(enable: Boolean)

If true auto-indentation of text is enabled.

setBackgroundPattern

open fun setBackgroundPattern(backgroundPattern: BackgroundPatternType)

Set if and how the background pattern should be displayed.

setEnableSnippets

open fun setEnableSnippets(enableSnippets: Boolean)

Sets the property@View:enable-snippets property.

setHighlightCurrentLine

open fun setHighlightCurrentLine(highlight: Boolean)

If @highlight is true the current line will be highlighted.

setIndenter

open fun setIndenter(indenter: Indenter? = null)

Sets the indenter for @view to @indenter.

setIndentOnTab

open fun setIndentOnTab(enable: Boolean)

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.

setIndentWidth

open fun setIndentWidth(width: Int)

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

setInsertSpacesInsteadOfTabs

open fun setInsertSpacesInsteadOfTabs(enable: Boolean)

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

setMarkAttributes