@gtkx/ffi 0.10.5 → 0.11.1

package/dist/generated/gtk/text-buffer.d.ts

@@ -1,18 +1,26 @@
 import { TextIter } from "./text-iter.js";
-import { TextTagTable } from "./text-tag-table.js";
 import { TextChildAnchor } from "./text-child-anchor.js";
 import { TextMark } from "./text-mark.js";
 import { TextTag } from "./text-tag.js";
+import { TextTagTable } from "./text-tag-table.js";
 import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
+/**
+ * Stores text and attributes for display in a `GtkTextView`.
+ *
+ * You may wish to begin by reading the
+ * text widget conceptual overview,
+ * which gives an overview of all the objects and data types
+ * related to the text widget and how they work together.
+ *
+ * GtkTextBuffer can support undoing changes to the buffer
+ * content, see {@link Gtk.TextBuffer.set_enable_undo}.
+ */
 export declare class TextBuffer extends GObject.GObject {
     static readonly glibTypeName: string;
     static readonly objectType: "gobject";
-    /**
-     * Creates a new text buffer.
-     * @param table - a tag table, or %NULL to create a new one
-     */
-    constructor(table?: TextTagTable);
+    /** Creates a new text buffer. */
+    constructor(table?: TextTagTable | null);
     /**
      * Adds the mark at position `where`.
      *
@@ -22,8 +30,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * Emits the {@link Gtk.TextBuffer.:mark-set} signal as notification
      * of the mark's initial placement.
-     * @param mark - the mark to add
-     * @param where - location to place mark
      */
     addMark(mark: TextMark, where: TextIter): void;
     /**
@@ -32,7 +38,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * In most cases, `clipboard` will be the `GdkClipboard` returned by
      * {@link Gtk.Widget.get_primary_clipboard} for a view of `buffer`.
-     * @param clipboard - a `GdkClipboard`
      */
     addSelectionClipboard(clipboard: Gdk.Clipboard): void;
     /**
@@ -41,9 +46,6 @@ export declare class TextBuffer extends GObject.GObject {
      * The default handler for the signal applies
      * `tag` to the given range. `start` and `end` do
      * not have to be in order.
-     * @param tag - a `GtkTextTag`
-     * @param start - one bound of range to be tagged
-     * @param end - other bound of range to be tagged
      */
     applyTag(tag: TextTag, start: TextIter, end: TextIter): void;
     /**
@@ -52,9 +54,6 @@ export declare class TextBuffer extends GObject.GObject {
      * Calls {@link Gtk.TextTagTable.lookup} on the buffer’s
      * tag table to get a `GtkTextTag`, then calls
      * {@link Gtk.TextBuffer.apply_tag}.
-     * @param name - name of a named `GtkTextTag`
-     * @param start - one bound of range to be tagged
-     * @param end - other bound of range to be tagged
      */
     applyTagByName(name: string, start: TextIter, end: TextIter): void;
     /**
@@ -69,9 +68,6 @@ export declare class TextBuffer extends GObject.GObject {
      * Because the buffer is modified, all outstanding iterators become
      * invalid after calling this function; however, the `iter` will be
      * re-initialized to point to the location where text was deleted.
-     * @param iter - a position in `buffer`
-     * @param interactive - whether the deletion is caused by user interaction
-     * @param defaultEditable - whether the buffer is editable by default
      */
     backspace(iter: TextIter, interactive: boolean, defaultEditable: boolean): boolean;
     /**
@@ -109,10 +105,7 @@ export declare class TextBuffer extends GObject.GObject {
      * solely of a single call to one of those functions.
      */
     beginUserAction(): void;
-    /**
-     * Copies the currently-selected text to a clipboard.
-     * @param clipboard - the `GdkClipboard` object to copy to
-     */
+    /** Copies the currently-selected text to a clipboard. */
     copyClipboard(clipboard: Gdk.Clipboard): void;
     /**
      * Creates and inserts a child anchor.
@@ -123,7 +116,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * The new anchor is owned by the buffer; no reference count is
      * returned to the caller of this function.
-     * @param iter - location in the buffer
      */
     createChildAnchor(iter: TextIter): TextChildAnchor;
     /**
@@ -146,16 +138,11 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * Emits the {@link Gtk.TextBuffer.:mark-set} signal as notification
      * of the mark's initial placement.
-     * @param markName - name for mark
-     * @param where - location to place mark
-     * @param leftGravity - whether the mark has left gravity
      */
-    createMark(where: TextIter, leftGravity: boolean, markName?: string): TextMark;
+    createMark(where: TextIter, leftGravity: boolean, markName?: string | null): TextMark;
     /**
      * Copies the currently-selected text to a clipboard,
      * then deletes said text if it’s editable.
-     * @param clipboard - the `GdkClipboard` object to cut to
-     * @param defaultEditable - default editability of the buffer
      */
     cutClipboard(clipboard: Gdk.Clipboard, defaultEditable: boolean): void;
     /**
@@ -169,8 +156,6 @@ export declare class TextBuffer extends GObject.GObject {
      * buffer is modified, all outstanding iterators become invalid after
      * calling this function; however, the `start` and `end` will be
      * re-initialized to point to the location where text was deleted.
-     * @param start - a position in `buffer`
-     * @param end - another position in `buffer`
      */
     delete(start: TextIter, end: TextIter): void;
     /**
@@ -180,9 +165,6 @@ export declare class TextBuffer extends GObject.GObject {
      * sub-range of [`start`,`end`). `start` and `end` are revalidated
      * to point to the location of the last deleted range, or left
      * untouched if no text was deleted.
-     * @param startIter - start of range to delete
-     * @param endIter - end of range
-     * @param defaultEditable - whether the buffer is editable by default
      */
     deleteInteractive(startIter: TextIter, endIter: TextIter, defaultEditable: boolean): boolean;
     /**
@@ -198,14 +180,12 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * The {@link Gtk.TextBuffer.:mark-deleted} signal will be emitted as
      * notification after the mark is deleted.
-     * @param mark - a `GtkTextMark` in `buffer`
      */
     deleteMark(mark: TextMark): void;
     /**
      * Deletes the mark named `name`; the mark must exist.
      *
      * See {@link Gtk.TextBuffer.delete_mark} for details.
-     * @param name - name of a mark in `buffer`
      */
     deleteMarkByName(name: string): void;
     /**
@@ -214,8 +194,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * If `interactive` is %TRUE, the editability of the selection will be
      * considered (users can’t delete uneditable text).
-     * @param interactive - whether the deletion is caused by user interaction
-     * @param defaultEditable - whether the buffer is editable by default
      */
     deleteSelection(interactive: boolean, defaultEditable: boolean): boolean;
     /**
@@ -243,17 +221,11 @@ export declare class TextBuffer extends GObject.GObject {
     /**
      * Retrieves the first and last iterators in the buffer, i.e. the
      * entire buffer lies within the range [`start`,`end`).
-     * @param start - iterator to initialize with first position in the buffer
-     * @param end - iterator to initialize with the end iterator
      */
     getBounds(start: TextIter, end: TextIter): void;
-    /**
-     * Gets whether there is a redoable action in the history.
-     */
+    /** Gets whether there is a redoable action in the history. */
     getCanRedo(): boolean;
-    /**
-     * Gets whether there is an undoable action in the history.
-     */
+    /** Gets whether there is an undoable action in the history. */
     getCanUndo(): boolean;
     /**
      * Gets the number of characters in the buffer.
@@ -283,12 +255,9 @@ export declare class TextBuffer extends GObject.GObject {
      * The entire buffer lies in the range from the first position in
      * the buffer (call {@link Gtk.TextBuffer.get_start_iter} to get
      * character position 0) to the end iterator.
-     * @param iter - iterator to initialize
      */
     getEndIter(iter: TextIter): void;
-    /**
-     * Indicates whether the buffer has some text currently selected.
-     */
+    /** Indicates whether the buffer has some text currently selected. */
     getHasSelection(): boolean;
     /**
      * Returns the mark that represents the cursor (insertion point).
@@ -298,19 +267,13 @@ export declare class TextBuffer extends GObject.GObject {
      * efficient, and involves less typing.
      */
     getInsert(): TextMark;
-    /**
-     * Obtains the location of `anchor` within `buffer`.
-     * @param iter - an iterator to be initialized
-     * @param anchor - a child anchor that appears in `buffer`
-     */
+    /** Obtains the location of `anchor` within `buffer`. */
     getIterAtChildAnchor(iter: TextIter, anchor: TextChildAnchor): void;
     /**
      * Initializes `iter` to the start of the given line.
      *
      * If `line_number` is greater than or equal to the number of lines
      * in the `buffer`, the end iterator is returned.
-     * @param iter - iterator to initialize
-     * @param lineNumber - line number counting from 0
      */
     getIterAtLine(iter: TextIter, lineNumber: number): boolean;
     /**
@@ -322,9 +285,6 @@ export declare class TextBuffer extends GObject.GObject {
      * If `line_number` is greater than or equal to the number of lines in the `buffer`,
      * the end iterator is returned. And if `byte_index` is off the
      * end of the line, the iterator at the end of the line is returned.
-     * @param iter - iterator to initialize
-     * @param lineNumber - line number counting from 0
-     * @param byteIndex - byte index from start of line
      */
     getIterAtLineIndex(iter: TextIter, lineNumber: number, byteIndex: number): boolean;
     /**
@@ -336,16 +296,9 @@ export declare class TextBuffer extends GObject.GObject {
      * If `line_number` is greater than or equal to the number of lines in the `buffer`,
      * the end iterator is returned. And if `char_offset` is off the
      * end of the line, the iterator at the end of the line is returned.
-     * @param iter - iterator to initialize
-     * @param lineNumber - line number counting from 0
-     * @param charOffset - char offset from start of line
      */
     getIterAtLineOffset(iter: TextIter, lineNumber: number, charOffset: number): boolean;
-    /**
-     * Initializes `iter` with the current position of `mark`.
-     * @param iter - iterator to initialize
-     * @param mark - a `GtkTextMark` in `buffer`
-     */
+    /** Initializes `iter` with the current position of `mark`. */
     getIterAtMark(iter: TextIter, mark: TextMark): void;
     /**
      * Initializes `iter` to a position `char_offset` chars from the start
@@ -354,8 +307,6 @@ export declare class TextBuffer extends GObject.GObject {
      * If `char_offset` is -1 or greater than the number
      * of characters in the buffer, `iter` is initialized to the end iterator,
      * the iterator one past the last valid character in the buffer.
-     * @param iter - iterator to initialize
-     * @param charOffset - char offset from start of buffer, counting from 0, or -1
      */
     getIterAtOffset(iter: TextIter, charOffset: number): void;
     /**
@@ -367,7 +318,6 @@ export declare class TextBuffer extends GObject.GObject {
     /**
      * Returns the mark named `name` in buffer `buffer`, or %NULL if no such
      * mark exists in the buffer.
-     * @param name - a mark name
      */
     getMark(name: string): TextMark | null;
     /**
@@ -409,8 +359,6 @@ export declare class TextBuffer extends GObject.GObject {
      * in with the same value. `start` and `end` will be in ascending order.
      * If `start` and `end` are %NULL, then they are not filled in, but the
      * return value still indicates whether text is selected.
-     * @param start - iterator to initialize with selection start
-     * @param end - iterator to initialize with selection end
      */
     getSelectionBounds(start: TextIter, end: TextIter): boolean;
     /**
@@ -431,9 +379,6 @@ export declare class TextBuffer extends GObject.GObject {
      * indexes into the buffer. Contrast with {@link Gtk.TextBuffer.get_text}.
      * Note that 0xFFFC can occur in normal text as well, so it is not a
      * reliable indicator that a paintable or widget is in the buffer.
-     * @param start - start of a range
-     * @param end - end of a range
-     * @param includeHiddenChars - whether to include invisible text
      */
     getSlice(start: TextIter, end: TextIter, includeHiddenChars: boolean): string;
     /**
@@ -441,12 +386,9 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * This is the same as using {@link Gtk.TextBuffer.get_iter_at_offset}
      * to get the iter at character offset 0.
-     * @param iter - iterator to initialize
      */
     getStartIter(iter: TextIter): void;
-    /**
-     * Get the `GtkTextTagTable` associated with this buffer.
-     */
+    /** Get the `GtkTextTagTable` associated with this buffer. */
     getTagTable(): TextTagTable;
     /**
      * Returns the text in the range [`start`,`end`).
@@ -457,9 +399,6 @@ export declare class TextBuffer extends GObject.GObject {
      * byte and character indexes into the returned string do not
      * correspond to byte and character indexes into the buffer.
      * Contrast with {@link Gtk.TextBuffer.get_slice}.
-     * @param start - start of a range
-     * @param end - end of a range
-     * @param includeHiddenChars - whether to include invisible text
      */
     getText(start: TextIter, end: TextIter, includeHiddenChars: boolean): string;
     /**
@@ -471,9 +410,6 @@ export declare class TextBuffer extends GObject.GObject {
      * insertion occurs (because the buffer contents change), but the
      * default signal handler revalidates it to point to the end of the
      * inserted text.
-     * @param iter - a position in the buffer
-     * @param text - text in UTF-8 format
-     * @param len - length of text in bytes, or -1
      */
     insert(iter: TextIter, text: string, len: number): void;
     /**
@@ -481,8 +417,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * Simply calls {@link Gtk.TextBuffer.insert},
      * using the current cursor position as the insertion point.
-     * @param text - text in UTF-8 format
-     * @param len - length of text, in bytes
      */
     insertAtCursor(text: string, len: number): void;
     /**
@@ -499,8 +433,6 @@ export declare class TextBuffer extends GObject.GObject {
      * Consider {@link Gtk.TextBuffer.create_child_anchor} as a more
      * convenient alternative to this function. The buffer will add a
      * reference to the anchor, so you can unref it after insertion.
-     * @param iter - location to insert the anchor
-     * @param anchor - a `GtkTextChildAnchor`
      */
     insertChildAnchor(iter: TextIter, anchor: TextChildAnchor): void;
     /**
@@ -514,10 +446,6 @@ export declare class TextBuffer extends GObject.GObject {
      * `default_editable` indicates the editability of text that doesn't
      * have a tag affecting editability applied to it. Typically the
      * result of {@link Gtk.TextView.get_editable} is appropriate here.
-     * @param iter - a position in `buffer`
-     * @param text - some UTF-8 text
-     * @param len - length of text in bytes, or -1
-     * @param defaultEditable - default editability of buffer
      */
     insertInteractive(iter: TextIter, text: string, len: number, defaultEditable: boolean): boolean;
     /**
@@ -529,9 +457,6 @@ export declare class TextBuffer extends GObject.GObject {
      * `default_editable` indicates the editability of text that doesn't
      * have a tag affecting editability applied to it. Typically the
      * result of {@link Gtk.TextView.get_editable} is appropriate here.
-     * @param text - text in UTF-8 format
-     * @param len - length of text in bytes, or -1
-     * @param defaultEditable - default editability of buffer
      */
     insertInteractiveAtCursor(text: string, len: number, defaultEditable: boolean): boolean;
     /**
@@ -541,9 +466,6 @@ export declare class TextBuffer extends GObject.GObject {
      * and valid UTF-8. Emits the {@link Gtk.TextBuffer.:insert-text} signal,
      * possibly multiple times; insertion actually occurs in the default handler
      * for the signal. `iter` will point to the end of the inserted text on return.
-     * @param iter - location to insert the markup
-     * @param markup - a nul-terminated UTF-8 string containing Pango markup
-     * @param len - length of `markup` in bytes, or -1
      */
     insertMarkup(iter: TextIter, markup: string, len: number): void;
     /**
@@ -556,8 +478,6 @@ export declare class TextBuffer extends GObject.GObject {
      * as a string include this character for paintable, but the “text”
      * variants do not. e.g. see {@link Gtk.TextBuffer.get_slice} and
      * {@link Gtk.TextBuffer.get_text}.
-     * @param iter - location to insert the paintable
-     * @param paintable - a `GdkPaintable`
      */
     insertPaintable(iter: TextIter, paintable: Gdk.Paintable): void;
     /**
@@ -572,9 +492,6 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * Implemented via emissions of the ::insert-text and ::apply-tag signals,
      * so expect those.
-     * @param iter - a position in `buffer`
-     * @param start - a position in a `GtkTextBuffer`
-     * @param end - another position in the same buffer as `start`
      */
     insertRange(iter: TextIter, start: TextIter, end: TextIter): void;
     /**
@@ -586,10 +503,6 @@ export declare class TextBuffer extends GObject.GObject {
      * parameter indicates whether the text is editable at `iter` if
      * no tags enclosing `iter` affect editability. Typically the result
      * of {@link Gtk.TextView.get_editable} is appropriate here.
-     * @param iter - a position in `buffer`
-     * @param start - a position in a `GtkTextBuffer`
-     * @param end - another position in the same buffer as `start`
-     * @param defaultEditable - default editability of the buffer
      */
     insertRangeInteractive(iter: TextIter, start: TextIter, end: TextIter, defaultEditable: boolean): boolean;
     /**
@@ -597,16 +510,12 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * Emits the {@link Gtk.TextBuffer.:mark-set} signal
      * as notification of the move.
-     * @param mark - a `GtkTextMark`
-     * @param where - new location for `mark` in `buffer`
      */
     moveMark(mark: TextMark, where: TextIter): void;
     /**
      * Moves the mark named `name` (which must exist) to location `where`.
      *
      * See {@link Gtk.TextBuffer.move_mark} for details.
-     * @param name - name of a mark
-     * @param where - new location for mark
      */
     moveMarkByName(name: string, where: TextIter): void;
     /**
@@ -619,11 +528,8 @@ export declare class TextBuffer extends GObject.GObject {
      * Note: pasting is asynchronous, that is, we’ll ask for the paste data
      * and return, and at some point later after the main loop runs, the paste
      * data will be inserted.
-     * @param clipboard - the `GdkClipboard` to paste from
-     * @param overrideLocation - location to insert pasted text
-     * @param defaultEditable - whether the buffer is editable by default
      */
-    pasteClipboard(clipboard: Gdk.Clipboard, defaultEditable: boolean, overrideLocation?: TextIter): void;
+    pasteClipboard(clipboard: Gdk.Clipboard, defaultEditable: boolean, overrideLocation?: TextIter | null): void;
     /**
      * This function moves the “insert” and “selection_bound” marks
      * simultaneously.
@@ -634,12 +540,9 @@ export declare class TextBuffer extends GObject.GObject {
      * inefficient since the temporarily-selected region will force stuff
      * to be recalculated. This function moves them as a unit, which can
      * be optimized.
-     * @param where - where to put the cursor
      */
     placeCursor(where: TextIter): void;
-    /**
-     * Redoes the next redoable action on the buffer, if there is one.
-     */
+    /** Redoes the next redoable action on the buffer, if there is one. */
     redo(): void;
     /**
      * Removes all tags in the range between `start` and `end`.
@@ -648,8 +551,6 @@ export declare class TextBuffer extends GObject.GObject {
      * unrelated to the code you’re currently writing. That is, using this
      * function is probably a bad idea if you have two or more unrelated
      * code sections that add tags.
-     * @param start - one bound of range to be untagged
-     * @param end - other bound of range to be untagged
      */
     removeAllTags(start: TextIter, end: TextIter): void;
     /**
@@ -658,13 +559,11 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * This may result in the `user_data_destroy` being called that was passed when registering
      * the commit notify functions.
-     * @param commitNotifyHandler - the notify handler identifier returned from
      */
     removeCommitNotify(commitNotifyHandler: number): void;
     /**
      * Removes a `GdkClipboard` added with
      * {@link Gtk.TextBuffer.add_selection_clipboard}
-     * @param clipboard - a `GdkClipboard` added to `buffer` by
      */
     removeSelectionClipboard(clipboard: Gdk.Clipboard): void;
     /**
@@ -673,9 +572,6 @@ export declare class TextBuffer extends GObject.GObject {
      * The default handler for the signal removes all occurrences
      * of `tag` from the given range. `start` and `end` don’t have
      * to be in order.
-     * @param tag - a `GtkTextTag`
-     * @param start - one bound of range to be untagged
-     * @param end - other bound of range to be untagged
      */
     removeTag(tag: TextTag, start: TextIter, end: TextIter): void;
     /**
@@ -684,9 +580,6 @@ export declare class TextBuffer extends GObject.GObject {
      * Calls {@link Gtk.TextTagTable.lookup} on the buffer’s
      * tag table to get a `GtkTextTag`, then calls
      * {@link Gtk.TextBuffer.remove_tag}.
-     * @param name - name of a `GtkTextTag`
-     * @param start - one bound of range to be untagged
-     * @param end - other bound of range to be untagged
      */
     removeTagByName(name: string, start: TextIter, end: TextIter): void;
     /**
@@ -699,8 +592,6 @@ export declare class TextBuffer extends GObject.GObject {
      * inefficient since the temporarily-selected region will force stuff
      * to be recalculated. This function moves them as a unit, which can
      * be optimized.
-     * @param ins - where to put the “insert” mark
-     * @param bound - where to put the “selection_bound” mark
      */
     selectRange(ins: TextIter, bound: TextIter): void;
     /**
@@ -715,7 +606,6 @@ export declare class TextBuffer extends GObject.GObject {
      * See {@link Gtk.TextBuffer.begin_irreversible_action} and
      * {@link Gtk.TextBuffer.end_irreversible_action} to create
      * changes to the buffer that cannot be undone.
-     * @param enableUndo - %TRUE to enable undo
      */
     setEnableUndo(enableUndo: boolean): void;
     /**
@@ -724,7 +614,6 @@ export declare class TextBuffer extends GObject.GObject {
      * If 0, unlimited undo actions may be performed. Note that this may
      * have a memory usage impact as it requires storing an additional
      * copy of the inserted or removed text within the text buffer.
-     * @param maxUndoLevels - the maximum number of undo actions to perform
      */
     setMaxUndoLevels(maxUndoLevels: number): void;
     /**
@@ -737,7 +626,6 @@ export declare class TextBuffer extends GObject.GObject {
      * toggle on the modified bit again. When the modified
      * bit flips, the buffer emits the
      * {@link Gtk.TextBuffer.:modified-changed} signal.
-     * @param setting - modification flag setting
      */
     setModified(setting: boolean): void;
     /**
@@ -748,13 +636,9 @@ export declare class TextBuffer extends GObject.GObject {
      *
      * If `len` is -1, `text` must be nul-terminated.
      * `text` must be valid UTF-8.
-     * @param text - UTF-8 text to insert
-     * @param len - length of `text` in bytes
      */
     setText(text: string, len: number): void;
-    /**
-     * Undoes the last undoable action on the buffer, if there is one.
-     */
+    /** Undoes the last undoable action on the buffer, if there is one. */
     undo(): void;
     connect(signal: "apply-tag", handler: (self: TextBuffer, tag: TextTag, start: TextIter, end: TextIter) => void, after?: boolean): number;
     connect(signal: "begin-user-action", handler: (self: TextBuffer) => void, after?: boolean): number;
@@ -771,6 +655,5 @@ export declare class TextBuffer extends GObject.GObject {
     connect(signal: "redo", handler: (self: TextBuffer) => void, after?: boolean): number;
     connect(signal: "remove-tag", handler: (self: TextBuffer, tag: TextTag, start: TextIter, end: TextIter) => void, after?: boolean): number;
     connect(signal: "undo", handler: (self: TextBuffer) => void, after?: boolean): number;
-    connect(signal: "notify", handler: (self: TextBuffer, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;
 }