@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/completion-context.js

@@ -6,6 +6,24 @@ import { Language } from "./language.js";
 import { View } from "./view.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * The context of a completion.
+ *
+ * `GtkSourceCompletionContext` contains information about an attept to display
+ * completion proposals to the user based on typed text in the [class@View].
+ *
+ * When typing, [class@Completion] may use registered
+ * [iface@CompletionProvider] to determine if there may be results which
+ * could be displayed. If so, a `GtkSourceCompletionContext` is created with
+ * information that is provided to the [iface@CompletionProvider] to populate
+ * results which might be useful to the user.
+ *
+ * [iface@CompletionProvider] are expected to provide [iface@Gio.ListModel] with
+ * [iface@CompletionProposal] which may be joined together in a list of
+ * results for the user. They are also responsible for how the contents are
+ * displayed using [class@CompletionCell] which allows for some level of
+ * customization.
+ */
 const SIGNAL_META = {
     "provider-model-changed": {
         params: [
@@ -29,6 +47,9 @@ export class CompletionContext extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the mode for which the context was activated.
+     */
     getActivation() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_activation", [
             {
@@ -37,6 +58,19 @@ export class CompletionContext extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the bounds for the completion, which is the beginning of the
+     * current word (taking break characters into account) to the current
+     * insertion cursor.
+     *
+     * If `begin` is non-%NULL, it will be set to the start position of the
+     * current word being completed.
+     *
+     * If `end` is non-%NULL, it will be set to the insertion cursor for the
+     * current word being completed.
+     * @param begin - a #GtkTextIter
+     * @param end - a #GtkTextIter
+     */
     getBounds(begin, end) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_bounds", [
             {
@@ -69,6 +103,12 @@ export class CompletionContext extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the underlying buffer used by the context.
+     *
+     * This is a convenience function to get the buffer via the #GtkSourceCompletion
+     * property.
+     */
     getBuffer() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_buffer", [
             {
@@ -80,6 +120,11 @@ export class CompletionContext extends GObject.GObject {
             return null;
         return getObject(ptr, Buffer);
     }
+    /**
+     * Gets the "busy" property. This is set to %TRUE while the completion
+     * context is actively fetching proposals from registered
+     * #GtkSourceCompletionProvider's.
+     */
     getBusy() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_busy", [
             {
@@ -88,6 +133,9 @@ export class CompletionContext extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the #GtkSourceCompletion that created the context.
+     */
     getCompletion() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_completion", [
             {
@@ -99,6 +147,11 @@ export class CompletionContext extends GObject.GObject {
             return null;
         return getObject(ptr, Completion);
     }
+    /**
+     * Checks if any proposals have been provided to the context.
+     *
+     * Out of convenience, this function will return %TRUE if `self` is %NULL.
+     */
     getEmpty() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_empty", [
             {
@@ -107,6 +160,9 @@ export class CompletionContext extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the language of the underlying buffer, if any.
+     */
     getLanguage() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_language", [
             {
@@ -118,6 +174,13 @@ export class CompletionContext extends GObject.GObject {
             return null;
         return getObject(ptr, Language);
     }
+    /**
+     * Gets the #GListModel associated with the provider.
+     *
+     * You can connect to #GtkSourceCompletionContext::model-changed to receive
+     * notifications about when the model has been replaced by a new model.
+     * @param provider - a #GtkSourceCompletionProvider
+     */
     getProposalsForProvider(provider) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_proposals_for_provider", [
             {
@@ -133,6 +196,9 @@ export class CompletionContext extends GObject.GObject {
             return null;
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * Gets the text view for the context.
+     */
     getView() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_view", [
             {
@@ -144,6 +210,9 @@ export class CompletionContext extends GObject.GObject {
             return null;
         return getObject(ptr, View);
     }
+    /**
+     * Gets the word that is being completed up to the position of the insert mark.
+     */
     getWord() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_context_get_word", [
             {
@@ -152,6 +221,9 @@ export class CompletionContext extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Gets the providers that are associated with the context.
+     */
     listProviders() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_context_list_providers", [
             {
@@ -161,6 +233,16 @@ export class CompletionContext extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * This function allows providers to update their results for a context
+     * outside of a call to [method@CompletionProvider.populate_async].
+     *
+     * This can be used to immediately return results for a provider while it does
+     * additional asynchronous work. Doing so will allow the completions to
+     * update while the operation is in progress.
+     * @param provider - an #GtkSourceCompletionProvider
+     * @param results - a #GListModel or %NULL
+     */
     setProposalsForProvider(provider, results) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_context_set_proposals_for_provider", [
             {

package/dist/generated/gtksource/completion-proposal.d.ts

@@ -1,6 +1,23 @@
+/**
+ * Interface for completion proposals.
+ *
+ * This interface is used to denote that an object is capable of being
+ * a completion proposal for [class@Completion].
+ *
+ * Currently, no method or functions are required but additional methods
+ * may be added in the future. Proposals created by
+ * #GtkSourceCompletionProvider can use [func@GObject.IMPLEMENT_INTERFACE] to
+ * implement this with %NULL for the interface init function.
+ */
 export declare class CompletionProposal {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): CompletionProposal;
+    /**
+     * Gets the typed-text for the proposal, if supported by the implementation.
+     *
+     * Implementing this virtual-function is optional, but can be useful to allow
+     * external tooling to compare results.
+     */
     getTypedText(): string | null;
 }

package/dist/generated/gtksource/completion-proposal.js

@@ -1,4 +1,15 @@
 import { call } from "@gtkx/native";
+/**
+ * Interface for completion proposals.
+ *
+ * This interface is used to denote that an object is capable of being
+ * a completion proposal for [class@Completion].
+ *
+ * Currently, no method or functions are required but additional methods
+ * may be added in the future. Proposals created by
+ * #GtkSourceCompletionProvider can use [func@GObject.IMPLEMENT_INTERFACE] to
+ * implement this with %NULL for the interface init function.
+ */
 export class CompletionProposal {
     ptr;
     constructor(ptr) {
@@ -7,6 +18,12 @@ export class CompletionProposal {
     static fromPtr(ptr) {
         return new CompletionProposal(ptr);
     }
+    /**
+     * Gets the typed-text for the proposal, if supported by the implementation.
+     *
+     * Implementing this virtual-function is optional, but can be useful to allow
+     * external tooling to compare results.
+     */
     getTypedText() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_proposal_get_typed_text", [
             {

package/dist/generated/gtksource/completion-provider.d.ts

@@ -5,17 +5,115 @@ import * as GLib from "../glib/index.js";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * Completion provider interface.
+ *
+ * You must implement this interface to provide proposals to [class@Completion].
+ *
+ * In most cases, implementations of this interface will want to use
+ * [vfunc@CompletionProvider.populate_async] to asynchronously populate the results
+ * to avoid blocking the main loop.
+ */
 export declare class CompletionProvider {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): CompletionProvider;
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context: CompletionContext, proposal: CompletionProposal): void;
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context: CompletionContext, proposal: CompletionProposal, cell: CompletionCell): void;
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context: CompletionContext): number;
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle(): string | null;
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter: Gtk.TextIter, ch: number): boolean;
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context: CompletionContext, proposal: CompletionProposal, keyval: number, state: Gdk.ModifierType): boolean;
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context: CompletionContext, proposal: CompletionProposal): GLib.PtrArray | null;
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result: Gio.AsyncResult): Gio.ListModel;
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context: CompletionContext, model: Gio.ListModel): void;
 }

package/dist/generated/gtksource/completion-provider.js

@@ -2,6 +2,15 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * Completion provider interface.
+ *
+ * You must implement this interface to provide proposals to [class@Completion].
+ *
+ * In most cases, implementations of this interface will want to use
+ * [vfunc@CompletionProvider.populate_async] to asynchronously populate the results
+ * to avoid blocking the main loop.
+ */
 export class CompletionProvider {
     ptr;
     constructor(ptr) {
@@ -10,6 +19,18 @@ export class CompletionProvider {
     static fromPtr(ptr) {
         return new CompletionProvider(ptr);
     }
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context, proposal) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_activate", [
             {
@@ -26,6 +47,19 @@ export class CompletionProvider {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context, proposal, cell) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_display", [
             {
@@ -46,6 +80,16 @@ export class CompletionProvider {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_priority", [
             {
@@ -58,6 +102,12 @@ export class CompletionProvider {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_title", [
             {
@@ -66,6 +116,19 @@ export class CompletionProvider {
             },
         ], { type: "string" });
     }
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter, ch) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_is_trigger", [
             {
@@ -87,6 +150,18 @@ export class CompletionProvider {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context, proposal, keyval, state) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_key_activates", [
             {
@@ -111,6 +186,15 @@ export class CompletionProvider {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context, proposal) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_list_alternates", [
             {
@@ -135,6 +219,10 @@ export class CompletionProvider {
             return null;
         return getObject(ptr, GLib.PtrArray);
     }
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result) {
         const error = { value: null };
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_populate_finish", [
@@ -163,6 +251,16 @@ export class CompletionProvider {
         }
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context, model) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_refilter", [
             {

package/dist/generated/gtksource/completion-snippets.d.ts

@@ -6,17 +6,113 @@ import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A [iface@CompletionProvider] for the completion of snippets.
+ *
+ * The `GtkSourceCompletionSnippets` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are snippets
+ * registered with the [class@SnippetManager].
+ */
 export declare class CompletionSnippets extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context: CompletionContext, proposal: CompletionProposal): void;
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context: CompletionContext, proposal: CompletionProposal, cell: CompletionCell): void;
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context: CompletionContext): number;
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle(): string | null;
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter: Gtk.TextIter, ch: number): boolean;
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context: CompletionContext, proposal: CompletionProposal, keyval: number, state: Gdk.ModifierType): boolean;
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context: CompletionContext, proposal: CompletionProposal): GLib.PtrArray | null;
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result: Gio.AsyncResult): Gio.ListModel;
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context: CompletionContext, model: Gio.ListModel): void;
     connect(signal: "notify", handler: (self: CompletionSnippets, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;