@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/view.js

@@ -9,6 +9,70 @@ import { MarkAttributes } from "./mark-attributes.js";
 import { SpaceDrawer } from "./space-drawer.js";
 import { Snippet } from "./snippet.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * 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:
+ * ```xml
+ * <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.
+ *
+ * ```c
+ * 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);
+ * ```
+ * ```python
+ * 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 [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.
+ */
 const SIGNAL_META = {
     "change-case": {
         params: [{ type: { type: "int", size: 32, unsigned: false } }],
@@ -66,9 +130,25 @@ const SIGNAL_META = {
     },
 };
 export class View extends Gtk.TextView {
+    /**
+     * Creates a new `GtkSourceView`.
+     *
+     * By default, an empty [class@Buffer] will be lazily created and can be
+     * retrieved with [method@Gtk.TextView.get_buffer].
+     *
+     * If you want to specify your own buffer, either override the
+     * [vfunc@Gtk.TextView.create_buffer] factory method, or use
+     * [ctor@View.new_with_buffer].
+     */
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new #GtkSourceView widget displaying the buffer @buffer.
+     *
+     * One buffer can be shared among many widgets.
+     * @param buffer - a #GtkSourceBuffer.
+     */
     static viewNewWithBuffer(buffer) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_new_with_buffer", [
             {
@@ -84,6 +164,12 @@ export class View extends Gtk.TextView {
             borrowed: true,
         });
     }
+    /**
+     * Gets the [class@Annotations] associated with @view.
+     *
+     * The returned object is guaranteed to be the same for the lifetime of @view.
+     * Each [class@View] object has a different [class@Annotations].
+     */
     getAnnotations() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_annotations", [
             {
@@ -93,6 +179,9 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Annotations);
     }
+    /**
+     * Returns whether auto-indentation of text is enabled.
+     */
     getAutoIndent() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_auto_indent", [
             {
@@ -101,6 +190,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the #GtkSourceBackgroundPatternType specifying if and how
+     * the background pattern should be displayed for this @view.
+     */
     getBackgroundPattern() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_background_pattern", [
             {
@@ -109,6 +202,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the [class@Completion] associated with @view.
+     *
+     * The returned object is guaranteed to be the same for the lifetime of @view.
+     * Each `GtkSourceView` object has a different [class@Completion].
+     */
     getCompletion() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_completion", [
             {
@@ -118,6 +217,12 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Completion);
     }
+    /**
+     * Gets the [property@View:enable-snippets] property.
+     *
+     * If %TRUE, matching snippets found in the [class@SnippetManager]
+     * may be expanded when the user presses Tab after a word in the [class@View].
+     */
     getEnableSnippets() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_enable_snippets", [
             {
@@ -126,6 +231,14 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the [class@Gutter] object associated with `window_type` for @view.
+     *
+     * Only %GTK_TEXT_WINDOW_LEFT and %GTK_TEXT_WINDOW_RIGHT are supported,
+     * respectively corresponding to the left and right gutter. The line numbers
+     * and mark category icons are rendered in the left gutter.
+     * @param windowType - the gutter window type.
+     */
     getGutter(windowType) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_gutter", [
             {
@@ -139,6 +252,9 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gutter);
     }
+    /**
+     * Returns whether the current line is highlighted.
+     */
     getHighlightCurrentLine() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_highlight_current_line", [
             {
@@ -147,6 +263,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the [class@Hover] associated with @view.
+     *
+     * The returned object is guaranteed to be the same for the lifetime of @view.
+     * Each [class@View] object has a different [class@Hover].
+     */
     getHover() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_hover", [
             {
@@ -156,6 +278,10 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Hover);
     }
+    /**
+     * Returns whether when the tab key is pressed the current selection
+     * should get indented instead of replaced with the `\t` character.
+     */
     getIndentOnTab() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_indent_on_tab", [
             {
@@ -164,6 +290,11 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the number of spaces to use for each step of indent.
+     *
+     * See [method@View.set_indent_width] for details.
+     */
     getIndentWidth() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_indent_width", [
             {
@@ -172,6 +303,9 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the [property@View:indenter] property.
+     */
     getIndenter() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_indenter", [
             {
@@ -183,6 +317,10 @@ export class View extends Gtk.TextView {
             return null;
         return getObject(ptr, Indenter);
     }
+    /**
+     * Returns whether when inserting a tabulator character it should
+     * be replaced by a group of space characters.
+     */
     getInsertSpacesInsteadOfTabs() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_insert_spaces_instead_of_tabs", [
             {
@@ -191,6 +329,11 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets attributes and priority for the @category.
+     * @param category - the category.
+     * @param priority - place where priority of the category will be stored.
+     */
     getMarkAttributes(category, priority) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_mark_attributes", [
             {
@@ -208,6 +351,9 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, MarkAttributes);
     }
+    /**
+     * Gets the position of the right margin in the given @view.
+     */
     getRightMarginPosition() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_right_margin_position", [
             {
@@ -216,6 +362,9 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Returns whether line marks are displayed beside the text.
+     */
     getShowLineMarks() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_show_line_marks", [
             {
@@ -224,6 +373,9 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether line numbers are displayed beside the text.
+     */
     getShowLineNumbers() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_show_line_numbers", [
             {
@@ -232,6 +384,9 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns whether a right margin is displayed.
+     */
     getShowRightMargin() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_show_right_margin", [
             {
@@ -240,6 +395,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns %TRUE if pressing the Backspace key will try to delete spaces
+     * up to the previous tab stop.
+     */
     getSmartBackspace() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_smart_backspace", [
             {
@@ -248,6 +407,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns a [enum@SmartHomeEndType] end value specifying
+     * how the cursor will move when HOME and END keys are pressed.
+     */
     getSmartHomeEnd() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_smart_home_end", [
             {
@@ -256,6 +419,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the [class@SpaceDrawer] associated with @view.
+     *
+     * The returned object is guaranteed to be the same for the lifetime of @view.
+     * Each [class@View] object has a different [class@SpaceDrawer].
+     */
     getSpaceDrawer() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_view_get_space_drawer", [
             {
@@ -265,6 +434,9 @@ export class View extends Gtk.TextView {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, SpaceDrawer);
     }
+    /**
+     * Returns the width of tabulation in characters.
+     */
     getTabWidth() {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_tab_width", [
             {
@@ -273,6 +445,11 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Determines the visual column at `iter` taking into consideration the
+     * [property@View:tab-width] of @view.
+     * @param iter - a position in @view.
+     */
     getVisualColumn(iter) {
         return call("libgtksourceview-5.so.0", "gtk_source_view_get_visual_column", [
             {
@@ -290,6 +467,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Inserts one indentation level at the beginning of the specified lines. The
+     * empty lines are not indented.
+     * @param start - #GtkTextIter of the first line to indent
+     * @param end - #GtkTextIter of the last line to indent
+     */
     indentLines(start, end) {
         call("libgtksourceview-5.so.0", "gtk_source_view_indent_lines", [
             {
@@ -316,6 +499,14 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param snippet - a #GtkSourceSnippet
+     * @param location - a #GtkTextIter or %NULL for the cursor position
+     */
     pushSnippet(snippet, location) {
         call("libgtksourceview-5.so.0", "gtk_source_view_push_snippet", [
             {
@@ -338,6 +529,15 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param enable - whether to enable auto indentation.
+     */
     setAutoIndent(enable) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_auto_indent", [
             {
@@ -350,6 +550,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Set if and how the background pattern should be displayed.
+     * @param backgroundPattern - the #GtkSourceBackgroundPatternType.
+     */
     setBackgroundPattern(backgroundPattern) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_background_pattern", [
             {
@@ -362,6 +566,14 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the [property@View:enable-snippets] property.
+     *
+     * If `enable_snippets` is %TRUE, matching snippets found in the
+     * [class@SnippetManager] may be expanded when the user presses
+     * Tab after a word in the [class@View].
+     * @param enableSnippets - if snippets should be enabled
+     */
     setEnableSnippets(enableSnippets) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_enable_snippets", [
             {
@@ -374,6 +586,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * If `highlight` is %TRUE the current line will be highlighted.
+     * @param highlight - whether to highlight the current line.
+     */
     setHighlightCurrentLine(highlight) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_highlight_current_line", [
             {
@@ -386,6 +602,18 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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.
+     * @param enable - whether to indent a block when tab is pressed.
+     */
     setIndentOnTab(enable) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_indent_on_tab", [
             {
@@ -398,6 +626,31 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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 [property@View:tab-width] property
+     * will be used.
+     *
+     * The [property@View:indent-width] interacts with the
+     * [property@View:insert-spaces-instead-of-tabs] property and
+     * [property@View:tab-width]. An example will be clearer:
+     *
+     * If the [property@View:indent-width] is 4 and [property@View:tab-width] is 8 and
+     * [property@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 [property@View:tab-width] is 8). On the other hand, if
+     * [property@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
+     * [class@Gtk.TextBuffer].
+     *
+     * The test-widget program (available in the GtkSourceView repository) may be
+     * useful to better understand the indentation settings (enable the space
+     * drawing!).
+     * @param width - indent width in characters.
+     */
     setIndentWidth(width) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_indent_width", [
             {
@@ -410,6 +663,13 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the indenter for `view` to @indenter.
+     *
+     * Note that the indenter will not be used unless #GtkSourceView:auto-indent
+     * has been set to %TRUE.
+     * @param indenter - a #GtkSourceIndenter or %NULL
+     */
     setIndenter(indenter) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_indenter", [
             {
@@ -423,6 +683,13 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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
+     * [class@Gtk.TextBuffer] API.
+     * @param enable - whether to insert spaces instead of tabs.
+     */
     setInsertSpacesInsteadOfTabs(enable) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_insert_spaces_instead_of_tabs", [
             {
@@ -435,6 +702,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets attributes and priority for the @category.
+     * @param category - the category.
+     * @param attributes - mark attributes.
+     * @param priority - priority of the category.
+     */
     setMarkAttributes(category, attributes, priority) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_mark_attributes", [
             {
@@ -455,6 +728,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the position of the right margin in the given @view.
+     * @param pos - the width in characters where to position the right margin.
+     */
     setRightMarginPosition(pos) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_right_margin_position", [
             {
@@ -467,6 +744,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * If %TRUE line marks will be displayed beside the text.
+     * @param show - whether line marks should be displayed.
+     */
     setShowLineMarks(show) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_show_line_marks", [
             {
@@ -479,6 +760,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * If %TRUE line numbers will be displayed beside the text.
+     * @param show - whether line numbers should be displayed.
+     */
     setShowLineNumbers(show) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_show_line_numbers", [
             {
@@ -491,6 +776,10 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * If %TRUE a right margin is displayed.
+     * @param show - whether to show a right margin.
+     */
     setShowRightMargin(show) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_show_right_margin", [
             {
@@ -503,6 +792,11 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * When set to %TRUE, pressing the Backspace key will try to delete spaces
+     * up to the previous tab stop.
+     * @param smartBackspace - whether to enable smart Backspace handling.
+     */
     setSmartBackspace(smartBackspace) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_smart_backspace", [
             {
@@ -515,6 +809,11 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Set the desired movement of the cursor when HOME and END keys
+     * are pressed.
+     * @param smartHomeEnd - the desired behavior among #GtkSourceSmartHomeEndType.
+     */
     setSmartHomeEnd(smartHomeEnd) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_smart_home_end", [
             {
@@ -527,6 +826,13 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the width of tabulation in characters.
+     *
+     * The #GtkTextBuffer still contains `\t` characters,
+     * but they can take a different visual width in a [class@View] widget.
+     * @param width - width of tab in characters.
+     */
     setTabWidth(width) {
         call("libgtksourceview-5.so.0", "gtk_source_view_set_tab_width", [
             {
@@ -539,6 +845,12 @@ export class View extends Gtk.TextView {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes one indentation level at the beginning of the
+     * specified lines.
+     * @param start - #GtkTextIter of the first line to indent
+     * @param end - #GtkTextIter of the last line to indent
+     */
     unindentLines(start, end) {
         call("libgtksourceview-5.so.0", "gtk_source_view_unindent_lines", [
             {

package/dist/generated/gtksource/vim-imcontext.d.ts

@@ -4,8 +4,20 @@ import * as Gtk from "../gtk/index.js";
 export declare class VimIMContext extends Gtk.IMContext {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Executes `command` as if it was typed into the command bar by the
+     * user except that this does not emit the
+     * [signal@VimIMContext::execute-command] signal.
+     * @param command - the command text
+     */
     executeCommand(command: string): void;
+    /**
+     * Gets the current command-bar text as it is entered by the user.
+     */
     getCommandBarText(): string;
+    /**
+     * Gets the current command text as it is entered by the user.
+     */
     getCommandText(): string;
     connect(signal: "edit", handler: (self: VimIMContext, view: View, path: string) => void, after?: boolean): number;
     connect(signal: "execute-command", handler: (self: VimIMContext, command: string) => boolean, after?: boolean): number;