Functions¶

	`check_version` (major, minor, micro)
	`encoding_get_all` ()
	`encoding_get_current` ()
	`encoding_get_default_candidates` ()
	`encoding_get_from_charset` (charset)
	`encoding_get_utf8` ()
	`file_loader_error_quark` ()
	`file_saver_error_quark` ()
	`finalize` ()
	`get_major_version` ()
	`get_micro_version` ()
	`get_minor_version` ()
	`init` ()
	`scheduler_add` (callback, *user_data)
	`scheduler_add_full` (callback, *user_data)
	`scheduler_remove` (handler_id)
	`utils_escape_search_text` (text)
	`utils_unescape_search_text` (text)

Details¶

GtkSource.check_version(major, minor, micro)¶

Parameters:

major (int) – the major version to check
minor (int) – the minor version to check
micro (int) – the micro version to check

Returns:

True if the version of the GtkSource.View currently loaded is the same as or newer than the passed-in version.

Return type:

bool

Like GTK_SOURCE_CHECK_VERSION, but the check for GtkSource.check_version is at runtime instead of compile time. This is useful for compiling against older versions of GtkSource.View, but using features from newer versions.

GtkSource.encoding_get_all()¶

Returns:: a list of all GtkSource.Encoding's. Free with g_slist_free().
Return type:: [GtkSource.Encoding]

Gets all encodings.

GtkSource.encoding_get_current()¶

Returns:: the current locale encoding.
Return type:: GtkSource.Encoding

Gets the GtkSource.Encoding for the current locale.

See also [func`GLib`.get_charset].

GtkSource.encoding_get_default_candidates()¶

Returns:: the list of default candidate encodings. Free with g_slist_free().
Return type:: [GtkSource.Encoding]

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

See [method`FileLoader`.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.

GtkSource.encoding_get_from_charset(charset)¶

Parameters:: charset (str) – a character set.
Returns:: the corresponding GtkSource.Encoding, or None if not found.
Return type:: GtkSource.Encoding or None

Gets a GtkSource.Encoding from a character set such as “UTF-8” or “ISO-8859-1”.

GtkSource.encoding_get_utf8()¶

Returns:: the UTF-8 encoding.
Return type:: GtkSource.Encoding

GtkSource.file_loader_error_quark()¶

Return type:: int

GtkSource.file_saver_error_quark()¶

Return type:: int

GtkSource.finalize()¶

Free the resources allocated by GtkSource.View. 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.

GtkSource.get_major_version()¶

Returns:: the major version number of the GtkSource.View library
Return type:: int

Returns the major version number of the GtkSource.View library. (e.g. in GtkSource.View version 3.20.0 this is 3.)

This function is in the library, so it represents the GtkSource.View library your code is running against. Contrast with the GtkSource.MAJOR_VERSION macro, which represents the major version of the GtkSource.View headers you have included when compiling your code.

GtkSource.get_micro_version()¶

Returns:: the micro version number of the GtkSource.View library
Return type:: int

Returns the micro version number of the GtkSource.View library. (e.g. in GtkSource.View version 3.20.0 this is 0.)

This function is in the library, so it represents the GtkSource.View library your code is running against. Contrast with the GtkSource.MICRO_VERSION macro, which represents the micro version of the GtkSource.View headers you have included when compiling your code.

GtkSource.get_minor_version()¶

Returns:: the minor version number of the GtkSource.View library
Return type:: int

Returns the minor version number of the GtkSource.View library. (e.g. in GtkSource.View version 3.20.0 this is 20.)

This function is in the library, so it represents the GtkSource.View library your code is running against. Contrast with the GtkSource.MINOR_VERSION macro, which represents the minor version of the GtkSource.View headers you have included when compiling your code.

GtkSource.init()¶

Initializes the GtkSource.View 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 GtkSource.View function call.

GtkSource.scheduler_add(callback, *user_data)¶

Parameters:

callback (GtkSource.SchedulerCallback) – the callback to execute
user_data (object or None) – user data for callback

Return type:

int

Simplified version of [func`scheduler_add_full`].

New in version 5.2.

GtkSource.scheduler_add_full(callback, *user_data)¶

Parameters:

callback (GtkSource.SchedulerCallback) – the callback to execute
user_data (object or None) – user data for callback

Return type:

int

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 [func`GLib`.get_monotonic_time] for comparison.

Use [func`scheduler_remove`] to remove the handler.

New in version 5.2.

GtkSource.scheduler_remove(handler_id)¶

Parameters:: handler_id (int) – the handler id

Removes a scheduler callback previously registered with [func`scheduler_add`] or [func`scheduler_add_full`].

New in version 5.2.

GtkSource.utils_escape_search_text(text)¶

Parameters:: text (str) – the text to escape.
Returns:: the escaped text.
Return type:: str

Use this function to escape the following characters: \n, \r, \t and \.

For a regular expression search, use GLib.Regex.escape_string() instead.

One possible use case is to take the Gtk.TextBuffer'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: [func`utils_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.

GtkSource.utils_unescape_search_text(text)¶

Parameters:: text (str) – the text to unescape.
Returns:: the unescaped text.
Return type:: str

Use this function before [method`SearchSettings`.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: [func`utils_escape_search_text`].