gtksourceview-5

---

Description:

GtkSourceView is a GNOME library that extends GtkTextView, the standard GTK+ widget for multiline text editing. GtkSourceView adds support for syntax highlighting, undo/redo, file loading and saving, search and replace, a completion system, printing, displaying line numbers, and other features typical of a source code editor.

• Home: https://wiki.gnome.org/Projects/GtkSourceView
• C-Documentation: https://gnome.pages.gitlab.gnome.org/gtksourceview/gtksourceview5/
• Devhelp-Package download

Content:

Namespaces:

• GtkSource

Interfaces:

• CompletionProposal - Interface for completion proposals.
• CompletionProvider - Completion provider interface.
• HoverProvider - Interface to populate interactive tooltips.
• Indenter - Auto-indentation interface.
• StyleSchemeChooser - Interface implemented by widgets for choosing style schemes.

Classes:

• Buffer - Subclass of [class@Gtk.
• Completion - Main Completion Object.
• CompletionCell - Widget for single cell of completion proposal.
• CompletionContext - The context of a completion.
• CompletionSnippets - A [ iface@CompletionProvider] for the completion of snippets.
• CompletionWords - A [ iface@CompletionProvider] for the completion of words.
• Encoding - Character encoding.
• File - On-disk representation of a [ class@Buffer].
• FileLoader - Load a file into a GtkSourceBuffer.
• FileSaver - Save a [class@Buffer] into a file.
• Gutter - Gutter object for [class@View].
• GutterLines - Collected information about visible lines.
• GutterRenderer - Gutter cell renderer.
• GutterRendererPixbuf - Renders a pixbuf in the gutter.
• GutterRendererText - Renders text in the gutter.
• Hover - Interactive tooltips.
• HoverContext - Context for populating [class@HoverDisplay] contents.
• HoverDisplay - Display for interactive tooltips.
• Language - Represents a syntax highlighted language.
• LanguageManager - Provides access to [class@Language]s.
• Map - Widget that displays a map for a specific [class@View].
• Mark - Mark object for [class@Buffer].
• MarkAttributes - The source mark attributes object.
• PrintCompositor - Compose a [ class@Buffer] for printing.
• Region - Region utility.
• SearchContext - Search context.
• SearchSettings - Search settings.
• Snippet - Quick insertion code snippets.
• SnippetChunk - A chunk of text within the source snippet.
• SnippetContext - Context for expanding [class@SnippetChunk].
• SnippetManager - Provides access to [class@Snippet].
• SpaceDrawer - Represent white space characters with symbols.
• Style - Represents a style.
• StyleScheme - Controls the appearance of [class@View].
• StyleSchemeChooserButton - A button to launch a style scheme selection dialog.
• StyleSchemeChooserWidget - A widget for choosing style schemes.
• StyleSchemeManager - Provides access to [class@StyleScheme]s.
• StyleSchemePreview - A preview widget for [class@StyleScheme].
• Tag - A tag that can be applied to text in a [class@Buffer].
• View - Subclass of [class@Gtk.
• VimIMContext - Vim emulation.

Structs:

• RegionIter - An opaque datatype.

Enums:

• BackgroundPatternType
• BracketMatchType
• ChangeCaseType
• CompletionActivation
• CompletionColumn
• CompressionType
• FileSaverFlags - Flags to define the behavior of a [flags@FileSaverFlags].
• GutterRendererAlignmentMode - The alignment mode of the renderer, when a cell spans multiple lines (due to text wrapping).
• NewlineType
• SmartHomeEndType
• SortFlags
• SpaceLocationFlags - SpaceLocationFlags contains flags for white space locations.
• SpaceTypeFlags - SpaceTypeFlags contains flags for white space types.
• ViewGutterPosition

Error domains:

• FileLoaderError - An error code used with the gtk_source_file_loader_error domain.
• FileSaverError - An error code used with the gtk_source_file_saver_error domain.

Constants:

• public const int MAJOR_VERSION
  Like get_major_version, but from the headers used at application compile time, rather than from the library linked against at application run time.
• public const int MICRO_VERSION
  Like get_micro_version, but from the headers used at application compile time, rather than from the library linked against at application run time.
• public const int MINOR_VERSION
  Like get_minor_version, but from the headers used at application compile time, rather than from the library linked against at application run time.

Delegates:

• public delegate bool SchedulerCallback (int64 deadline)
  This function is called incrementally to process additional background work.

Methods:

• public bool check_version (uint major, uint minor, uint micro)
  Like GTK_SOURCE_CHECK_VERSION, but the check for gtk_source_check_version is at runtime instead of compile time.
• public SList<unowned Encoding> encoding_get_all ()
  Gets all encodings.
• public unowned Encoding encoding_get_current ()
  Gets the Encoding for the current locale.
• public SList<unowned Encoding> encoding_get_default_candidates ()
  Gets the list of default candidate encodings to try when loading a file.
• public unowned Encoding? encoding_get_from_charset (string charset)
  Gets a Encoding from a character set such as "UTF-8" or "ISO-8859-1".
• public unowned Encoding encoding_get_utf8 ()
• public Quark file_loader_error_quark ()
• public Quark file_saver_error_quark ()
• public void finalize ()
  Free the resources allocated by GtkSourceView.
• public uint get_major_version ()
  Returns the major version number of the GtkSourceView library.
• public uint get_micro_version ()
  Returns the micro version number of the GtkSourceView library.
• public uint get_minor_version ()
  Returns the minor version number of the GtkSourceView library.
• public void init ()
  Initializes the GtkSourceView library (e.
• public size_t scheduler_add (SchedulerCallback callback)
  Simplified version of [func@scheduler_add_full].
• public size_t scheduler_add_full (owned SchedulerCallback callback)
  Adds a new callback that will be executed as time permits on the main thread.
• public void scheduler_remove (size_t handler_id)
  Removes a scheduler callback previously registered with [ func@scheduler_add] or [func@scheduler_add_full].
• public string utils_escape_search_text (string text)
  Use this function to escape the following characters: `\n`, `\r`, `\t` and `\`.
• public string utils_unescape_search_text (string text)
  Use this function before [method@SearchSettings.