gtksource/org.gtkkn.bindings.gtksource/View

View

open class View(val gtksourceViewPointer: <Error class: unknown class><<Error class: unknown class>>)

Subclass of class@Gtk.TextView.

GtkSourceView is the main class of the GtkSourceView library. Use a class@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 iface@Gtk.Buildable interface exposes the property@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 class@Map to scale the desired font.

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

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

Skipped during bindings generation

parameter priority: Unsupported pointer to primitive type
signal push-snippet: Unsupported parameter location : location: In/Out parameter is not supported

Inheritors

Map

Constructors

View

constructor()

Creates a new GtkSourceView.

constructor(buffer: Buffer)

Creates a new #GtkSourceView widget displaying the buffer @buffer.

constructor(gtksourceViewPointer: <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 val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkAccessibleTextPointer

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

gtkBuildablePointer

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

gtkConstraintTargetPointer

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

gtkScrollablePointer

open val gtkScrollablePointer: <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.

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.

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.