@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/functions.js

@@ -1,6 +1,15 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Encoding } from "./encoding.js";
+/**
+ * Like GTK_SOURCE_CHECK_VERSION, but the check for gtk_source_check_version is
+ * at runtime instead of compile time. This is useful for compiling
+ * against older versions of GtkSourceView, but using features from newer
+ * versions.
+ * @param major - the major version to check
+ * @param minor - the minor version to check
+ * @param micro - the micro version to check
+ */
 export const checkVersion = (major, minor, micro) => {
     return call("libgtksourceview-5.so.0", "gtk_source_check_version", [
         {
@@ -17,6 +26,9 @@ export const checkVersion = (major, minor, micro) => {
         },
     ], { type: "boolean" });
 };
+/**
+ * Gets all encodings.
+ */
 export const encodingGetAll = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_encoding_get_all", [], {
         type: "array",
@@ -29,6 +41,11 @@ export const encodingGetAll = () => {
         borrowed: true,
     });
 };
+/**
+ * Gets the #GtkSourceEncoding for the current locale.
+ *
+ * See also [func@GLib.get_charset].
+ */
 export const encodingGetCurrent = () => {
     const ptr = call("libgtksourceview-5.so.0", "gtk_source_encoding_get_current", [], {
         type: "boxed",
@@ -38,6 +55,15 @@ export const encodingGetCurrent = () => {
     });
     return getObject(ptr, Encoding);
 };
+/**
+ * Gets the list of default candidate encodings to try when loading a file.
+ *
+ * See [method@FileLoader.set_candidate_encodings].
+ *
+ * This function returns a different list depending on the current locale (i.e.
+ * language, country and default encoding). The UTF-8 encoding and the current
+ * locale encoding are guaranteed to be present in the returned list.
+ */
 export const encodingGetDefaultCandidates = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_encoding_get_default_candidates", [], {
         type: "array",
@@ -50,6 +76,11 @@ export const encodingGetDefaultCandidates = () => {
         borrowed: true,
     });
 };
+/**
+ * Gets a #GtkSourceEncoding from a character set such as "UTF-8" or
+ * "ISO-8859-1".
+ * @param charset - a character set.
+ */
 export const encodingGetFromCharset = (charset) => {
     const ptr = call("libgtksourceview-5.so.0", "gtk_source_encoding_get_from_charset", [
         {
@@ -81,11 +112,28 @@ export const fileLoaderErrorQuark = () => {
 export const fileSaverErrorQuark = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_file_saver_error_quark", [], { type: "int", size: 32, unsigned: true });
 };
+/**
+ * Free the resources allocated by GtkSourceView. For example it unrefs the
+ * singleton objects.
+ *
+ * It is not mandatory to call this function, it's just to be friendlier to
+ * memory debugging tools. This function is meant to be called at the end of
+ * main(). It can be called several times.
+ */
 export const finalize = () => {
     call("libgtksourceview-5.so.0", "gtk_source_finalize", [], {
         type: "undefined",
     });
 };
+/**
+ * Returns the major version number of the GtkSourceView library.
+ * (e.g. in GtkSourceView version 3.20.0 this is 3.)
+ *
+ * This function is in the library, so it represents the GtkSourceView library
+ * your code is running against. Contrast with the #GTK_SOURCE_MAJOR_VERSION
+ * macro, which represents the major version of the GtkSourceView headers you
+ * have included when compiling your code.
+ */
 export const getMajorVersion = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_get_major_version", [], {
         type: "int",
@@ -93,6 +141,15 @@ export const getMajorVersion = () => {
         unsigned: true,
     });
 };
+/**
+ * Returns the micro version number of the GtkSourceView library.
+ * (e.g. in GtkSourceView version 3.20.0 this is 0.)
+ *
+ * This function is in the library, so it represents the GtkSourceView library
+ * your code is running against. Contrast with the #GTK_SOURCE_MICRO_VERSION
+ * macro, which represents the micro version of the GtkSourceView headers you
+ * have included when compiling your code.
+ */
 export const getMicroVersion = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_get_micro_version", [], {
         type: "int",
@@ -100,6 +157,15 @@ export const getMicroVersion = () => {
         unsigned: true,
     });
 };
+/**
+ * Returns the minor version number of the GtkSourceView library.
+ * (e.g. in GtkSourceView version 3.20.0 this is 20.)
+ *
+ * This function is in the library, so it represents the GtkSourceView library
+ * your code is running against. Contrast with the #GTK_SOURCE_MINOR_VERSION
+ * macro, which represents the minor version of the GtkSourceView headers you
+ * have included when compiling your code.
+ */
 export const getMinorVersion = () => {
     return call("libgtksourceview-5.so.0", "gtk_source_get_minor_version", [], {
         type: "int",
@@ -107,9 +173,23 @@ export const getMinorVersion = () => {
         unsigned: true,
     });
 };
+/**
+ * Initializes the GtkSourceView library (e.g. for the internationalization).
+ *
+ * This function can be called several times, but is meant to be called at the
+ * beginning of main(), before any other GtkSourceView function call.
+ *
+ * The counterpart to this function is [func@finalize] which can be convenient
+ * when using memory debugging tools.
+ */
 export const init = () => {
     call("libgtksourceview-5.so.0", "gtk_source_init", [], { type: "undefined" });
 };
+/**
+ * Simplified version of [func@scheduler_add_full].
+ * @param callback - the callback to execute
+ * @param userData - user data for @callback
+ */
 export const schedulerAdd = (callback, userData) => {
     return call("libgtksourceview-5.so.0", "gtk_source_scheduler_add", [
         {
@@ -123,6 +203,20 @@ export const schedulerAdd = (callback, userData) => {
         },
     ], { type: "int", size: 64, unsigned: true });
 };
+/**
+ * Adds a new callback that will be executed as time permits on the main thread.
+ *
+ * This is useful when you need to do a lot of background work but want to do
+ * it incrementally.
+ *
+ * `callback` will be provided a deadline that it should complete it's work by
+ * (or near) and can be checked using [func@GLib.get_monotonic_time] for comparison.
+ *
+ * Use [func@scheduler_remove] to remove the handler.
+ * @param callback - the callback to execute
+ * @param userData - user data for @callback
+ * @param notify - closure notify for @user_data
+ */
 export const schedulerAddFull = (callback, notify, userData) => {
     return call("libgtksourceview-5.so.0", "gtk_source_scheduler_add_full", [
         {
@@ -140,6 +234,11 @@ export const schedulerAddFull = (callback, notify, userData) => {
         },
     ], { type: "int", size: 64, unsigned: true });
 };
+/**
+ * Removes a scheduler callback previously registered with
+ * [func@scheduler_add] or [func@scheduler_add_full].
+ * @param handlerId - the handler id
+ */
 export const schedulerRemove = (handlerId) => {
     call("libgtksourceview-5.so.0", "gtk_source_scheduler_remove", [
         {
@@ -148,6 +247,25 @@ export const schedulerRemove = (handlerId) => {
         },
     ], { type: "undefined" });
 };
+/**
+ * Use this function to escape the following characters: `\n`, `\r`, `\t` and `\`.
+ *
+ * For a regular expression search, use g_regex_escape_string() instead.
+ *
+ * One possible use case is to take the #GtkTextBuffer's selection and put it in a
+ * search entry. The selection can contain tabulations, newlines, etc. So it's
+ * better to escape those special characters to better fit in the search entry.
+ *
+ * See also: [func@utils_unescape_search_text].
+ *
+ * <warning>
+ * Warning: the escape and unescape functions are not reciprocal! For example,
+ * escape (unescape (\)) = \\. So avoid cycles such as: search entry -> unescape
+ * -> search settings -> escape -> search entry. The original search entry text
+ * may be modified.
+ * </warning>
+ * @param text - the text to escape.
+ */
 export const utilsEscapeSearchText = (text) => {
     return call("libgtksourceview-5.so.0", "gtk_source_utils_escape_search_text", [
         {
@@ -156,6 +274,17 @@ export const utilsEscapeSearchText = (text) => {
         },
     ], { type: "string" });
 };
+/**
+ * Use this function before [method@SearchSettings.set_search_text], to
+ * unescape the following sequences of characters: `\n`, `\r`, `\t` and `\\`.
+ * The purpose is to easily write those characters in a search entry.
+ *
+ * Note that unescaping the search text is not needed for regular expression
+ * searches.
+ *
+ * See also: [func@utils_escape_search_text].
+ * @param text - the text to unescape.
+ */
 export const utilsUnescapeSearchText = (text) => {
     return call("libgtksourceview-5.so.0", "gtk_source_utils_unescape_search_text", [
         {

package/dist/generated/gtksource/gutter-lines.d.ts

@@ -2,25 +2,145 @@ import { Ref } from "@gtkx/native";
 import { GutterRendererAlignmentMode } from "./enums.js";
 import * as GObject from "../gobject/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * Collected information about visible lines.
+ *
+ * The `GtkSourceGutterLines` object is used to collect information about
+ * visible lines.
+ *
+ * Use this from your [signal@GutterRenderer::query-data] to collect the
+ * necessary information on visible lines. Doing so reduces the number of
+ * passes through the text btree allowing GtkSourceView to reach more
+ * frames-per-second while performing kinetic scrolling.
+ */
 export declare class GutterLines extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Adds the class `name` to @line.
+     *
+     * `name` will be converted to a [alias@GLib.Quark] as part of this process. A
+     * faster version of this function is available via
+     * [method@GutterLines.add_qclass] for situations where the [alias@GLib.Quark] is
+     * known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name
+     */
     addClass(line: number, name: string): void;
+    /**
+     * Adds the class denoted by `qname` to @line.
+     *
+     * You may check if a line has `qname` by calling
+     * [method@GutterLines.has_qclass].
+     *
+     * You can remove `qname` by calling
+     * [method@GutterLines.remove_qclass].
+     * @param line - a line number starting from zero
+     * @param qname - a class name as a #GQuark
+     */
     addQclass(line: number, qname: number): void;
+    /**
+     * Gets the [class@Gtk.TextBuffer] that the `GtkSourceGutterLines` represents.
+     */
     getBuffer(): Gtk.TextBuffer;
+    /**
+     * Gets the line number (starting from 0) for the first line that is
+     * user visible.
+     */
     getFirst(): number;
+    /**
+     * Gets a #GtkTextIter for the current buffer at @line
+     * @param iter - a location for a #GtkTextIter
+     * @param line - the line number
+     */
     getIterAtLine(iter: Ref<Gtk.TextIter>, line: number): void;
+    /**
+     * Gets the line number (starting from 0) for the last line that is
+     * user visible.
+     */
     getLast(): number;
+    /**
+     * Gets the Y range for a line based on @mode.
+     *
+     * The value for `y` is relative to the renderers widget coordinates.
+     * @param line - a line number starting from zero
+     * @param mode - a #GtkSourceGutterRendererAlignmentMode
+     * @param y - a location for the Y position in widget coordinates
+     * @param height - the line height based on @mode
+     */
     getLineExtent(line: number, mode: GutterRendererAlignmentMode, y: Ref<number>, height: Ref<number>): void;
+    /**
+     * Gets the Y range for a line based on @mode.
+     *
+     * The value for `y` is relative to the renderers widget coordinates.
+     * @param line - a line number starting from zero
+     * @param mode - a #GtkSourceGutterRendererAlignmentMode
+     * @param y - a location for the Y position in widget coordinates
+     * @param height - the line height based on @mode
+     */
     getLineYrange(line: number, mode: GutterRendererAlignmentMode, y: Ref<number>, height: Ref<number>): void;
+    /**
+     * Gets the [class@Gtk.TextView] that the `GtkSourceGutterLines` represents.
+     */
     getView(): Gtk.TextView;
+    /**
+     * Checks to see if the line has any GQuark classes set. This can be
+     * used to help renderer implementations avoid work if nothing has
+     * been set on the class.
+     * @param line - a line contained within @lines
+     */
     hasAnyClass(line: number): boolean;
+    /**
+     * Checks to see if [method@GutterLines.add_class] was called with
+     * the `name` for @line.
+     *
+     * A faster version of this function is provided via
+     * [method@GutterLines.has_qclass] for situations where the quark
+     * is known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name that may be converted, to a #GQuark
+     */
     hasClass(line: number, name: string): boolean;
+    /**
+     * Checks to see if [method@GutterLines.add_qclass] was called with
+     * the quark denoted by `qname` for @line.
+     * @param line - a line number starting from zero
+     * @param qname - a #GQuark containing the class name
+     */
     hasQclass(line: number, qname: number): boolean;
+    /**
+     * Checks to see if `line` contains the insertion cursor.
+     * @param line - a line number starting from zero
+     */
     isCursor(line: number): boolean;
+    /**
+     * Checks to see if `line` is marked as prelit. Generally, this means
+     * the mouse pointer is over the line within the gutter.
+     * @param line - a line number starting from zero
+     */
     isPrelit(line: number): boolean;
+    /**
+     * Checks to see if the view had a selection and if that selection overlaps
+     * `line` in some way.
+     * @param line - a line number starting from zero
+     */
     isSelected(line: number): boolean;
+    /**
+     * Removes the class matching `name` from @line.
+     *
+     * A faster version of this function is available via
+     * [method@GutterLines.remove_qclass] for situations where the
+     * #GQuark is known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name
+     */
     removeClass(line: number, name: string): void;
+    /**
+     * Reverses a call to [method@GutterLines.add_qclass] by removing
+     * the [alias@GLib.Quark] matching @qname.
+     * @param line - a line number starting from zero
+     * @param qname - a #GQuark to remove from @line
+     */
     removeQclass(line: number, qname: number): void;
     connect(signal: "notify", handler: (self: GutterLines, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtksource/gutter-lines.js

@@ -2,6 +2,17 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * Collected information about visible lines.
+ *
+ * The `GtkSourceGutterLines` object is used to collect information about
+ * visible lines.
+ *
+ * Use this from your [signal@GutterRenderer::query-data] to collect the
+ * necessary information on visible lines. Doing so reduces the number of
+ * passes through the text btree allowing GtkSourceView to reach more
+ * frames-per-second while performing kinetic scrolling.
+ */
 export class GutterLines extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -13,6 +24,16 @@ export class GutterLines extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Adds the class `name` to @line.
+     *
+     * `name` will be converted to a [alias@GLib.Quark] as part of this process. A
+     * faster version of this function is available via
+     * [method@GutterLines.add_qclass] for situations where the [alias@GLib.Quark] is
+     * known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name
+     */
     addClass(line, name) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_add_class", [
             {
@@ -29,6 +50,17 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds the class denoted by `qname` to @line.
+     *
+     * You may check if a line has `qname` by calling
+     * [method@GutterLines.has_qclass].
+     *
+     * You can remove `qname` by calling
+     * [method@GutterLines.remove_qclass].
+     * @param line - a line number starting from zero
+     * @param qname - a class name as a #GQuark
+     */
     addQclass(line, qname) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_add_qclass", [
             {
@@ -45,6 +77,9 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the [class@Gtk.TextBuffer] that the `GtkSourceGutterLines` represents.
+     */
     getBuffer() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_buffer", [
             {
@@ -54,6 +89,10 @@ export class GutterLines extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gtk.TextBuffer);
     }
+    /**
+     * Gets the line number (starting from 0) for the first line that is
+     * user visible.
+     */
     getFirst() {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_first", [
             {
@@ -62,6 +101,11 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets a #GtkTextIter for the current buffer at @line
+     * @param iter - a location for a #GtkTextIter
+     * @param line - the line number
+     */
     getIterAtLine(iter, line) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_iter_at_line", [
             {
@@ -85,6 +129,10 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the line number (starting from 0) for the last line that is
+     * user visible.
+     */
     getLast() {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_last", [
             {
@@ -93,6 +141,15 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the Y range for a line based on @mode.
+     *
+     * The value for `y` is relative to the renderers widget coordinates.
+     * @param line - a line number starting from zero
+     * @param mode - a #GtkSourceGutterRendererAlignmentMode
+     * @param y - a location for the Y position in widget coordinates
+     * @param height - the line height based on @mode
+     */
     getLineExtent(line, mode, y, height) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_line_extent", [
             {
@@ -117,6 +174,15 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the Y range for a line based on @mode.
+     *
+     * The value for `y` is relative to the renderers widget coordinates.
+     * @param line - a line number starting from zero
+     * @param mode - a #GtkSourceGutterRendererAlignmentMode
+     * @param y - a location for the Y position in widget coordinates
+     * @param height - the line height based on @mode
+     */
     getLineYrange(line, mode, y, height) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_line_yrange", [
             {
@@ -147,6 +213,9 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the [class@Gtk.TextView] that the `GtkSourceGutterLines` represents.
+     */
     getView() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_get_view", [
             {
@@ -156,6 +225,12 @@ export class GutterLines extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Gtk.TextView);
     }
+    /**
+     * Checks to see if the line has any GQuark classes set. This can be
+     * used to help renderer implementations avoid work if nothing has
+     * been set on the class.
+     * @param line - a line contained within @lines
+     */
     hasAnyClass(line) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_has_any_class", [
             {
@@ -168,6 +243,16 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks to see if [method@GutterLines.add_class] was called with
+     * the `name` for @line.
+     *
+     * A faster version of this function is provided via
+     * [method@GutterLines.has_qclass] for situations where the quark
+     * is known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name that may be converted, to a #GQuark
+     */
     hasClass(line, name) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_has_class", [
             {
@@ -184,6 +269,12 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks to see if [method@GutterLines.add_qclass] was called with
+     * the quark denoted by `qname` for @line.
+     * @param line - a line number starting from zero
+     * @param qname - a #GQuark containing the class name
+     */
     hasQclass(line, qname) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_has_qclass", [
             {
@@ -200,6 +291,10 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks to see if `line` contains the insertion cursor.
+     * @param line - a line number starting from zero
+     */
     isCursor(line) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_is_cursor", [
             {
@@ -212,6 +307,11 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks to see if `line` is marked as prelit. Generally, this means
+     * the mouse pointer is over the line within the gutter.
+     * @param line - a line number starting from zero
+     */
     isPrelit(line) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_is_prelit", [
             {
@@ -224,6 +324,11 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Checks to see if the view had a selection and if that selection overlaps
+     * `line` in some way.
+     * @param line - a line number starting from zero
+     */
     isSelected(line) {
         return call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_is_selected", [
             {
@@ -236,6 +341,15 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Removes the class matching `name` from @line.
+     *
+     * A faster version of this function is available via
+     * [method@GutterLines.remove_qclass] for situations where the
+     * #GQuark is known ahead of time.
+     * @param line - a line number starting from zero
+     * @param name - a class name
+     */
     removeClass(line, name) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_remove_class", [
             {
@@ -252,6 +366,12 @@ export class GutterLines extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Reverses a call to [method@GutterLines.add_qclass] by removing
+     * the [alias@GLib.Quark] matching @qname.
+     * @param line - a line number starting from zero
+     * @param qname - a #GQuark to remove from @line
+     */
     removeQclass(line, qname) {
         call("libgtksourceview-5.so.0", "gtk_source_gutter_lines_remove_qclass", [
             {

package/dist/generated/gtksource/gutter-renderer-pixbuf.d.ts

@@ -3,17 +3,54 @@ import * as Gdk from "../gdk/index.js";
 import * as GdkPixbuf from "../gdkpixbuf/index.js";
 import * as Gio from "../gio/index.js";
 import { GutterRenderer } from "./gutter-renderer.js";
+/**
+ * Renders a pixbuf in the gutter.
+ *
+ * A `GtkSourceGutterRendererPixbuf` can be used to render an image in a cell of
+ * [class@Gutter].
+ */
 export declare class GutterRendererPixbuf extends GutterRenderer {
+    /**
+     * Create a new #GtkSourceGutterRendererPixbuf.
+     */
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Get the gicon of the renderer
+     */
     getGicon(): Gio.Icon;
     getIconName(): string;
+    /**
+     * Gets a [iface@Gdk.Paintable] that was set with
+     * [method@GutterRendererPixbuf.set_paintable]
+     */
     getPaintable(): Gdk.Paintable | null;
+    /**
+     * Get the pixbuf of the renderer.
+     */
     getPixbuf(): GdkPixbuf.Pixbuf;
+    /**
+     * Allows overlaying a paintable on top of any other image that
+     * has been set for the pixbuf. This will be applied when the
+     * widget is next snapshot.
+     * @param paintable - a #GdkPaintable
+     */
     overlayPaintable(paintable: Gdk.Paintable): void;
+    /**
+     * @param icon - the icon, or %NULL.
+     */
     setGicon(icon?: Gio.Icon | null): void;
+    /**
+     * @param iconName - the icon name, or %NULL.
+     */
     setIconName(iconName?: string | null): void;
+    /**
+     * @param paintable - the paintable, or %NULL.
+     */
     setPaintable(paintable?: Gdk.Paintable | null): void;
+    /**
+     * @param pixbuf - the pixbuf, or %NULL.
+     */
     setPixbuf(pixbuf?: GdkPixbuf.Pixbuf | null): void;
     connect(signal: "notify", handler: (self: GutterRendererPixbuf, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;