Functions¶

	`completion_error_quark` ()
	`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` ()
	`init` ()
	`utils_escape_search_text` (text)
	`utils_get_bracket_matched_message` (iter, state)
	`utils_unescape_search_text` (text)

Details¶

GtkSource.completion_error_quark()¶

Return type:: int

GtkSource.encoding_get_all()¶

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

Gets all encodings.

New in version 3.14.

GtkSource.encoding_get_current()¶

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

Gets the GtkSource.Encoding for the current locale. See also GLib.get_charset().

New in version 3.14.

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 GtkSource.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.

New in version 3.18.

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”.

New in version 3.14.

GtkSource.encoding_get_utf8()¶

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

New in version 3.14.

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.

New in version 4.0.

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.

New in version 4.0.

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.

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.

New in version 3.10.

GtkSource.utils_get_bracket_matched_message(iter, state)¶

Parameters:

iter (Gtk.TextIter) – the Gtk.TextIter.
state (GtkSource.BracketMatchType) – the GtkSource.BracketMatchType.

Returns:

a string intended to be shown in the UI, that describes a bracket matching. None is returned on GtkSource.BracketMatchType.NONE.

Return type:

str or None

This function is intended to be used inside a GtkSource.Buffer ::bracket-matched signal handler. Pass to this function the iter and state values as received in the signal handler, and a string description will be returned.

New in version 300.0.

GtkSource.utils_unescape_search_text(text)¶

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

Use this function before GtkSource.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.

New in version 3.10.