Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Functions

Functions

  • Loads location. Ignores non-existing locations.

    Parameters

    • window: Gedit.Window

      a #GeditWindow

    • location: Gio.File

      a #GFile to load

    • encoding: GtkSource.Encoding

      the #GtkSourceEncoding of location

    • line_pos: number

      the line position to place the cursor

    • column_pos: number

      the line column to place the cursor

    Returns void

  • commands_save_all_documents(window: Gedit.Window): void
  • Asynchronously save all documents belonging to window. The result of the operation is not available, so it's difficult to know whether all the documents are correctly saved.

    Parameters

    Returns void

  • Asynchronously save document. document must belong to window. If you need the result of the operation, use gedit_commands_save_document_async().

    Parameters

    Returns void

  • Asynchronously save the document. document must belong to window. The source object of the async task is document (which will be the first parameter of the #GAsyncReadyCallback).

    When the operation is finished, callback will be called. You can then call gedit_commands_save_document_finish() to get the result of the operation.

    Parameters

    Returns void

  • Finishes an asynchronous document saving operation started with gedit_commands_save_document_async().

    Note that there is no error parameter because the errors are already handled by gedit.

    Parameters

    Returns boolean

  • debug(section: DebugSection, file: string, line: number, function_: string): void
  • If section is enabled, then logs the trace information file, line, and function.

    Parameters

    • section: DebugSection

      debug section.

    • file: string

      file name.

    • line: number

      line number.

    • function_: string

      name of the function that is calling gedit_debug().

    Returns void

  • debug_init(): void
  • Initializes the debugging subsystem of gedit.

    The function checks for the existence of certain environment variables to determine whether to enable output for a debug section. To enable output for a specific debug section, set an environment variable of the same name; e.g. to enable output for the %GEDIT_DEBUG_PLUGINS section, set a GEDIT_DEBUG_PLUGINS environment variable. To enable output for all debug sections, set the GEDIT_DEBUG environment variable.

    This function must be called before any of the other debug functions are called. It must only be called once.

    Returns void

  • debug_plugin_message(file: string, line: number, function_: string, message: string): void
  • If the section %GEDIT_DEBUG_PLUGINS is enabled, then logs the trace information file, line, and function along with message.

    This function may be overridden by GObject Introspection language bindings to be more language-specific.

    Python

    A PyGObject override is provided that has the following signature: def debug_plugin_message(format_str, *format_args): #...

    It automatically supplies parameters file, line, and function, and it formats format_str with the given format arguments. The syntax of the format string is the usual Python string formatting syntax described by 5.6.2. String Formatting Operations.

    Parameters

    • file: string

      file name.

    • line: number

      line number.

    • function_: string

      name of the function that is calling gedit_debug_plugin_message().

    • message: string

      a message.

    Returns void

  • utils_basename_for_display(location: Gio.File): string
  • utils_decode_uri(uri: string): [boolean, string, string, string, string, string]
  • Parse and break an uri apart in its individual components like the uri scheme, user info, port, host and path. The return value pointer can be %NULL to ignore certain parts of the uri. If the function returns %TRUE, then all return value pointers should be freed using g_free

    Parameters

    • uri: string

      the uri to decode

    Returns [boolean, string, string, string, string, string]

  • utils_is_valid_location(location: Gio.File): boolean
  • utils_location_get_dirname_for_display(location: Gio.File): string
  • Returns a string suitable to be displayed in the UI indicating the name of the directory where the file is located. For remote files it may also contain the hostname etc. For local files it tries to replace the home dir with ~.

    Parameters

    Returns string

  • utils_replace_home_dir_with_tilde(uri: string): string
  • utils_set_atk_name_description(widget: Gtk.Widget, name: string, description: string): void
  • This function sets up name and description for a specified gtk widget.

    Parameters

    • widget: Gtk.Widget

      The Gtk widget for which name/description to be set

    • name: string

      Atk name string

    • description: string

      Atk description string

    Returns void

  • utils_str_end_truncate(string: string, truncate_length: number): string
  • utils_str_middle_truncate(string: string, truncate_length: number): 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