Interface

Gtk-4.0 ▶ Gtk ▶ Editable ▶ Interface

Interface for implementing Editable. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_changed(): void;
    vfunc_delete_text(start_pos: number, end_pos: number): void;
    vfunc_do_delete_text(start_pos: number, end_pos: number): void;
    vfunc_do_insert_text(
        text: string,
        length: number,
        position: number,
    ): number;
    vfunc_get_delegate(): Gtk.Editable;
    vfunc_get_selection_bounds(): [boolean, number, number];
    vfunc_get_text(): string;
    vfunc_insert_text(text: string, length: number, position: number): number;
    vfunc_set_selection_bounds(start_pos: number, end_pos: number): void;
}

Hierarchy (View Summary)

Index

Methods

vfunc_changed vfunc_delete_text vfunc_do_delete_text vfunc_do_insert_text vfunc_get_delegate vfunc_get_selection_bounds vfunc_get_text vfunc_insert_text vfunc_set_selection_bounds

Methods

Virtualvfunc_delete_text

  • vfunc_delete_text(start_pos: number, end_pos: number): void

    Deletes a sequence of characters.

    The characters that are deleted are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters deleted are those from start_pos to the end of the text.

    Note that the positions are specified in characters, not bytes.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

Virtualvfunc_do_delete_text

  • vfunc_do_delete_text(start_pos: number, end_pos: number): void

    Deletes a sequence of characters.

    The characters that are deleted are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters deleted are those from start_pos to the end of the text.

    Note that the positions are specified in characters, not bytes.

    Parameters

    • start_pos: number

      start position

    • end_pos: number

      end position

    Returns void

Virtualvfunc_do_insert_text

  • vfunc_do_insert_text(text: string, length: number, position: number): number

    Inserts length bytes of text into the contents of the widget, at position position.

    Note that the position is in characters, not in bytes. The function updates position to point after the newly inserted text.

    Parameters

    • text: string

      the text to insert

    • length: number

      the length of the text in bytes, or -1

    • position: number

      location of the position text will be inserted at

    Returns number

  • Retrieves the selection bound of the editable.

    start_pos will be filled with the start of the selection and end_pos with end. If no text was selected both will be identical and false will be returned.

    Note that positions are specified in characters, not bytes.

    Returns [boolean, number, number]

Virtualvfunc_get_text

  • vfunc_get_text(): string

    Retrieves the contents of editable.

    The returned string is owned by GTK and must not be modified or freed.

    Returns string

Virtualvfunc_insert_text

  • vfunc_insert_text(text: string, length: number, position: number): number

    Inserts length bytes of text into the contents of the widget, at position position.

    Note that the position is in characters, not in bytes. The function updates position to point after the newly inserted text.

    Parameters

    • text: string

      the text to insert

    • length: number

      the length of the text in bytes, or -1

    • position: number

      location of the position text will be inserted at

    Returns number

  • Selects a region of text.

    The characters that are selected are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters selected are those characters from start_pos to the end of the text.

    Note that positions are specified in characters, not bytes.

    Parameters

    • start_pos: number

      start of region

    • end_pos: number

      end of region

    Returns void