gtksource/org.gtkkn.bindings.gtksource/Map

Map

open class Map(val gtksourceMapPointer: <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(gtksourceMapPointer: <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: <Error class: unknown class>

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

emitChangeCase

fun emitChangeCase(caseType: ChangeCaseType)

Emits the "change-case" signal. See onChangeCase.

emitChangeNumber

fun emitChangeNumber(count: <Error class: unknown class>)

Emits the "change-number" signal. See onChangeNumber.

emitJoinLines

fun emitJoinLines()

Emits the "join-lines" signal. See onJoinLines.

emitLineMarkActivated

fun emitLineMarkActivated(iter: <Error class: unknown class>, button: <Error class: unknown class>, state: <Error class: unknown class>, nPresses: <Error class: unknown class>)

Emits the "line-mark-activated" signal. See onLineMarkActivated.

emitMoveLines

fun emitMoveLines(down: Boolean)

Emits the "move-lines" signal. See onMoveLines.

emitMoveToMatchingBracket

fun emitMoveToMatchingBracket(extendSelection: Boolean)

Emits the "move-to-matching-bracket" signal. See onMoveToMatchingBracket.

emitMoveWords

fun emitMoveWords(count: <Error class: unknown class>)

Emits the "move-words" signal. See onMoveWords.

emitShowCompletion

fun emitShowCompletion()

Emits the "show-completion" signal. See onShowCompletion.

emitSmartHomeEnd

fun emitSmartHomeEnd(iter: <Error class: unknown class>, count: <Error class: unknown class>)

Emits the "smart-home-end" signal. See onSmartHomeEnd.

getGutterView

open fun getGutterView(windowType: <Error class: unknown class>): Gutter

Returns the class@Gutter object associated with @window_type for @view.

getHover

open fun getHover(): Hover

Gets the class@Hover associated with @view.

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.

onChangeCase

fun onChangeCase(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.

onChangeNumber

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

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

onJoinLines

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

Keybinding signal to join the lines currently selected.

onLineMarkActivated

fun onLineMarkActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>, <Error class: unknown class>) -> 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).

onMoveLines

fun onMoveLines(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.

onMoveToMatchingBracket

fun onMoveToMatchingBracket(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.

onMoveWords

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

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

onShowCompletion

fun onShowCompletion(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.

onSmartHomeEnd

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

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

pushSnippet

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

Inserts a new snippet at @location

setMarkAttributes

open fun setMarkAttributes(category: String, attributes: MarkAttributes, priority: <Error class: unknown class>)

Sets attributes and priority for the @category.

setView

open fun setView(view: View)

Sets the view that @map will be doing the mapping to.

unindentLines

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

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