Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Functions

Functions

  • Gets the list of default candidate encodings to try when loading a file.

    See [methodFileLoader.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.

    Returns GtkSource.Encoding[]

  • file_loader_error_quark(): Quark
  • file_saver_error_quark(): Quark
  • finalize(): void
  • 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.

    Returns void

  • init(): void
  • 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.

    Returns void

  • 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 [funcGLib.get_monotonic_time] for comparison.

    Use [funcscheduler_remove] to remove the handler.

    Parameters

    Returns number

  • scheduler_remove(handler_id: number): void
  • Removes a scheduler callback previously registered with [funcscheduler_add] or [funcscheduler_add_full].

    Parameters

    • handler_id: number

      the handler id

    Returns void

  • utils_escape_search_text(text: string): string
  • 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: [funcutils_unescape_search_text].

    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.

    Parameters

    • text: string

      the text to escape.

    Returns string

  • utils_unescape_search_text(text: string): string
  • Use this function before [methodSearchSettings.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: [funcutils_escape_search_text].

    Parameters

    • text: string

      the text to unescape.

    Returns string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method