@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/print-compositor.js

@@ -2,10 +2,37 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Buffer } from "./buffer.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Compose a [class@Buffer] for printing.
+ *
+ * The `GtkSourcePrintCompositor` object is used to compose a [class@Buffer]
+ * for printing. You can set various configuration options to customize the
+ * printed output. `GtkSourcePrintCompositor` is designed to be used with the
+ * high-level printing API of gtk+, i.e. [class@Gtk.PrintOperation].
+ *
+ * The margins specified in this object are the layout margins: they define the
+ * blank space bordering the printed area of the pages. They must not be
+ * confused with the "print margins", i.e. the parts of the page that the
+ * printer cannot print on, defined in the [class@Gtk.PageSetup] objects. If the
+ * specified layout margins are smaller than the "print margins", the latter
+ * ones are used as a fallback by the `GtkSourcePrintCompositor` object, so that
+ * the printed area is not clipped.
+ */
 export class PrintCompositor extends GObject.GObject {
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new print compositor that can be used to print the buffer
+     * associated with @view.
+     *
+     * This constructor sets some configuration properties to make the
+     * printed output match `view` as much as possible.  The properties set are
+     * [property@PrintCompositor:tab-width], [property@PrintCompositor:highlight-syntax],
+     * [property@PrintCompositor:wrap-mode], [property@PrintCompositor:body-font-name] and
+     * [property@PrintCompositor:print-line-numbers].
+     * @param view - a #GtkSourceView to get configuration from.
+     */
     static printCompositorNewFromView(view) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_print_compositor_new_from_view", [
             {
@@ -24,6 +51,43 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Draw page `page_nr` for printing on the the Cairo context encapsuled in @context.
+     *
+     * This method has been designed to be called in the handler of the [signal@Gtk.PrintOperation::draw_page] signal
+     * as shown in the following example:
+     *
+     * ```c
+     * // Signal handler for the GtkPrintOperation::draw_page signal
+     *
+     * static void
+     * draw_page (GtkPrintOperation *operation,
+     * GtkPrintContext   *context,
+     * gint               page_nr,
+     * gpointer           user_data)
+     * {
+     * GtkSourcePrintCompositor *compositor;
+     *
+     * compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
+     *
+     * gtk_source_print_compositor_draw_page (compositor,
+     * context,
+     * page_nr);
+     * }
+     * ```
+     * ```python
+     * def on_draw_page(
+     * operation: Gtk.PrintOperation,
+     * context: Gtk.PrintContext,
+     * page_nr: int,
+     * compositor: GtkSource.PrintCompositor,
+     * ) -> None:
+     * """Signal handler for draw-page that renders a single page."""
+     * compositor.draw_page(context=context, page_nr=page_nr)
+     * ```
+     * @param context - the #GtkPrintContext encapsulating the context information that is required when
+     * @param pageNr - the number of the page to print.
+     */
     drawPage(context, pageNr) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_draw_page", [
             {
@@ -40,6 +104,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Returns the name of the font used to print the text body.
+     *
+     * The returned string must be freed with g_free().
+     */
     getBodyFontName() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_body_font_name", [
             {
@@ -48,6 +117,10 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Gets the bottom margin in units of @unit.
+     * @param unit - the unit for the return value.
+     */
     getBottomMargin(unit) {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_bottom_margin", [
             {
@@ -60,6 +133,12 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the [class@Buffer] associated with the compositor.
+     *
+     * The returned object reference is owned by the compositor object and
+     * should not be unreferenced.
+     */
     getBuffer() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_buffer", [
             {
@@ -69,6 +148,11 @@ export class PrintCompositor extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, Buffer);
     }
+    /**
+     * Returns the name of the font used to print the page footer.
+     *
+     * The returned string must be freed with g_free().
+     */
     getFooterFontName() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_footer_font_name", [
             {
@@ -77,6 +161,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Returns the name of the font used to print the page header.
+     *
+     * The returned string must be freed with g_free().
+     */
     getHeaderFontName() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_header_font_name", [
             {
@@ -85,6 +174,12 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Determines whether the printed text will be highlighted according to the
+     * buffer rules.
+     *
+     * Note that highlighting will happen only if the buffer to print has highlighting activated.
+     */
     getHighlightSyntax() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_highlight_syntax", [
             {
@@ -93,6 +188,10 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets the left margin in units of @unit.
+     * @param unit - the unit for the return value.
+     */
     getLeftMargin(unit) {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_left_margin", [
             {
@@ -105,6 +204,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns the name of the font used to print line numbers on the left margin.
+     *
+     * The returned string must be freed with g_free().
+     */
     getLineNumbersFontName() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_line_numbers_font_name", [
             {
@@ -113,6 +217,10 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * Returns the number of pages in the document or <code>-1</code> if the
+     * document has not been completely paginated.
+     */
     getNPages() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_n_pages", [
             {
@@ -121,6 +229,9 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the current fraction of the document pagination that has been completed.
+     */
     getPaginationProgress() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_pagination_progress", [
             {
@@ -129,6 +240,13 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Determines if a footer is set to be printed for each page.
+     *
+     * A footer will be printed if this function returns %TRUE
+     * **and** some format strings have been specified
+     * with [method@PrintCompositor.set_footer_format].
+     */
     getPrintFooter() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_print_footer", [
             {
@@ -137,6 +255,13 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Determines if a header is set to be printed for each page.
+     *
+     * A header will be printed if this function returns %TRUE
+     * **and** some format strings have been specified
+     * with [method@PrintCompositor.set_header_format].
+     */
     getPrintHeader() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_print_header", [
             {
@@ -145,6 +270,12 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Returns the interval used for line number printing.
+     *
+     * If the value is 0, no line numbers will be printed. The default value is
+     * 1 (i.e. numbers printed in all lines).
+     */
     getPrintLineNumbers() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_print_line_numbers", [
             {
@@ -153,6 +284,10 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the right margin in units of @unit.
+     * @param unit - the unit for the return value.
+     */
     getRightMargin(unit) {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_right_margin", [
             {
@@ -165,6 +300,9 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Returns the width of tabulation in characters for printed text.
+     */
     getTabWidth() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_tab_width", [
             {
@@ -173,6 +311,10 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the top margin in units of @unit.
+     * @param unit - the unit for the return value.
+     */
     getTopMargin(unit) {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_top_margin", [
             {
@@ -185,6 +327,9 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "float", size: 64 });
     }
+    /**
+     * Gets the line wrapping mode for the printed text.
+     */
     getWrapMode() {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_get_wrap_mode", [
             {
@@ -193,6 +338,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Specifies a tag whose style should be ignored when compositing the
+     * document to the printable page.
+     * @param tag - a #GtkTextTag
+     */
     ignoreTag(tag) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_ignore_tag", [
             {
@@ -205,6 +355,94 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Paginate the document associated with the @compositor.
+     *
+     * In order to support non-blocking pagination, document is paginated in small chunks.
+     * Each time [method@PrintCompositor.paginate] is invoked, a chunk of the document
+     * is paginated. To paginate the entire document, [method@PrintCompositor.paginate]
+     * must be invoked multiple times.
+     * It returns %TRUE if the document has been completely paginated, otherwise it returns %FALSE.
+     *
+     * This method has been designed to be invoked in the handler of the [signal@Gtk.PrintOperation::paginate] signal,
+     * as shown in the following example:
+     *
+     * ```c
+     * // Signal handler for the GtkPrintOperation::paginate signal
+     *
+     * static gboolean
+     * paginate (GtkPrintOperation *operation,
+     * GtkPrintContext   *context,
+     * gpointer           user_data)
+     * {
+     * GtkSourcePrintCompositor *compositor;
+     *
+     * compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
+     *
+     * if (gtk_source_print_compositor_paginate (compositor, context))
+     * {
+     * gint n_pages;
+     *
+     * n_pages = gtk_source_print_compositor_get_n_pages (compositor);
+     * gtk_print_operation_set_n_pages (operation, n_pages);
+     *
+     * return TRUE;
+     * }
+     *
+     * return FALSE;
+     * }
+     * ```
+     * ```python
+     * def on_paginate(
+     * operation: Gtk.PrintOperation,
+     * context: Gtk.PrintContext,
+     * compositor: GtkSource.PrintCompositor,
+     * ) -> bool:
+     * if compositor.paginate(context=context):
+     * n_pages = compositor.get_n_pages()
+     * operation.set_n_pages(n_pages=n_pages)
+     * return True
+     * return False
+     * ```
+     *
+     * If you don't need to do pagination in chunks, you can simply do it all in the
+     * [signal@Gtk.PrintOperation::begin-print] handler, and set the number of pages from there, like
+     * in the following example:
+     *
+     * ```c
+     * // Signal handler for the GtkPrintOperation::begin-print signal
+     *
+     * static void
+     * begin_print (GtkPrintOperation *operation,
+     * GtkPrintContext   *context,
+     * gpointer           user_data)
+     * {
+     * GtkSourcePrintCompositor *compositor;
+     * gint n_pages;
+     *
+     * compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
+     *
+     * while (!gtk_source_print_compositor_paginate (compositor, context));
+     *
+     * n_pages = gtk_source_print_compositor_get_n_pages (compositor);
+     * gtk_print_operation_set_n_pages (operation, n_pages);
+     * }
+     * ```
+     * ```python
+     * def on_begin_print(
+     * operation: Gtk.PrintOperation,
+     * context: Gtk.PrintContext,
+     * compositor: GtkSource.PrintCompositor,
+     * ) -> None:
+     * # Paginate until complete
+     * while not compositor.paginate(context=context):
+     * pass
+     *
+     * n_pages = compositor.get_n_pages()
+     * operation.set_n_pages(n_pages=n_pages)
+     * ```
+     * @param context - the #GtkPrintContext whose parameters (e.g. paper size, print margins, etc.)
+     */
     paginate(context) {
         return call("libgtksourceview-5.so.0", "gtk_source_print_compositor_paginate", [
             {
@@ -217,6 +455,18 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets the default font for the printed text.
+     *
+     * `font_name` should be a
+     * string representation of a font description Pango can understand.
+     * (e.g. &quot;Monospace 10&quot;). See [func@Pango.FontDescription.from_string]
+     * for a description of the format of the string representation.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param fontName - the name of the default font for the body text.
+     */
     setBodyFontName(fontName) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_body_font_name", [
             {
@@ -229,6 +479,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the bottom margin used by @compositor.
+     * @param margin - the new bottom margin in units of @unit.
+     * @param unit - the units for @margin.
+     */
     setBottomMargin(margin, unit) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_bottom_margin", [
             {
@@ -245,6 +500,21 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the font for printing the page footer.
+     *
+     * If %NULL is supplied, the default font (i.e. the one being used for the
+     * text) will be used instead.
+     *
+     * `font_name` should be a
+     * string representation of a font description Pango can understand.
+     * (e.g. &quot;Monospace 10&quot;). See [func@Pango.FontDescription.from_string]
+     * for a description of the format of the string representation.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param fontName - the name of the font for the footer text, or %NULL.
+     */
     setFooterFontName(fontName) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_footer_font_name", [
             {
@@ -258,6 +528,14 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * See [method@PrintCompositor.set_header_format] for more information
+     * about the parameters.
+     * @param separator - %TRUE if you want a separator line to be printed.
+     * @param left - a format string to print on the left of the footer.
+     * @param center - a format string to print on the center of the footer.
+     * @param right - a format string to print on the right of the footer.
+     */
     setFooterFormat(separator, left, center, right) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_footer_format", [
             {
@@ -285,6 +563,21 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the font for printing the page header.
+     *
+     * If %NULL is supplied, the default font (i.e. the one being used for the
+     * text) will be used instead.
+     *
+     * `font_name` should be a
+     * string representation of a font description Pango can understand.
+     * (e.g. &quot;Monospace 10&quot;). See [func@Pango.FontDescription.from_string]
+     * for a description of the format of the string representation.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param fontName - the name of the font for header text, or %NULL.
+     */
     setHeaderFontName(fontName) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_header_font_name", [
             {
@@ -298,6 +591,35 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets strftime like header format strings, to be printed on the
+     * left, center and right of the top of each page.
+     *
+     * The strings may include strftime(3) codes which will be expanded at print time.
+     * A subset of strftime() codes are accepted, see [method@GLib.DateTime.format]
+     * for more details on the accepted format specifiers.
+     * Additionally the following format specifiers are accepted:
+     *
+     * - #N: the page number
+     * - #Q: the page count.
+     *
+     * `separator` specifies if a solid line should be drawn to separate
+     * the header from the document text.
+     *
+     * If %NULL is given for any of the three arguments, that particular
+     * string will not be printed.
+     *
+     * For the header to be printed, in
+     * addition to specifying format strings, you need to enable header
+     * printing with [method@PrintCompositor.set_print_header].
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param separator - %TRUE if you want a separator line to be printed.
+     * @param left - a format string to print on the left of the header.
+     * @param center - a format string to print on the center of the header.
+     * @param right - a format string to print on the right of the header.
+     */
     setHeaderFormat(separator, left, center, right) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_header_format", [
             {
@@ -325,6 +647,14 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether the printed text will be highlighted according to the
+     * buffer rules.  Both color and font style are applied.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param highlight - whether syntax should be highlighted.
+     */
     setHighlightSyntax(highlight) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_highlight_syntax", [
             {
@@ -337,6 +667,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the left margin used by @compositor.
+     * @param margin - the new left margin in units of @unit.
+     * @param unit - the units for @margin.
+     */
     setLeftMargin(margin, unit) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_left_margin", [
             {
@@ -353,6 +688,21 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the font for printing line numbers on the left margin.
+     *
+     * If %NULL is supplied, the default font (i.e. the one being used for the
+     * text) will be used instead.
+     *
+     * `font_name` should be a
+     * string representation of a font description Pango can understand.
+     * (e.g. &quot;Monospace 10&quot;). See [func@Pango.FontDescription.from_string]
+     * for a description of the format of the string representation.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param fontName - the name of the font for line numbers, or %NULL.
+     */
     setLineNumbersFontName(fontName) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_line_numbers_font_name", [
             {
@@ -366,6 +716,20 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether you want to print a footer in each page.
+     *
+     * The footer consists of three pieces of text and an optional line
+     * separator, configurable with
+     * [method@PrintCompositor.set_footer_format].
+     *
+     * Note that by default the footer format is unspecified, and if it's
+     * empty it will not be printed, regardless of this setting.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param print - %TRUE if you want the footer to be printed.
+     */
     setPrintFooter(print) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_print_footer", [
             {
@@ -378,6 +742,19 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets whether you want to print a header in each page.
+     *
+     * The header consists of three pieces of text and an optional line
+     * separator, configurable with [method@PrintCompositor.set_header_format].
+     *
+     * Note that by default the header format is unspecified, and if it's
+     * empty it will not be printed, regardless of this setting.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param print - %TRUE if you want the header to be printed.
+     */
     setPrintHeader(print) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_print_header", [
             {
@@ -390,6 +767,18 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the interval for printed line numbers.
+     *
+     * If `interval` is 0 no numbers will be printed. If greater than 0, a number will be
+     * printed every `interval` lines (i.e. 1 will print all line numbers).
+     *
+     * Maximum accepted value for `interval` is 100.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param interval - interval for printed line numbers.
+     */
     setPrintLineNumbers(interval) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_print_line_numbers", [
             {
@@ -402,6 +791,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the right margin used by @compositor.
+     * @param margin - the new right margin in units of @unit.
+     * @param unit - the units for @margin.
+     */
     setRightMargin(margin, unit) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_right_margin", [
             {
@@ -418,6 +812,13 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the width of tabulation in characters for printed text.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param width - width of tab in characters.
+     */
     setTabWidth(width) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_tab_width", [
             {
@@ -430,6 +831,11 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the top margin used by @compositor.
+     * @param margin - the new top margin in units of @unit
+     * @param unit - the units for @margin
+     */
     setTopMargin(margin, unit) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_top_margin", [
             {
@@ -446,6 +852,13 @@ export class PrintCompositor extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the line wrapping mode for the printed text.
+     *
+     * This function cannot be called anymore after the first call to the
+     * [method@PrintCompositor.paginate] function.
+     * @param wrapMode - a #GtkWrapMode.
+     */
     setWrapMode(wrapMode) {
         call("libgtksourceview-5.so.0", "gtk_source_print_compositor_set_wrap_mode", [
             {