Skip to content

Instantly share code, notes, and snippets.

@psiska
Created November 1, 2021 10:16
Show Gist options
  • Save psiska/a52811f4846d594b384a5e8ac9298236 to your computer and use it in GitHub Desktop.
Save psiska/a52811f4846d594b384a5e8ac9298236 to your computer and use it in GitHub Desktop.
GtkSourceView-5.gir for GtkSourceView-5.2.0 (as in Arch Linux)
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Gtk" version="4.0"/>
<package name="gtksourceview-5"/>
<c:include name="gtksourceview/gtksource.h"/>
<namespace name="GtkSource"
version="5"
shared-library="libgtksourceview-5.so.0"
c:identifier-prefixes="GtkSource"
c:symbol-prefixes="gtk_source">
<enumeration name="BackgroundPatternType"
version="3.16"
glib:type-name="GtkSourceBackgroundPatternType"
glib:get-type="gtk_source_background_pattern_type_get_type"
c:type="GtkSourceBackgroundPatternType">
<member name="none"
value="0"
c:identifier="GTK_SOURCE_BACKGROUND_PATTERN_TYPE_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="71">no pattern</doc>
</member>
<member name="grid"
value="1"
c:identifier="GTK_SOURCE_BACKGROUND_PATTERN_TYPE_GRID"
glib:nick="grid">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="72">grid pattern</doc>
</member>
</enumeration>
<enumeration name="BracketMatchType"
glib:type-name="GtkSourceBracketMatchType"
glib:get-type="gtk_source_bracket_match_type_get_type"
c:type="GtkSourceBracketMatchType">
<member name="none"
value="0"
c:identifier="GTK_SOURCE_BRACKET_MATCH_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="43">there is no bracket to match.</doc>
</member>
<member name="out_of_range"
value="1"
c:identifier="GTK_SOURCE_BRACKET_MATCH_OUT_OF_RANGE"
glib:nick="out-of-range">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="44">matching a bracket
failed because the maximum range was reached.</doc>
</member>
<member name="not_found"
value="2"
c:identifier="GTK_SOURCE_BRACKET_MATCH_NOT_FOUND"
glib:nick="not-found">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="46">a matching bracket was not found.</doc>
</member>
<member name="found"
value="3"
c:identifier="GTK_SOURCE_BRACKET_MATCH_FOUND"
glib:nick="found">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="47">a matching bracket was found.</doc>
</member>
</enumeration>
<class name="Buffer"
c:symbol-prefix="buffer"
c:type="GtkSourceBuffer"
parent="Gtk.TextBuffer"
glib:type-name="GtkSourceBuffer"
glib:get-type="gtk_source_buffer_get_type"
glib:type-struct="BufferClass">
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="102"/>
<constructor name="new" c:identifier="gtk_source_buffer_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="611">Creates a new source buffer.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="105"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="617">a new source buffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<parameter name="table"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="613">a #GtkTextTagTable, or %NULL to create a new one.</doc>
<type name="Gtk.TextTagTable" c:type="GtkTextTagTable*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_language"
c:identifier="gtk_source_buffer_new_with_language">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="629">Creates a new source buffer using the highlighting patterns in
@language. This is equivalent to creating a new source buffer with
a new tag table and then calling gtk_source_buffer_set_language().</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="107"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="637">a new source buffer which will highlight text
according to the highlighting patterns in @language.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="631">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="bracket_matched">
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="96"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="BracketMatchType" c:type="GtkSourceBracketMatchType"/>
</parameter>
</parameters>
</virtual-method>
<method name="backward_iter_to_source_mark"
c:identifier="gtk_source_buffer_backward_iter_to_source_mark"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1906">Moves @iter to the position of the previous #GtkSourceMark of the given
category. Returns %TRUE if @iter was moved. If @category is NULL, the
previous source mark can be of any category.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="142"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1916">whether @iter was moved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1908">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1909">an iterator.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1910">category to search for, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="change_case"
c:identifier="gtk_source_buffer_change_case"
version="3.12">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2480">Changes the case of the text between the specified iterators.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="174"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2482">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="case_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2483">how to change the case.</doc>
<type name="ChangeCaseType" c:type="GtkSourceChangeCaseType"/>
</parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2484">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2485">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="create_source_mark"
c:identifier="gtk_source_buffer_create_source_mark"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1766">Creates a source mark in the @buffer of category @category. A source mark is
a #GtkTextMark but organised into categories. Depending on the category
a pixbuf can be specified that will be displayed along the line of the mark.
Like a #GtkTextMark, a #GtkSourceMark can be anonymous if the
passed @name is %NULL. Also, the buffer owns the marks so you
shouldn't unreference it.
Marks always have left gravity and are moved to the beginning of
the line when the user deletes the line they were in.
Typical uses for a source mark are bookmarks, breakpoints, current
executing instruction indication in a source file, etc..</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="133"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1787">a new #GtkSourceMark, owned by the buffer.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1768">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1769">the name of the mark, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1770">a string defining the mark category.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="where" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1771">location to place the mark.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="create_source_tag"
c:identifier="gtk_source_buffer_create_source_tag"
version="3.20"
introspectable="0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2992">In short, this is the same function as gtk_text_buffer_create_tag(), but
instead of creating a #GtkTextTag, this function creates a #GtkSourceTag.
This function creates a #GtkSourceTag and adds it to the tag table for
@buffer. Equivalent to calling gtk_text_tag_new() and then adding the tag to
the buffer’s tag table. The returned tag is owned by the buffer’s tag table,
so the ref count will be equal to one.
If @tag_name is %NULL, the tag is anonymous.
If @tag_name is non-%NULL, a tag called @tag_name must not already
exist in the tag table for this buffer.
The @first_property_name argument and subsequent arguments are a list
of properties to set on the tag, as with g_object_set().</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="194"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="3015">a new #GtkSourceTag.</doc>
<type name="Gtk.TextTag" c:type="GtkTextTag*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2994">a #GtkSourceBuffer</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="tag_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2995">name of the new tag, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="first_property_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2996">name of first property to set, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2997">%NULL-terminated list of property names and values</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="ensure_highlight"
c:identifier="gtk_source_buffer_ensure_highlight">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1604">Forces buffer to analyze and highlight the given area synchronously.
&lt;note&gt;
&lt;para&gt;
This is a potentially slow operation and should be used only
when you need to make sure that some text not currently
visible is highlighted, for instance before printing.
&lt;/para&gt;
&lt;/note&gt;</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="129"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1606">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1607">start of the area to highlight.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1608">end of the area to highlight.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="forward_iter_to_source_mark"
c:identifier="gtk_source_buffer_forward_iter_to_source_mark"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1872">Moves @iter to the position of the next #GtkSourceMark of the given
@category. Returns %TRUE if @iter was moved. If @category is NULL, the
next source mark can be of any category.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="138"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1882">whether @iter was moved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1874">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1875">an iterator.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1876">category to search for, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_context_classes_at_iter"
c:identifier="gtk_source_buffer_get_context_classes_at_iter"
version="2.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2129">Get all defined context classes at @iter.
See the #GtkSourceBuffer description for the list of default context classes.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="163"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2138">a new %NULL
terminated array of context class names.
Use g_strfreev() to free the array if it is no longer needed.</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2131">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2132">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_highlight_matching_brackets"
c:identifier="gtk_source_buffer_get_highlight_matching_brackets">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1359">Determines whether bracket match highlighting is activated for the
source buffer.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="114"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1366">%TRUE if the source buffer will highlight matching
brackets.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1361">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_highlight_syntax"
c:identifier="gtk_source_buffer_get_highlight_syntax">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1409">Determines whether syntax highlighting is activated in the source
buffer.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="109"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1416">%TRUE if syntax highlighting is enabled, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1411">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_implicit_trailing_newline"
c:identifier="gtk_source_buffer_get_implicit_trailing_newline"
version="3.14">
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="192"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2979">whether the @buffer has an implicit trailing newline.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2977">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_language"
c:identifier="gtk_source_buffer_get_language">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1516">Returns the #GtkSourceLanguage associated with the buffer,
see gtk_source_buffer_set_language(). The returned object should not be
unreferenced by the user.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="119"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1524">the #GtkSourceLanguage associated
with the buffer, or %NULL.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1518">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_source_marks_at_iter"
c:identifier="gtk_source_buffer_get_source_marks_at_iter"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1940">Returns the list of marks of the given category at @iter. If @category
is %NULL it returns all marks at @iter.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="146"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1949">
a newly allocated #GSList.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Mark"/>
</type>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1942">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1943">an iterator.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1944">category to search for, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_source_marks_at_line"
c:identifier="gtk_source_buffer_get_source_marks_at_line"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1974">Returns the list of marks of the given category at @line.
If @category is %NULL, all marks at @line are returned.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="150"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1983">
a newly allocated #GSList.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Mark"/>
</type>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1976">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1977">a line number.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1978">category to search for, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_style_scheme"
c:identifier="gtk_source_buffer_get_style_scheme">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1670">Returns the #GtkSourceStyleScheme associated with the buffer,
see gtk_source_buffer_set_style_scheme().
The returned object should not be unreferenced by the user.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="124"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1678">the #GtkSourceStyleScheme
associated with the buffer, or %NULL.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1672">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="iter_backward_to_context_class_toggle"
c:identifier="gtk_source_buffer_iter_backward_to_context_class_toggle"
version="2.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2222">Moves backward to the next toggle (on or off) of the context class. If no
matching context class toggles are found, returns %FALSE, otherwise %TRUE.
Does not return toggles located at @iter, only toggles after @iter. Sets
@iter to the location of the toggle, or to the end of the buffer if no
toggle is found.
See the #GtkSourceBuffer description for the list of default context classes.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="170"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2236">whether we found a context class toggle before @iter</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2224">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2225">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="context_class" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2226">the context class.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="iter_forward_to_context_class_toggle"
c:identifier="gtk_source_buffer_iter_forward_to_context_class_toggle"
version="2.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2183">Moves forward to the next toggle (on or off) of the context class. If no
matching context class toggles are found, returns %FALSE, otherwise %TRUE.
Does not return toggles located at @iter, only toggles after @iter. Sets
@iter to the location of the toggle, or to the end of the buffer if no
toggle is found.
See the #GtkSourceBuffer description for the list of default context classes.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="166"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2197">whether we found a context class toggle after @iter</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2185">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2186">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="context_class" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2187">the context class.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="iter_has_context_class"
c:identifier="gtk_source_buffer_iter_has_context_class"
version="2.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2095">Check if the class @context_class is set on @iter.
See the #GtkSourceBuffer description for the list of default context classes.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="159"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2105">whether @iter has the context class.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2097">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2098">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="context_class" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2099">class to search for.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="join_lines"
c:identifier="gtk_source_buffer_join_lines"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2566">Joins the lines of text between the specified iterators.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="179"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2568">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2569">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2570">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="remove_source_marks"
c:identifier="gtk_source_buffer_remove_source_marks"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2020">Remove all marks of @category between @start and @end from the buffer.
If @category is NULL, all marks in the range will be removed.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="154"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2022">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2023">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2024">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2025">category to search for, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_highlight_matching_brackets"
c:identifier="gtk_source_buffer_set_highlight_matching_brackets">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1379">Controls the bracket match highlighting function in the buffer. If
activated, when you position your cursor over a bracket character
(a parenthesis, a square bracket, etc.) the matching opening or
closing bracket character will be highlighted.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="116"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1381">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="highlight" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1382">%TRUE if you want matching brackets highlighted.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_highlight_syntax"
c:identifier="gtk_source_buffer_set_highlight_syntax">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1428">Controls whether syntax is highlighted in the buffer.
If @highlight is %TRUE, the text will be highlighted according to the syntax
patterns specified in the #GtkSourceLanguage set with
gtk_source_buffer_set_language().
If @highlight is %FALSE, syntax highlighting is disabled and all the
#GtkTextTag objects that have been added by the syntax highlighting engine
are removed from the buffer.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="111"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1430">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="highlight" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1431">%TRUE to enable syntax highlighting, %FALSE to disable it.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_implicit_trailing_newline"
c:identifier="gtk_source_buffer_set_implicit_trailing_newline"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2935">Sets whether the @buffer has an implicit trailing newline.
If an explicit trailing newline is present in a #GtkTextBuffer, #GtkTextView
shows it as an empty line. This is generally not what the user expects.
If @implicit_trailing_newline is %TRUE (the default value):
- when a #GtkSourceFileLoader loads the content of a file into the @buffer,
the trailing newline (if present in the file) is not inserted into the
@buffer.
- when a #GtkSourceFileSaver saves the content of the @buffer into a file, a
trailing newline is added to the file.
On the other hand, if @implicit_trailing_newline is %FALSE, the file's
content is not modified when loaded into the @buffer, and the @buffer's
content is not modified when saved into a file.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="189"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2937">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="implicit_trailing_newline"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2938">the new value.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_language"
c:identifier="gtk_source_buffer_set_language">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1460">Associates a #GtkSourceLanguage with the buffer.
Note that a #GtkSourceLanguage affects not only the syntax highlighting, but
also the [context classes][context-classes]. If you want to disable just the
syntax highlighting, see gtk_source_buffer_set_highlight_syntax().
The buffer holds a reference to @language.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="121"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1462">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="language"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1463">a #GtkSourceLanguage to set, or %NULL.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</parameter>
</parameters>
</method>
<method name="set_style_scheme"
c:identifier="gtk_source_buffer_set_style_scheme">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1629">Sets a #GtkSourceStyleScheme to be used by the buffer and the view.
Note that a #GtkSourceStyleScheme affects not only the syntax highlighting,
but also other #GtkSourceView features such as highlighting the current line,
matching brackets, the line numbers, etc.
Instead of setting a %NULL @scheme, it is better to disable syntax
highlighting with gtk_source_buffer_set_highlight_syntax(), and setting the
#GtkSourceStyleScheme with the "classic" or "tango" ID, because those two
style schemes follow more closely the GTK+ theme (for example for the
background color).
The buffer holds a reference to @scheme.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="126"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1631">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="scheme"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="1632">a #GtkSourceStyleScheme or %NULL.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</parameter>
</parameters>
</method>
<method name="sort_lines"
c:identifier="gtk_source_buffer_sort_lines"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2681">Sort the lines of text between the specified iterators.</doc>
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="183"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2683">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2684">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2685">a #GtkTextIter.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2686">#GtkSourceSortFlags specifying how the sort should behave</doc>
<type name="SortFlags" c:type="GtkSourceSortFlags"/>
</parameter>
<parameter name="column" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="2687">sort considering the text starting at the given column</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="highlight-matching-brackets"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="312">Whether to highlight matching brackets in the buffer.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="highlight-syntax" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="299">Whether to highlight syntax in the buffer.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="implicit-trailing-newline"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="348">Whether the buffer has an implicit trailing newline. See
gtk_source_buffer_set_implicit_trailing_newline().</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="language" writable="1" transfer-ownership="none">
<type name="Language"/>
</property>
<property name="style-scheme" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="333">Style scheme. It contains styles for syntax highlighting, optionally
foreground, background, cursor color, current line color, and matching
brackets style.</doc>
<type name="StyleScheme"/>
</property>
<field name="parent_instance">
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer"/>
</field>
<glib:signal name="bracket-matched" when="last" version="2.12">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="428">@iter is set to a valid iterator pointing to the matching bracket
if @state is %GTK_SOURCE_BRACKET_MATCH_FOUND. Otherwise @iter is
meaningless.
The signal is emitted only when the @state changes, typically when
the cursor moves.
A use-case for this signal is to show messages in a #GtkStatusbar.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="431">if found, the location of the matching bracket.</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="432">state of bracket matching.</doc>
<type name="BracketMatchType"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="cursor-moved" when="last" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="367">The "cursor-moved" signal is emitted when then insertion mark has moved.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="highlight-updated" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="382">The ::highlight-updated signal is emitted when the syntax
highlighting and [context classes][context-classes] are updated in a
certain region of the @buffer.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="385">the start of the updated region</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="386">the end of the updated region</doc>
<type name="Gtk.TextIter"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="source-mark-updated" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="407">The ::source-mark-updated signal is emitted each time
a mark is added to, moved or removed from the @buffer.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="410">the #GtkSourceMark</doc>
<type name="Gtk.TextMark"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="BufferClass"
c:type="GtkSourceBufferClass"
glib:is-gtype-struct-for="Buffer">
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="102"/>
<field name="parent_class">
<type name="Gtk.TextBufferClass" c:type="GtkTextBufferClass"/>
</field>
<field name="bracket_matched">
<callback name="bracket_matched">
<source-position filename="../gtksourceview/gtksourcebuffer.h"
line="96"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="BracketMatchType"
c:type="GtkSourceBracketMatchType"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="ChangeCaseType"
version="3.12"
glib:type-name="GtkSourceChangeCaseType"
glib:get-type="gtk_source_change_case_type_get_type"
c:type="GtkSourceChangeCaseType">
<member name="lower"
value="0"
c:identifier="GTK_SOURCE_CHANGE_CASE_LOWER"
glib:nick="lower">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="59">change case to lowercase.</doc>
</member>
<member name="upper"
value="1"
c:identifier="GTK_SOURCE_CHANGE_CASE_UPPER"
glib:nick="upper">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="60">change case to uppercase.</doc>
</member>
<member name="toggle"
value="2"
c:identifier="GTK_SOURCE_CHANGE_CASE_TOGGLE"
glib:nick="toggle">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="61">toggle case of each character.</doc>
</member>
<member name="title"
value="3"
c:identifier="GTK_SOURCE_CHANGE_CASE_TITLE"
glib:nick="title">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="62">capitalize each word.</doc>
</member>
</enumeration>
<class name="Completion"
c:symbol-prefix="completion"
c:type="GtkSourceCompletion"
parent="GObject.Object"
glib:type-name="GtkSourceCompletion"
glib:get-type="gtk_source_completion_get_type"
glib:type-struct="CompletionClass">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="33"/>
<function name="fuzzy_highlight"
c:identifier="gtk_source_completion_fuzzy_highlight"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1554">This will add &amp;lt;b&amp;gt; tags around matched characters in @haystack
based on @casefold_query.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="63"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1562">a #PangoAttrList or %NULL</doc>
<type name="Pango.AttrList" c:type="PangoAttrList*"/>
</return-value>
<parameters>
<parameter name="haystack" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1556">the string to be highlighted</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="casefold_query" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1557">the typed-text used to highlight @haystack</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="fuzzy_match"
c:identifier="gtk_source_completion_fuzzy_match"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1446">This helper function can do a fuzzy match for you giving a haystack and
casefolded needle. Casefold your needle using g_utf8_casefold() before
running the query.
Score will be set with the score of the match upon success. Otherwise,
it will be set to zero.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="59"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1459">%TRUE if @haystack matched @casefold_needle, otherwise %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="haystack"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1448">the string to be searched.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="casefold_needle" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1449">A g_utf8_casefold() version of the needle.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="priority"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1450">An optional location for the score of the match</doc>
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</function>
<method name="add_provider"
c:identifier="gtk_source_completion_add_provider"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1265">Adds an #GtkSourceCompletionProvider to the list of providers to be queried
for completion results.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1267">an #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
<parameter name="provider" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1268">an #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
</parameters>
</method>
<method name="block_interactive"
c:identifier="gtk_source_completion_block_interactive">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_completion_get_buffer"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1247">Gets the connected #GtkSourceView's #GtkSourceBuffer</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="38"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1253">A #GtkSourceBuffer</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1249">a #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_page_size"
c:identifier="gtk_source_completion_get_page_size">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="54"/>
<return-value transfer-ownership="none">
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_view"
c:identifier="gtk_source_completion_get_view"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1229">Gets the #GtkSourceView that owns the #GtkSourceCompletion.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="36"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1235">A #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1231">a #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="hide"
c:identifier="gtk_source_completion_hide"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1340">Emits the "hide" signal.
When the "hide" signal is emitted, the completion window will be
dismissed.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1342">an #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_provider"
c:identifier="gtk_source_completion_remove_provider"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1286">Removes an #GtkSourceCompletionProvider previously added with
gtk_source_completion_add_provider().</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1288">an #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
<parameter name="provider" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1289">an #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
</parameters>
</method>
<method name="set_page_size"
c:identifier="gtk_source_completion_set_page_size">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="56"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
<parameter name="page_size" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="show"
c:identifier="gtk_source_completion_show"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1315">Emits the "show" signal.
When the "show" signal is emitted, the completion window will be
displayed if there are any results available.</doc>
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1317">an #GtkSourceCompletion</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<method name="unblock_interactive"
c:identifier="gtk_source_completion_unblock_interactive">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Completion" c:type="GtkSourceCompletion*"/>
</instance-parameter>
</parameters>
</method>
<property name="buffer" version="5.0" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="990">The #GtkTextBuffer for the #GtkSourceCompletion:view.
This is a convenience property for providers.</doc>
<type name="Gtk.TextView"/>
</property>
<property name="page-size"
version="5.0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1005">The number of rows to display to the user before scrolling.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="remember-info-visibility"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1019">Determines whether the visibility of the info window should be saved when the
completion is hidden, and restored when the completion is shown again.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="select-on-show" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1032">Determines whether the first proposal should be selected when the completion
is first shown.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="show-icons" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1045">The "show-icons" property denotes if icons should be displayed within
the list of completions presented to the user.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="view"
version="5.0"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1058">The "view" property is the #GtkTextView for which this #GtkSourceCompletion
is providing completion features.</doc>
<type name="View"/>
</property>
<glib:signal name="hide" when="last" action="1" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1117">The "hide" signal is emitted when the completion window should
be hidden.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="provider-added" when="last" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1075">The "provided-added" signal is emitted when a new provider is
added to the completion.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="provider" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1078">an #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="provider-removed" when="last" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1096">The "provided-removed" signal is emitted when a provider has
been removed from the completion.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="provider" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1099">an #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="show" when="last" action="1" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="1138">The "show" signal is emitted when the completion window should
be shown.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<enumeration name="CompletionActivation"
glib:type-name="GtkSourceCompletionActivation"
glib:get-type="gtk_source_completion_activation_get_type"
c:type="GtkSourceCompletionActivation">
<member name="none"
value="0"
c:identifier="GTK_SOURCE_COMPLETION_ACTIVATION_NONE"
glib:nick="none">
</member>
<member name="interactive"
value="1"
c:identifier="GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE"
glib:nick="interactive">
</member>
<member name="user_requested"
value="2"
c:identifier="GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED"
glib:nick="user-requested">
</member>
</enumeration>
<class name="CompletionCell"
c:symbol-prefix="completion_cell"
c:type="GtkSourceCompletionCell"
parent="Gtk.Widget"
glib:type-name="GtkSourceCompletionCell"
glib:get-type="gtk_source_completion_cell_get_type"
glib:type-struct="CompletionCellClass">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="43"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<method name="get_column"
c:identifier="gtk_source_completion_cell_get_column">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="46"/>
<return-value transfer-ownership="none">
<type name="CompletionColumn" c:type="GtkSourceCompletionColumn"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_widget"
c:identifier="gtk_source_completion_cell_get_widget"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncell.c"
line="311">Gets the child #GtkWidget, if any.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="48"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncell.c"
line="317">a #GtkWidget or %NULL</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncell.c"
line="313">a #GtkSourceCompletionCell</doc>
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_gicon"
c:identifier="gtk_source_completion_cell_set_gicon">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="gicon" transfer-ownership="none">
<type name="Gio.Icon" c:type="GIcon*"/>
</parameter>
</parameters>
</method>
<method name="set_icon_name"
c:identifier="gtk_source_completion_cell_set_icon_name">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="56"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="icon_name" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_markup"
c:identifier="gtk_source_completion_cell_set_markup">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="markup" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_paintable"
c:identifier="gtk_source_completion_cell_set_paintable">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="paintable" transfer-ownership="none">
<type name="Gdk.Paintable" c:type="GdkPaintable*"/>
</parameter>
</parameters>
</method>
<method name="set_text"
c:identifier="gtk_source_completion_cell_set_text">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="65"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_text_with_attributes"
c:identifier="gtk_source_completion_cell_set_text_with_attributes">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="attrs" transfer-ownership="none">
<type name="Pango.AttrList" c:type="PangoAttrList*"/>
</parameter>
</parameters>
</method>
<method name="set_widget"
c:identifier="gtk_source_completion_cell_set_widget">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</instance-parameter>
<parameter name="child" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
</parameters>
</method>
<property name="column"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="CompletionColumn"/>
</property>
<property name="markup" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="paintable" writable="1" transfer-ownership="none">
<type name="Gdk.Paintable"/>
</property>
<property name="text" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="widget" writable="1" transfer-ownership="none">
<type name="Gtk.Widget"/>
</property>
</class>
<record name="CompletionCellClass"
c:type="GtkSourceCompletionCellClass"
glib:is-gtype-struct-for="CompletionCell">
<source-position filename="../gtksourceview/gtksourcecompletioncell.h"
line="43"/>
<field name="parent_class">
<type name="Gtk.WidgetClass" c:type="GtkWidgetClass"/>
</field>
</record>
<record name="CompletionClass"
c:type="GtkSourceCompletionClass"
glib:is-gtype-struct-for="Completion">
<source-position filename="../gtksourceview/gtksourcecompletion.h"
line="33"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="CompletionColumn"
glib:type-name="GtkSourceCompletionColumn"
glib:get-type="gtk_source_completion_column_get_type"
c:type="GtkSourceCompletionColumn">
<member name="icon"
value="0"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_ICON"
glib:nick="icon">
</member>
<member name="before"
value="1"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_BEFORE"
glib:nick="before">
</member>
<member name="typed_text"
value="2"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_TYPED_TEXT"
glib:nick="typed-text">
</member>
<member name="after"
value="3"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_AFTER"
glib:nick="after">
</member>
<member name="comment"
value="4"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_COMMENT"
glib:nick="comment">
</member>
<member name="details"
value="5"
c:identifier="GTK_SOURCE_COMPLETION_COLUMN_DETAILS"
glib:nick="details">
</member>
</enumeration>
<class name="CompletionContext"
c:symbol-prefix="completion_context"
c:type="GtkSourceCompletionContext"
parent="GObject.Object"
glib:type-name="GtkSourceCompletionContext"
glib:get-type="gtk_source_completion_context_get_type"
glib:type-struct="CompletionContextClass">
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="40"/>
<implements name="Gio.ListModel"/>
<method name="get_activation"
c:identifier="gtk_source_completion_context_get_activation"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="1032">Gets the mode for which the context was activated.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="45"/>
<return-value transfer-ownership="none">
<type name="CompletionActivation"
c:type="GtkSourceCompletionActivation"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="1034">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_bounds"
c:identifier="gtk_source_completion_context_get_bounds"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="438">Gets the bounds for the completion, which is the beginning of the
current word (taking break characters into account) to the current
insertion cursor.
If @begin is non-%NULL, it will be set to the start position of the
current word being completed.
If @end is non-%NULL, it will be set to the insertion cursor for the
current word being completed.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="454">%TRUE if the marks are still valid and @begin or @end was set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="440">an #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
<parameter name="begin"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="441">a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="442">a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_completion_context_get_buffer"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="866">Gets the underlying buffer used by the context.
This is a convenience function to get the buffer via the #GtkSourceCompletion
property.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="62"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="875">a #GtkTextBuffer or %NULL</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="868">an #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_busy"
c:identifier="gtk_source_completion_context_get_busy"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="846">Gets the "busy" property. This is set to %TRUE while the completion
context is actively fetching proposals from registered
#GtkSourceCompletionProvider's.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="58"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="854">%TRUE if the context is busy</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="848">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_completion"
c:identifier="gtk_source_completion_context_get_completion"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="503">Gets the #GtkSourceCompletion that created the context.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="43"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="509">an #GtkSourceCompletion or %NULL</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="505">an #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_empty"
c:identifier="gtk_source_completion_context_get_empty"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="952">Checks if any proposals have been provided to the context.
Out of convenience, this function will return %TRUE if @self is %NULL.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="54"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="960">%TRUE if there are no proposals in the context</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="954">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_language"
c:identifier="gtk_source_completion_context_get_language"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="1048">Gets the language of the underlying buffer, if any.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="64"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="1054">a #GtkSourceLanguage or %NULL</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="1050">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_start_iter"
c:identifier="gtk_source_completion_context_get_start_iter">
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_view"
c:identifier="gtk_source_completion_context_get_view"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="890">Gets the text view for the context.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="60"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="896">a #GtkSourceView or %NULL</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="892">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_word"
c:identifier="gtk_source_completion_context_get_word"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="972">Gets the word that is being completed up to the position of the insert mark.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="56"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="978">a string containing the current word</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="974">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_proposals_for_provider"
c:identifier="gtk_source_completion_context_set_proposals_for_provider"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="606">This function allows providers to update their results for a context
outside of a call to gtk_source_completion_provider_populate_async(). This
can be used to immediately return results for a provider while it does
additional asynchronous work. Doing so will allow the completions to
update while the operation is in progress.</doc>
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="66"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="608">an #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</instance-parameter>
<parameter name="provider" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="609">an #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="results"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="610">a #GListModel or %NULL</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</parameter>
</parameters>
</method>
<property name="busy" version="5.0" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="281">The "busy" property is %TRUE while the completion context is
populating completion proposals.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="completion"
version="5.0"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="313">The "completion" is the #GtkSourceCompletion that was used to create the context.</doc>
<type name="Completion"/>
</property>
<property name="empty" version="5.0" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="296">The "empty" property is %TRUE when there are no results.
It will be notified when the first result is added or the last
result is removed.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
</class>
<record name="CompletionContextClass"
c:type="GtkSourceCompletionContextClass"
glib:is-gtype-struct-for="CompletionContext">
<source-position filename="../gtksourceview/gtksourcecompletioncontext.h"
line="40"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<interface name="CompletionProposal"
c:symbol-prefix="completion_proposal"
c:type="GtkSourceCompletionProposal"
glib:type-name="GtkSourceCompletionProposal"
glib:get-type="gtk_source_completion_proposal_get_type"
glib:type-struct="CompletionProposalInterface">
<source-position filename="../gtksourceview/gtksourcecompletionproposal.h"
line="38"/>
</interface>
<record name="CompletionProposalInterface"
c:type="GtkSourceCompletionProposalInterface"
glib:is-gtype-struct-for="CompletionProposal">
<source-position filename="../gtksourceview/gtksourcecompletionproposal.h"
line="38"/>
<field name="parent_iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
</record>
<interface name="CompletionProvider"
c:symbol-prefix="completion_provider"
c:type="GtkSourceCompletionProvider"
glib:type-name="GtkSourceCompletionProvider"
glib:get-type="gtk_source_completion_provider_get_type"
glib:type-struct="CompletionProviderInterface">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="72"/>
<virtual-method name="activate" invoker="activate" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="355">This function requests @proposal to be activated by the
#GtkSourceCompletionProvider.
What the provider does to activate the proposal is specific to that
provider. Many providers may choose to insert a #GtkSourceSnippet with
edit points the user may cycle through.
See also: #GtkSourceSnippet, #GtkSourceSnippetChunk, gtk_source_view_push_snippet()</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="66"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="357">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="358">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="359">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="display" invoker="display" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="323">This function requests that the #GtkSourceCompletionProvider prepares
@cell to display the contents of @proposal. Based on @cells column
type, you may want to display different information.
This allows for columns of information among completion proposals
resulting in better alignment of similar content (icons, return types,
method names, and parameter lists).</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="325">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="326">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="327">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="cell" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="328">a #GtkSourceCompletionCell</doc>
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_priority" invoker="get_priority" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="151">This function should return the priority of @self in @context.
The priority is used to sort groups of completion proposals by
provider so that higher priority providers results are shown
above lower priority providers.
Lower value indicates higher priority.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="38"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="153">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="154">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_title" invoker="get_title" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="127">Gets the title of the completion provider, if any.
Currently, titles are not displayed in the completion results, but may be
at some point in the future when non-%NULL.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="37"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="136">a title for the provider or %NULL</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="129">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="is_trigger" invoker="is_trigger" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="179">This function is used to determine of a character inserted into the text
editor should cause a new completion request to be triggered.
An example would be period '.' which might indicate that the user wants
to complete method or field names of an object.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="181">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="182">a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="ch" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="183">a #gunichar of the character inserted</doc>
<type name="gunichar" c:type="gunichar"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="key_activates"
invoker="key_activates"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="207">This function is used to determine if a key typed by the user should
activate @proposal (resulting in committing the text to the editor).
This is useful when using languages where convention may lead to less
typing by the user. One example may be the use of "." or "-" to expand
a field access in the C programming language.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="209">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="210">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="211">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="212">a keyval such as %GDK_KEY_period</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="213">a #GdkModifierType or 0</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="list_alternates"
invoker="list_alternates"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="384">Providers should return a list of alternates to @proposal or %NULL if
there are no alternates available. This can be used by the completion
view to allow the user to move laterally through similar proposals, such
as overrides of methods by the same name.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="69"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="395">
a #GPtrArray of #GtkSourceCompletionProposal or %NULL.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="CompletionProposal"/>
</array>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="386">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="387">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="388">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="populate" introspectable="0" throws="1">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="48"/>
<return-value>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="populate_async"
invoker="populate_async"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="241">Asynchronously requests that the provider populates the completion
results for @context.
For providers that would like to populate a #GListModel while those
results are displayed to the user,
gtk_source_completion_context_set_proposals_for_provider() may be used
to reduce latency until the user sees results.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="243">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="244">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="245">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="246">a callback to execute upon completion</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="3">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="247">closure data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="populate_finish"
invoker="populate_finish"
version="5.0"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="273">Completes an asynchronous operation to populate a completion provider.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="56"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="281">a #GListModel of #GtkSourceCompletionProposal</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="275">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="276">a #GAsyncResult provided to callback</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="refilter" invoker="refilter" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="295">This function can be used to filter results previously provided to
the #GtkSourceCompletionContext by the #GtkSourceCompletionProvider.
This can happen as the user types additionl text onto the word so
that previously matched items may be removed from the list instead of
generating new #GListModel of results.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="297">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="298">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="model" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="299">a #GListModel</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</parameter>
</parameters>
</virtual-method>
<method name="activate"
c:identifier="gtk_source_completion_provider_activate"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="355">This function requests @proposal to be activated by the
#GtkSourceCompletionProvider.
What the provider does to activate the proposal is specific to that
provider. Many providers may choose to insert a #GtkSourceSnippet with
edit points the user may cycle through.
See also: #GtkSourceSnippet, #GtkSourceSnippetChunk, gtk_source_view_push_snippet()</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="109"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="357">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="358">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="359">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</method>
<method name="display"
c:identifier="gtk_source_completion_provider_display"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="323">This function requests that the #GtkSourceCompletionProvider prepares
@cell to display the contents of @proposal. Based on @cells column
type, you may want to display different information.
This allows for columns of information among completion proposals
resulting in better alignment of similar content (icons, return types,
method names, and parameter lists).</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="104"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="325">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="326">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="327">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="cell" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="328">a #GtkSourceCompletionCell</doc>
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</parameter>
</parameters>
</method>
<method name="get_priority"
c:identifier="gtk_source_completion_provider_get_priority"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="151">This function should return the priority of @self in @context.
The priority is used to sort groups of completion proposals by
provider so that higher priority providers results are shown
above lower priority providers.
Lower value indicates higher priority.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="77"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="153">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="154">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
</parameters>
</method>
<method name="get_title"
c:identifier="gtk_source_completion_provider_get_title"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="127">Gets the title of the completion provider, if any.
Currently, titles are not displayed in the completion results, but may be
at some point in the future when non-%NULL.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="75"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="136">a title for the provider or %NULL</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="129">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_trigger"
c:identifier="gtk_source_completion_provider_is_trigger"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="179">This function is used to determine of a character inserted into the text
editor should cause a new completion request to be triggered.
An example would be period '.' which might indicate that the user wants
to complete method or field names of an object.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="80"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="181">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="182">a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="ch" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="183">a #gunichar of the character inserted</doc>
<type name="gunichar" c:type="gunichar"/>
</parameter>
</parameters>
</method>
<method name="key_activates"
c:identifier="gtk_source_completion_provider_key_activates"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="207">This function is used to determine if a key typed by the user should
activate @proposal (resulting in committing the text to the editor).
This is useful when using languages where convention may lead to less
typing by the user. One example may be the use of "." or "-" to expand
a field access in the C programming language.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="84"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="209">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="210">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="211">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="212">a keyval such as %GDK_KEY_period</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="213">a #GdkModifierType or 0</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
</parameters>
</method>
<method name="list_alternates"
c:identifier="gtk_source_completion_provider_list_alternates"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="384">Providers should return a list of alternates to @proposal or %NULL if
there are no alternates available. This can be used by the completion
view to allow the user to move laterally through similar proposals, such
as overrides of methods by the same name.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="113"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="395">
a #GPtrArray of #GtkSourceCompletionProposal or %NULL.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="CompletionProposal"/>
</array>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="386">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="387">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="388">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</method>
<method name="populate_async"
c:identifier="gtk_source_completion_provider_populate_async"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="241">Asynchronously requests that the provider populates the completion
results for @context.
For providers that would like to populate a #GListModel while those
results are displayed to the user,
gtk_source_completion_context_set_proposals_for_provider() may be used
to reduce latency until the user sees results.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="90"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="243">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="244">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="245">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="246">a callback to execute upon completion</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="247">closure data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="populate_finish"
c:identifier="gtk_source_completion_provider_populate_finish"
version="5.0"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="273">Completes an asynchronous operation to populate a completion provider.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="96"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="281">a #GListModel of #GtkSourceCompletionProposal</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="275">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="276">a #GAsyncResult provided to callback</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="refilter"
c:identifier="gtk_source_completion_provider_refilter"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="295">This function can be used to filter results previously provided to
the #GtkSourceCompletionContext by the #GtkSourceCompletionProvider.
This can happen as the user types additionl text onto the word so
that previously matched items may be removed from the list instead of
generating new #GListModel of results.</doc>
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="100"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="297">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="298">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="model" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="299">a #GListModel</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</parameter>
</parameters>
</method>
</interface>
<record name="CompletionProviderInterface"
c:type="GtkSourceCompletionProviderInterface"
glib:is-gtype-struct-for="CompletionProvider">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="72"/>
<field name="parent_iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_title">
<callback name="get_title">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="37"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="136">a title for the provider or %NULL</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="129">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_priority">
<callback name="get_priority">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="38"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="153">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="154">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="is_trigger">
<callback name="is_trigger">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="181">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="182">a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="ch" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="183">a #gunichar of the character inserted</doc>
<type name="gunichar" c:type="gunichar"/>
</parameter>
</parameters>
</callback>
</field>
<field name="key_activates">
<callback name="key_activates">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="209">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="210">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="211">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="212">a keyval such as %GDK_KEY_period</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="213">a #GdkModifierType or 0</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
</parameters>
</callback>
</field>
<field name="populate" introspectable="0">
<callback name="populate" introspectable="0" throws="1">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="48"/>
<return-value>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="populate_async">
<callback name="populate_async">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="243">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="244">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="245">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="246">a callback to execute upon completion</doc>
<type name="Gio.AsyncReadyCallback"
c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="247">closure data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="populate_finish">
<callback name="populate_finish" throws="1">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="56"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="281">a #GListModel of #GtkSourceCompletionProposal</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="275">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="276">a #GAsyncResult provided to callback</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="refilter">
<callback name="refilter">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="297">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="298">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="model" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="299">a #GListModel</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="display">
<callback name="display">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="325">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="326">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="327">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
<parameter name="cell" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="328">a #GtkSourceCompletionCell</doc>
<type name="CompletionCell" c:type="GtkSourceCompletionCell*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="activate">
<callback name="activate">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="66"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="357">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="358">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="359">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="list_alternates">
<callback name="list_alternates">
<source-position filename="../gtksourceview/gtksourcecompletionprovider.h"
line="69"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="395">
a #GPtrArray of #GtkSourceCompletionProposal or %NULL.</doc>
<array name="GLib.PtrArray" c:type="GPtrArray*">
<type name="CompletionProposal"/>
</array>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="386">a #GtkSourceCompletionProvider</doc>
<type name="CompletionProvider"
c:type="GtkSourceCompletionProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="387">a #GtkSourceCompletionContext</doc>
<type name="CompletionContext"
c:type="GtkSourceCompletionContext*"/>
</parameter>
<parameter name="proposal" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="388">a #GtkSourceCompletionProposal</doc>
<type name="CompletionProposal"
c:type="GtkSourceCompletionProposal*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="CompletionSnippets"
c:symbol-prefix="completion_snippets"
c:type="GtkSourceCompletionSnippets"
parent="GObject.Object"
glib:type-name="GtkSourceCompletionSnippets"
glib:get-type="gtk_source_completion_snippets_get_type"
glib:type-struct="CompletionSnippetsClass">
<source-position filename="../gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.h"
line="44"/>
<implements name="CompletionProvider"/>
<constructor name="new"
c:identifier="gtk_source_completion_snippets_new">
<source-position filename="../gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.h"
line="47"/>
<return-value transfer-ownership="full">
<type name="CompletionSnippets"
c:type="GtkSourceCompletionSnippets*"/>
</return-value>
</constructor>
<property name="priority"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="title"
writable="1"
construct="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="CompletionSnippetsClass"
c:type="GtkSourceCompletionSnippetsClass"
glib:is-gtype-struct-for="CompletionSnippets">
<source-position filename="../gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.h"
line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="CompletionWords"
c:symbol-prefix="completion_words"
c:type="GtkSourceCompletionWords"
parent="GObject.Object"
glib:type-name="GtkSourceCompletionWords"
glib:get-type="gtk_source_completion_words_get_type"
glib:type-struct="CompletionWordsClass">
<source-position filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.h"
line="41"/>
<implements name="CompletionProvider"/>
<constructor name="new" c:identifier="gtk_source_completion_words_new">
<source-position filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.h"
line="47"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="562">a new #GtkSourceCompletionWords provider</doc>
<type name="CompletionWords" c:type="GtkSourceCompletionWords*"/>
</return-value>
<parameters>
<parameter name="title"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="560">The title for the provider, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<method name="register"
c:identifier="gtk_source_completion_words_register">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="582">Registers @buffer in the @words provider.</doc>
<source-position filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.h"
line="49"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="words" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="584">a #GtkSourceCompletionWords</doc>
<type name="CompletionWords" c:type="GtkSourceCompletionWords*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="585">a #GtkTextBuffer</doc>
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer*"/>
</parameter>
</parameters>
</method>
<method name="unregister"
c:identifier="gtk_source_completion_words_unregister">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="628">Unregisters @buffer from the @words provider.</doc>
<source-position filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.h"
line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="words" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="630">a #GtkSourceCompletionWords</doc>
<type name="CompletionWords" c:type="GtkSourceCompletionWords*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="631">a #GtkTextBuffer</doc>
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer*"/>
</parameter>
</parameters>
</method>
<property name="minimum-word-size"
writable="1"
construct="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="priority"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="proposals-batch-size"
writable="1"
construct="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="scan-batch-size"
writable="1"
construct="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="title"
writable="1"
construct="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="CompletionWordsClass"
c:type="GtkSourceCompletionWordsClass"
glib:is-gtype-struct-for="CompletionWords">
<source-position filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.h"
line="41"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="CompressionType"
version="3.14"
glib:type-name="GtkSourceCompressionType"
glib:get-type="gtk_source_compression_type_get_type"
c:type="GtkSourceCompressionType">
<member name="none"
value="0"
c:identifier="GTK_SOURCE_COMPRESSION_TYPE_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="65">plain text.</doc>
</member>
<member name="gzip"
value="1"
c:identifier="GTK_SOURCE_COMPRESSION_TYPE_GZIP"
glib:nick="gzip">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="66">gzip compression.</doc>
</member>
</enumeration>
<record name="Encoding"
c:type="GtkSourceEncoding"
glib:type-name="GtkSourceEncoding"
glib:get-type="gtk_source_encoding_get_type"
c:symbol-prefix="encoding">
<source-position filename="../gtksourceview/gtksourcetypes.h" line="44"/>
<method name="copy"
c:identifier="gtk_source_encoding_copy"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="685">Used by language bindings.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="57"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="691">a copy of @enc.</doc>
<type name="Encoding" c:type="GtkSourceEncoding*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="687">a #GtkSourceEncoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</instance-parameter>
</parameters>
</method>
<method name="free"
c:identifier="gtk_source_encoding_free"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="702">Used by language bindings.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="704">a #GtkSourceEncoding.</doc>
<type name="Encoding" c:type="GtkSourceEncoding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_charset"
c:identifier="gtk_source_encoding_get_charset"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="453">Gets the character set of the #GtkSourceEncoding, such as "UTF-8" or
"ISO-8859-1".</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="45"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="460">the character set of the #GtkSourceEncoding.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="455">a #GtkSourceEncoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="gtk_source_encoding_get_name"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="475">Gets the name of the #GtkSourceEncoding such as "Unicode" or "Western".</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="43"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="481">the name of the #GtkSourceEncoding.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="477">a #GtkSourceEncoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</instance-parameter>
</parameters>
</method>
<method name="to_string"
c:identifier="gtk_source_encoding_to_string"
version="3.14">
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="41"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="427">a string representation. Free with g_free() when no longer needed.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="enc" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="425">a #GtkSourceEncoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</instance-parameter>
</parameters>
</method>
<function name="get_all"
c:identifier="gtk_source_encoding_get_all"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="344">Gets all encodings.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="51"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="349">a list of
all #GtkSourceEncoding's. Free with g_slist_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Encoding"/>
</type>
</return-value>
</function>
<function name="get_current"
c:identifier="gtk_source_encoding_get_current"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="381">Gets the #GtkSourceEncoding for the current locale. See also g_get_charset().</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="386">the current locale encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
</function>
<function name="get_default_candidates"
c:identifier="gtk_source_encoding_get_default_candidates"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="597">Gets the list of default candidate encodings to try when loading a file. See
gtk_source_file_loader_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.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="53"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="607">the list of
default candidate encodings. Free with g_slist_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Encoding"/>
</type>
</return-value>
</function>
<function name="get_from_charset"
c:identifier="gtk_source_encoding_get_from_charset"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="302">Gets a #GtkSourceEncoding from a character set such as "UTF-8" or
"ISO-8859-1".</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="39"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="309">the corresponding #GtkSourceEncoding, or %NULL
if not found.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
<parameters>
<parameter name="charset" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="304">a character set.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="get_utf8"
c:identifier="gtk_source_encoding_get_utf8"
version="3.14">
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="372">the UTF-8 encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
</function>
</record>
<class name="File"
c:symbol-prefix="file"
c:type="GtkSourceFile"
parent="GObject.Object"
glib:type-name="GtkSourceFile"
glib:get-type="gtk_source_file_get_type"
glib:type-struct="FileClass">
<source-position filename="../gtksourceview/gtksourcefile.h" line="98"/>
<constructor name="new"
c:identifier="gtk_source_file_new"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefile.h"
line="102"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="258">a new #GtkSourceFile object.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</return-value>
</constructor>
<method name="check_file_on_disk"
c:identifier="gtk_source_file_check_file_on_disk"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="524">Checks synchronously the file on disk, to know whether the file is externally
modified, or has been deleted, and whether the file is read-only.
#GtkSourceFile doesn't create a #GFileMonitor to track those properties, so
this function needs to be called instead. Creating lots of #GFileMonitor's
would take lots of resources.
Since this function is synchronous, it is advised to call it only on local
files. See gtk_source_file_is_local().</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="120"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="526">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_compression_type"
c:identifier="gtk_source_file_get_compression_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefile.h"
line="113"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="400">the compression type.</doc>
<type name="CompressionType" c:type="GtkSourceCompressionType"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="398">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_encoding"
c:identifier="gtk_source_file_get_encoding"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="329">The encoding is initially %NULL. After a successful file loading or saving
operation, the encoding is non-%NULL.</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="109"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="336">the character encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="331">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_location"
c:identifier="gtk_source_file_get_location"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefile.h"
line="104"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="301">the #GFile.</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="299">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_newline_type"
c:identifier="gtk_source_file_get_newline_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefile.h"
line="111"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="368">the newline type.</doc>
<type name="NewlineType" c:type="GtkSourceNewlineType"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="366">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_deleted"
c:identifier="gtk_source_file_is_deleted"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="641">Returns whether the file has been deleted. If the
#GtkSourceFile:location is %NULL, returns %FALSE.
To have an up-to-date value, you must first call
gtk_source_file_check_file_on_disk().</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="126"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="651">whether the file has been deleted.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="643">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_externally_modified"
c:identifier="gtk_source_file_is_externally_modified"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="607">Returns whether the file is externally modified. If the
#GtkSourceFile:location is %NULL, returns %FALSE.
To have an up-to-date value, you must first call
gtk_source_file_check_file_on_disk().</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="124"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="617">whether the file is externally modified.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="609">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_local"
c:identifier="gtk_source_file_is_local"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="499">Returns whether the file is local. If the #GtkSourceFile:location is %NULL,
returns %FALSE.</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="122"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="506">whether the file is local.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="501">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_readonly"
c:identifier="gtk_source_file_is_readonly"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="681">Returns whether the file is read-only. If the
#GtkSourceFile:location is %NULL, returns %FALSE.
To have an up-to-date value, you must first call
gtk_source_file_check_file_on_disk().</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="128"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="691">whether the file is read-only.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="683">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_location"
c:identifier="gtk_source_file_set_location"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="267">Sets the location.</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="106"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="269">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
<parameter name="location"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="270">the new #GFile, or %NULL.</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</method>
<method name="set_mount_operation_factory"
c:identifier="gtk_source_file_set_mount_operation_factory"
version="3.14"
introspectable="0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="413">Sets a #GtkSourceMountOperationFactory function that will be called when a
#GMountOperation must be created. This is useful for creating a
#GtkMountOperation with the parent #GtkWindow.
If a mount operation factory isn't set, g_mount_operation_new() will be
called.</doc>
<source-position filename="../gtksourceview/gtksourcefile.h"
line="115"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="415">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</instance-parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="416">a #GtkSourceMountOperationFactory to call when a
#GMountOperation is needed.</doc>
<type name="MountOperationFactory"
c:type="GtkSourceMountOperationFactory"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="418">the data to pass to the @callback function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="419">function to call on @user_data when the @callback is no
longer needed, or %NULL.</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<property name="compression-type"
version="3.14"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="210">The compression type.</doc>
<type name="CompressionType"/>
</property>
<property name="encoding" version="3.14" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="178">The character encoding, initially %NULL. After a successful file
loading or saving operation, the encoding is non-%NULL.</doc>
<type name="Encoding"/>
</property>
<property name="location"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="162">The location.</doc>
<type name="Gio.File"/>
</property>
<property name="newline-type" version="3.14" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="194">The line ending type.</doc>
<type name="NewlineType"/>
</property>
<property name="read-only" version="3.18" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="226">Whether the file is read-only or not. The value of this property is
not updated automatically (there is no file monitors).</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="FileClass"
c:type="GtkSourceFileClass"
glib:is-gtype-struct-for="File">
<source-position filename="../gtksourceview/gtksourcefile.h" line="98"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="FileLoader"
c:symbol-prefix="file_loader"
c:type="GtkSourceFileLoader"
parent="GObject.Object"
glib:type-name="GtkSourceFileLoader"
glib:get-type="gtk_source_file_loader_get_type"
glib:type-struct="FileLoaderClass">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="57"/>
<constructor name="new"
c:identifier="gtk_source_file_loader_new"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="909">Creates a new #GtkSourceFileLoader object. The contents is read from the
#GtkSourceFile's location. If not already done, call
gtk_source_file_set_location() before calling this constructor. The previous
location is anyway not needed, because as soon as the file loading begins,
the @buffer is emptied.</doc>
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="62"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="920">a new #GtkSourceFileLoader object.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="911">the #GtkSourceBuffer to load the contents into.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="912">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_stream"
c:identifier="gtk_source_file_loader_new_from_stream"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="936">Creates a new #GtkSourceFileLoader object. The contents is read from @stream.</doc>
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="65"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="944">a new #GtkSourceFileLoader object.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="938">the #GtkSourceBuffer to load the contents into.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="939">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="940">the #GInputStream to load, e.g. stdin.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
</parameters>
</constructor>
<method name="get_buffer"
c:identifier="gtk_source_file_loader_get_buffer"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1003">the #GtkSourceBuffer to load the contents into.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1001">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_compression_type"
c:identifier="gtk_source_file_loader_get_compression_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="97"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1314">the detected compression type.</doc>
<type name="CompressionType" c:type="GtkSourceCompressionType"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1312">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_encoding"
c:identifier="gtk_source_file_loader_get_encoding"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1283">the detected file encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1281">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_file"
c:identifier="gtk_source_file_loader_get_file"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="74"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1018">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1016">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_input_stream"
c:identifier="gtk_source_file_loader_get_input_stream"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="78"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1049">the #GInputStream to load, or %NULL
if a #GFile is used.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1047">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_location"
c:identifier="gtk_source_file_loader_get_location"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="76"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1033">the #GFile to load, or %NULL
if an input stream is used.</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1031">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_newline_type"
c:identifier="gtk_source_file_loader_get_newline_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="95"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1298">the detected newline type.</doc>
<type name="NewlineType" c:type="GtkSourceNewlineType"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1296">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
</parameters>
</method>
<method name="load_async"
c:identifier="gtk_source_file_loader_load_async"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1061">Loads asynchronously the file or input stream contents into the
#GtkSourceBuffer. See the #GAsyncResult documentation to know how to use this
function.</doc>
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="80"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1063">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
<parameter name="io_priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1064">the I/O priority of the request. E.g. %G_PRIORITY_LOW,
%G_PRIORITY_DEFAULT or %G_PRIORITY_HIGH.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1066">optional #GCancellable object, %NULL to ignore.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="progress_callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="notified"
closure="3"
destroy="4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1067">function to call back with
progress information, or %NULL if progress information is not needed.</doc>
<type name="Gio.FileProgressCallback"
c:type="GFileProgressCallback"/>
</parameter>
<parameter name="progress_callback_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1069">user data to pass to @progress_callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="progress_callback_notify"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1070">function to call on
@progress_callback_data when the @progress_callback is no longer needed, or
%NULL.</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="6">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1073">a #GAsyncReadyCallback to call when the request is
satisfied.</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1075">user data to pass to @callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="load_finish"
c:identifier="gtk_source_file_loader_load_finish"
version="3.14"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1169">Finishes a file loading started with gtk_source_file_loader_load_async().
If the contents has been loaded, the following #GtkSourceFile properties will
be updated: the location, the encoding, the newline type and the compression
type.</doc>
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1181">whether the contents has been loaded successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1171">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="1172">a #GAsyncResult.</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="set_candidate_encodings"
c:identifier="gtk_source_file_loader_set_candidate_encodings"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="963">Sets the candidate encodings for the file loading. The encodings are tried in
the same order as the list.
For convenience, @candidate_encodings can contain duplicates. Only the first
occurrence of a duplicated encoding is kept in the list.
By default the candidate encodings are (in that order in the list):
1. If set, the #GtkSourceFile's encoding as returned by
gtk_source_file_get_encoding().
2. The default candidates as returned by
gtk_source_encoding_get_default_candidates().</doc>
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="loader" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="965">a #GtkSourceFileLoader.</doc>
<type name="FileLoader" c:type="GtkSourceFileLoader*"/>
</instance-parameter>
<parameter name="candidate_encodings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="966">a list of
#GtkSourceEncoding&lt;!-- --&gt;s.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Encoding"/>
</type>
</parameter>
</parameters>
</method>
<property name="buffer"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="380">The #GtkSourceBuffer to load the contents into. The
#GtkSourceFileLoader object has a weak reference to the buffer.</doc>
<type name="Buffer"/>
</property>
<property name="file"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="397">The #GtkSourceFile. The #GtkSourceFileLoader object has a weak
reference to the file.</doc>
<type name="File"/>
</property>
<property name="input-stream"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="432">The #GInputStream to load. Useful for reading stdin. If this property
is set, the #GtkSourceFileLoader:location property is ignored.</doc>
<type name="Gio.InputStream"/>
</property>
<property name="location"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="414">The #GFile to load. If the #GtkSourceFileLoader:input-stream is
%NULL, by default the location is taken from the #GtkSourceFile at
construction time.</doc>
<type name="Gio.File"/>
</property>
</class>
<record name="FileLoaderClass"
c:type="GtkSourceFileLoaderClass"
glib:is-gtype-struct-for="FileLoader">
<source-position filename="../gtksourceview/gtksourcefileloader.h"
line="57"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="FileLoaderError"
glib:type-name="GtkSourceFileLoaderError"
glib:get-type="gtk_source_file_loader_error_get_type"
c:type="GtkSourceFileLoaderError"
glib:error-domain="gtk-source-file-loader-error">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.h"
line="39">An error code used with the %GTK_SOURCE_FILE_LOADER_ERROR domain.</doc>
<member name="too_big"
value="0"
c:identifier="GTK_SOURCE_FILE_LOADER_ERROR_TOO_BIG"
glib:nick="too-big">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.h"
line="41">The file is too big.</doc>
</member>
<member name="encoding_auto_detection_failed"
value="1"
c:identifier="GTK_SOURCE_FILE_LOADER_ERROR_ENCODING_AUTO_DETECTION_FAILED"
glib:nick="encoding-auto-detection-failed">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.h"
line="42">It is not
possible to detect the encoding automatically.</doc>
</member>
<member name="conversion_fallback"
value="2"
c:identifier="GTK_SOURCE_FILE_LOADER_ERROR_CONVERSION_FALLBACK"
glib:nick="conversion-fallback">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.h"
line="44">There was an encoding
conversion error and it was needed to use a fallback character.</doc>
</member>
<function name="quark" c:identifier="gtk_source_file_loader_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="FileSaver"
c:symbol-prefix="file_saver"
c:type="GtkSourceFileSaver"
parent="GObject.Object"
glib:type-name="GtkSourceFileSaver"
glib:get-type="gtk_source_file_saver_get_type"
glib:type-struct="FileSaverClass">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="74"/>
<constructor name="new"
c:identifier="gtk_source_file_saver_new"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1087">Creates a new #GtkSourceFileSaver object. The @buffer will be saved to the
#GtkSourceFile's location.
This constructor is suitable for a simple "save" operation, when the @file
already contains a non-%NULL #GtkSourceFile:location.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="79"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1098">a new #GtkSourceFileSaver object.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1089">the #GtkSourceBuffer to save.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1090">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_target"
c:identifier="gtk_source_file_saver_new_with_target"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1114">Creates a new #GtkSourceFileSaver object with a target location. When the
file saving is finished successfully, @target_location is set to the @file's
#GtkSourceFile:location property. If an error occurs, the previous valid
location is still available in #GtkSourceFile.
This constructor is suitable for a "save as" operation, or for saving a new
buffer for the first time.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="82"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1128">a new #GtkSourceFileSaver object.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1116">the #GtkSourceBuffer to save.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1117">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</parameter>
<parameter name="target_location" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1118">the #GFile where to save the buffer to.</doc>
<type name="Gio.File" c:type="GFile*"/>
</parameter>
</parameters>
</constructor>
<method name="get_buffer"
c:identifier="gtk_source_file_saver_get_buffer"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1151">the #GtkSourceBuffer to save.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1149">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_compression_type"
c:identifier="gtk_source_file_saver_get_compression_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="105"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1306">the compression type.</doc>
<type name="CompressionType" c:type="GtkSourceCompressionType"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1304">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_encoding"
c:identifier="gtk_source_file_saver_get_encoding"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="95"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1226">the encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1224">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_file"
c:identifier="gtk_source_file_saver_get_file"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="88"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1166">the #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1164">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags"
c:identifier="gtk_source_file_saver_get_flags"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="110"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1343">the flags.</doc>
<type name="FileSaverFlags" c:type="GtkSourceFileSaverFlags"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1341">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_location"
c:identifier="gtk_source_file_saver_get_location"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1181">the #GFile where to save the buffer to.</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1179">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_newline_type"
c:identifier="gtk_source_file_saver_get_newline_type"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1266">the newline type.</doc>
<type name="NewlineType" c:type="GtkSourceNewlineType"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1264">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
</parameters>
</method>
<method name="save_async"
c:identifier="gtk_source_file_saver_save_async"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1354">Saves asynchronously the buffer into the file. See the #GAsyncResult
documentation to know how to use this function.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="112"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1356">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="io_priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1357">the I/O priority of the request. E.g. %G_PRIORITY_LOW,
%G_PRIORITY_DEFAULT or %G_PRIORITY_HIGH.</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1359">optional #GCancellable object, %NULL to ignore.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="progress_callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="notified"
closure="3"
destroy="4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1360">function to call back with
progress information, or %NULL if progress information is not needed.</doc>
<type name="Gio.FileProgressCallback"
c:type="GFileProgressCallback"/>
</parameter>
<parameter name="progress_callback_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1362">user data to pass to @progress_callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="progress_callback_notify"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1363">function to call on
@progress_callback_data when the @progress_callback is no longer needed, or
%NULL.</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="6">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1366">a #GAsyncReadyCallback to call when the request is
satisfied.</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1368">user data to pass to @callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="save_finish"
c:identifier="gtk_source_file_saver_save_finish"
version="3.14"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1443">Finishes a file saving started with gtk_source_file_saver_save_async().
If the file has been saved successfully, the following #GtkSourceFile
properties will be updated: the location, the encoding, the newline type and
the compression type.
Since the 3.20 version, gtk_text_buffer_set_modified() is called with %FALSE
if the file has been saved successfully.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="121"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1458">whether the file was saved successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1445">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1446">a #GAsyncResult.</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="set_compression_type"
c:identifier="gtk_source_file_saver_set_compression_type"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1277">Sets the compression type. By default the compression type is taken from the
#GtkSourceFile.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="102"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1279">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="compression_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1280">the new compression type.</doc>
<type name="CompressionType" c:type="GtkSourceCompressionType"/>
</parameter>
</parameters>
</method>
<method name="set_encoding"
c:identifier="gtk_source_file_saver_set_encoding"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1192">Sets the encoding. If @encoding is %NULL, the UTF-8 encoding will be set.
By default the encoding is taken from the #GtkSourceFile.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="92"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1194">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="encoding"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1195">the new encoding, or %NULL for UTF-8.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</parameter>
</parameters>
</method>
<method name="set_flags"
c:identifier="gtk_source_file_saver_set_flags"
version="3.14">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="107"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1319">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1320">the new flags.</doc>
<type name="FileSaverFlags" c:type="GtkSourceFileSaverFlags"/>
</parameter>
</parameters>
</method>
<method name="set_newline_type"
c:identifier="gtk_source_file_saver_set_newline_type"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1237">Sets the newline type. By default the newline type is taken from the
#GtkSourceFile.</doc>
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="97"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="saver" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1239">a #GtkSourceFileSaver.</doc>
<type name="FileSaver" c:type="GtkSourceFileSaver*"/>
</instance-parameter>
<parameter name="newline_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="1240">the new newline type.</doc>
<type name="NewlineType" c:type="GtkSourceNewlineType"/>
</parameter>
</parameters>
</method>
<property name="buffer"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="344">The #GtkSourceBuffer to save. The #GtkSourceFileSaver object has a
weak reference to the buffer.</doc>
<type name="Buffer"/>
</property>
<property name="compression-type"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="428">The compression type.</doc>
<type name="CompressionType"/>
</property>
<property name="encoding"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="395">The file's encoding.</doc>
<type name="Encoding"/>
</property>
<property name="file"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="361">The #GtkSourceFile. The #GtkSourceFileSaver object has a weak
reference to the file.</doc>
<type name="File"/>
</property>
<property name="flags"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="445">File saving flags.</doc>
<type name="FileSaverFlags"/>
</property>
<property name="location"
version="3.14"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="378">The #GFile where to save the buffer. By default the location is taken
from the #GtkSourceFile at construction time.</doc>
<type name="Gio.File"/>
</property>
<property name="newline-type"
version="3.14"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="411">The newline type.</doc>
<type name="NewlineType"/>
</property>
</class>
<record name="FileSaverClass"
c:type="GtkSourceFileSaverClass"
glib:is-gtype-struct-for="FileSaver">
<source-position filename="../gtksourceview/gtksourcefilesaver.h"
line="74"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="FileSaverError"
version="3.14"
glib:type-name="GtkSourceFileSaverError"
glib:get-type="gtk_source_file_saver_error_get_type"
c:type="GtkSourceFileSaverError"
glib:error-domain="gtk-source-file-saver-error">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="39">An error code used with the %GTK_SOURCE_FILE_SAVER_ERROR domain.</doc>
<member name="invalid_chars"
value="0"
c:identifier="GTK_SOURCE_FILE_SAVER_ERROR_INVALID_CHARS"
glib:nick="invalid-chars">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="41">The buffer contains invalid
characters.</doc>
</member>
<member name="externally_modified"
value="1"
c:identifier="GTK_SOURCE_FILE_SAVER_ERROR_EXTERNALLY_MODIFIED"
glib:nick="externally-modified">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="43">The file is externally
modified.</doc>
</member>
<function name="quark" c:identifier="gtk_source_file_saver_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<bitfield name="FileSaverFlags"
version="3.14"
glib:type-name="GtkSourceFileSaverFlags"
glib:get-type="gtk_source_file_saver_flags_get_type"
c:type="GtkSourceFileSaverFlags">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="55">Flags to define the behavior of a #GtkSourceFileSaver.</doc>
<member name="none"
value="0"
c:identifier="GTK_SOURCE_FILE_SAVER_FLAGS_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="57">No flags.</doc>
</member>
<member name="ignore_invalid_chars"
value="1"
c:identifier="GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_INVALID_CHARS"
glib:nick="ignore-invalid-chars">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="58">Ignore invalid characters.</doc>
</member>
<member name="ignore_modification_time"
value="2"
c:identifier="GTK_SOURCE_FILE_SAVER_FLAGS_IGNORE_MODIFICATION_TIME"
glib:nick="ignore-modification-time">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="59">Save file despite external modifications.</doc>
</member>
<member name="create_backup"
value="4"
c:identifier="GTK_SOURCE_FILE_SAVER_FLAGS_CREATE_BACKUP"
glib:nick="create-backup">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.h"
line="60">Create a backup before saving the file.</doc>
</member>
</bitfield>
<class name="Gutter"
c:symbol-prefix="gutter"
c:type="GtkSourceGutter"
parent="Gtk.Widget"
glib:type-name="GtkSourceGutter"
glib:get-type="gtk_source_gutter_get_type"
glib:type-struct="GutterClass">
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="35"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<method name="get_view"
c:identifier="gtk_source_gutter_get_view"
version="3.24">
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="38"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="517">the associated #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="gutter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="515">a #GtkSourceGutter.</doc>
<type name="Gutter" c:type="GtkSourceGutter*"/>
</instance-parameter>
</parameters>
</method>
<method name="insert"
c:identifier="gtk_source_gutter_insert"
version="3.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="529">Insert @renderer into the gutter. If @renderer is yet unowned then gutter
claims its ownership. Otherwise just increases renderer's reference count.
@renderer cannot be already inserted to another gutter.</doc>
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="539">%TRUE if operation succeeded. Otherwise %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="gutter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="531">a #GtkSourceGutter.</doc>
<type name="Gutter" c:type="GtkSourceGutter*"/>
</instance-parameter>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="532">a gutter renderer (must inherit from #GtkSourceGutterRenderer).</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="533">the renderer position.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="remove" c:identifier="gtk_source_gutter_remove">
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="gutter" transfer-ownership="none">
<type name="Gutter" c:type="GtkSourceGutter*"/>
</instance-parameter>
<parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
</parameters>
</method>
<method name="reorder"
c:identifier="gtk_source_gutter_reorder"
version="2.8">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="633">Reorders @renderer in @gutter to new @position.</doc>
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="gutter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="635">a #GtkSourceGutterRenderer.</doc>
<type name="Gutter" c:type="GtkSourceGutter*"/>
</instance-parameter>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="636">a #GtkCellRenderer.</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="position" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="637">the new renderer position.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="view"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="399">The #GtkSourceView of the gutter.</doc>
<type name="View"/>
</property>
<property name="window-type"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="412">The text window type on which the window is placed.</doc>
<type name="Gtk.TextWindowType"/>
</property>
</class>
<record name="GutterClass"
c:type="GtkSourceGutterClass"
glib:is-gtype-struct-for="Gutter">
<source-position filename="../gtksourceview/gtksourcegutter.h"
line="35"/>
<field name="parent_class">
<type name="Gtk.WidgetClass" c:type="GtkWidgetClass"/>
</field>
</record>
<class name="GutterLines"
c:symbol-prefix="gutter_lines"
c:type="GtkSourceGutterLines"
parent="GObject.Object"
glib:type-name="GtkSourceGutterLines"
glib:get-type="gtk_source_gutter_lines_get_type"
glib:type-struct="GutterLinesClass">
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="36"/>
<method name="add_class"
c:identifier="gtk_source_gutter_lines_add_class"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="291">Adds the class @name to @line.
@name will be converted to a #GQuark as part of this process. A
faster version of this function is available via
gtk_source_gutter_lines_add_qclass() for situations where the #GQuark is
known ahead of time.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="293">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="294">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="295">a class name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="add_qclass"
c:identifier="gtk_source_gutter_lines_add_qclass"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="258">Adds the class denoted by @qname to @line.
You may check if a line has @qname by calling
gtk_source_gutter_lines_has_qclass().
You can remove @qname by calling
gtk_source_gutter_lines_remove_qclass().</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="56"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="260">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="261">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="qname" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="262">a class name as a #GQuark</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_gutter_lines_get_buffer"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="581">Gets the #GtkTextBuffer that the #GtkSourceGutterLines represents.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="587">a #GtkTextBuffer</doc>
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="583">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_first"
c:identifier="gtk_source_gutter_lines_get_first"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="501">Gets the line number (starting from 0) for the first line that is
user visible.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="39"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="508">a line number starting from 0</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="503">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_iter_at_line"
c:identifier="gtk_source_gutter_lines_get_iter_at_line"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="539">Gets a #GtkTextIter for the current buffer at @line</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="541">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="542">a location for a #GtkTextIter</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="543">the line number</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_last"
c:identifier="gtk_source_gutter_lines_get_last"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="520">Gets the line number (starting from 0) for the last line that is
user visible.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="41"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="527">a line number starting from 0</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="522">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_line_yrange"
c:identifier="gtk_source_gutter_lines_get_line_yrange"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="599">Gets the Y range for a line based on @mode.
The value for @y is relative to the renderers widget coordinates.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="89"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="601">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="602">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="603">a #GtkSourceGutterRendererAlignmentMode</doc>
<type name="GutterRendererAlignmentMode"
c:type="GtkSourceGutterRendererAlignmentMode"/>
</parameter>
<parameter name="y"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="604">a location for the Y position in widget coordinates</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="605">the line height based on @mode</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_view"
c:identifier="gtk_source_gutter_lines_get_view"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="563">Gets the #GtkTextView that the #GtkSourceGutterLines represents.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="569">a #GtkTextView</doc>
<type name="Gtk.TextView" c:type="GtkTextView*"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="565">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_yrange"
c:identifier="gtk_source_gutter_lines_get_yrange">
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="line_y" transfer-ownership="none">
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="line_height" transfer-ownership="none">
<type name="guint" c:type="guint*"/>
</parameter>
</parameters>
</method>
<method name="has_class"
c:identifier="gtk_source_gutter_lines_has_class"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="377">Checks to see if gtk_source_gutter_lines_add_class() was called with
the @name for @line.
A faster version of this function is provided via
gtk_source_gutter_lines_has_qclass() for situations where the quark
is known ahead of time.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="72"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="390">%TRUE if @line contains @name</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="379">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="380">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="381">a class name that may be converted, to a #GQuark</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="has_qclass"
c:identifier="gtk_source_gutter_lines_has_qclass"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="413">Checks to see if gtk_source_gutter_lines_add_qclass() was called with
the quark denoted by @qname for @line.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="76"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="422">%TRUE if @line contains @qname</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="415">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="416">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="qname" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="417">a #GQuark containing the class name</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
</parameters>
</method>
<method name="is_cursor"
c:identifier="gtk_source_gutter_lines_is_cursor"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="444">Checks to see if @line contains the insertion cursor.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="80"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="451">%TRUE if the insertion cursor is on @line</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="446">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="447">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="is_prelit"
c:identifier="gtk_source_gutter_lines_is_prelit"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="463">Checks to see if @line is marked as prelit. Generally, this means
the mouse pointer is over the line within the gutter.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="471">%TRUE if the line is prelit</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="465">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="466">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="is_selected"
c:identifier="gtk_source_gutter_lines_is_selected"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="482">Checks to see if the view had a selection and if that selection overlaps
@line in some way.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="86"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="490">%TRUE if the line contains a selection</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="484">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="485">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="remove_class"
c:identifier="gtk_source_gutter_lines_remove_class"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="318">Removes the class matching @name from @line.
A faster version of this function is available via
gtk_source_gutter_lines_remove_qclass() for situations where the
#GQuark is known ahead of time.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="64"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="320">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="321">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="322">a class name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="remove_qclass"
c:identifier="gtk_source_gutter_lines_remove_qclass"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="349">Reverses a call to gtk_source_gutter_lines_add_qclass() by removing
the #GQuark matching @qname.</doc>
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="351">a #GtkSourceGutterLines</doc>
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="352">a line number starting from zero</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="qname" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="353">a #GQuark to remove from @line</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
</parameters>
</method>
</class>
<record name="GutterLinesClass"
c:type="GtkSourceGutterLinesClass"
glib:is-gtype-struct-for="GutterLines">
<source-position filename="../gtksourceview/gtksourcegutterlines.h"
line="36"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="GutterRenderer"
c:symbol-prefix="gutter_renderer"
c:type="GtkSourceGutterRenderer"
parent="Gtk.Widget"
abstract="1"
glib:type-name="GtkSourceGutterRenderer"
glib:get-type="gtk_source_gutter_renderer_get_type"
glib:type-struct="GutterRendererClass">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="95"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<virtual-method name="activate" invoker="activate">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="589">Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is
called from #GtkSourceGutter and should never have to be called manually.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="86"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="591">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="592">a #GtkTextIter at the start of the line where the renderer is activated</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="593">a #GdkRectangle of the cell area where the renderer is activated</doc>
<type name="Gdk.Rectangle" c:type="GdkRectangle*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="594">the button that was pressed</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="595">a #GdkModifierType</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="596">the number of button presses</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="begin">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="57"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="change_buffer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="73">This is called when the text buffer changes for @renderer.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="80"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="75">a #GtkSourceGutterRenderer.</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="old_buffer"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="76">the old #GtkTextBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="change_view">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="64">This is called when the text view changes for @renderer.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="71"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="66">a #GtkSourceGutterRenderer.</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="old_view"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="67">the old #GtkTextView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="end">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="query_activatable" invoker="query_activatable">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="553">Get whether the renderer is activatable at the location provided. This is
called from #GtkSourceGutter to determine whether a renderer is activatable
using the mouse pointer.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="563">%TRUE if the renderer can be activated, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="555">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="556">a #GtkTextIter at the start of the line to be activated</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="557">a #GdkRectangle of the cell area to be activated</doc>
<type name="Gdk.Rectangle" c:type="GdkRectangle*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="query_data">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="54"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="snapshot_line">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="snapshot" transfer-ownership="none">
<type name="Gtk.Snapshot" c:type="GtkSnapshot*"/>
</parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<method name="activate"
c:identifier="gtk_source_gutter_renderer_activate">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="589">Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is
called from #GtkSourceGutter and should never have to be called manually.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="130"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="591">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="592">a #GtkTextIter at the start of the line where the renderer is activated</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="593">a #GdkRectangle of the cell area where the renderer is activated</doc>
<type name="Gdk.Rectangle" c:type="const GdkRectangle*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="594">the button that was pressed</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="595">a #GdkModifierType</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="596">the number of button presses</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="align_cell"
c:identifier="gtk_source_gutter_renderer_align_cell"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="748">Locates where to render content that is @width x @height based on
the renderers alignment and padding.
The location will be placed into @x and @y and is relative to the
renderer's coordinates.
It is encouraged that renderers use this function when snappshotting
to ensure consistent placement of their contents.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="141"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="750">the #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="line" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="751">the line number for content</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="752">the width of the content to draw</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
<parameter name="height" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="753">the height of the content to draw</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
<parameter name="x"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="754">the X position to render the content</doc>
<type name="gfloat" c:type="gfloat*"/>
</parameter>
<parameter name="y"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="755">the Y position to render the content</doc>
<type name="gfloat" c:type="gfloat*"/>
</parameter>
</parameters>
</method>
<method name="get_alignment_mode"
c:identifier="gtk_source_gutter_renderer_get_alignment_mode">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="645">Get the alignment mode. The alignment mode describes the manner in which the
renderer is aligned (see :xalign and :yalign).</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="121"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="652">a #GtkSourceGutterRendererAlignmentMode</doc>
<type name="GutterRendererAlignmentMode"
c:type="GtkSourceGutterRendererAlignmentMode"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="647">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_gutter_renderer_get_buffer"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="975">Gets the #GtkSourceBuffer for which the gutter renderer is drawing.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="126"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="981">a #GtkTextBuffer or %NULL</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="977">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_view"
c:identifier="gtk_source_gutter_renderer_get_view">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="664">Get the view associated to the gutter renderer</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="128"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="670">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="666">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_xalign"
c:identifier="gtk_source_gutter_renderer_get_xalign"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="881">Gets the "xalign" property of the #GtkSourceGutterRenderer. This may be used
to adjust where within the cell rectangle the renderer will draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="101"/>
<return-value transfer-ownership="none">
<type name="gfloat" c:type="gfloat"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="883">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_xpad"
c:identifier="gtk_source_gutter_renderer_get_xpad"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="787">Gets the "xpad" property of the #GtkSourceGutterRenderer. This may be used
to adjust the cell rectangle that the renderer will use to draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="111"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="789">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_yalign"
c:identifier="gtk_source_gutter_renderer_get_yalign"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="928">Gets the "yalign" property of the #GtkSourceGutterRenderer. This may be used
to adjust where within the cell rectangle the renderer will draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="106"/>
<return-value transfer-ownership="none">
<type name="gfloat" c:type="gfloat"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="930">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_ypad"
c:identifier="gtk_source_gutter_renderer_get_ypad"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="834">Gets the "ypad" property of the #GtkSourceGutterRenderer. This may be used
to adjust the cell rectangle that the renderer will use to draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="116"/>
<return-value transfer-ownership="none">
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="836">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
</parameters>
</method>
<method name="query_activatable"
c:identifier="gtk_source_gutter_renderer_query_activatable">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="553">Get whether the renderer is activatable at the location provided. This is
called from #GtkSourceGutter to determine whether a renderer is activatable
using the mouse pointer.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="137"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="563">%TRUE if the renderer can be activated, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="555">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="556">a #GtkTextIter at the start of the line to be activated</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="557">a #GdkRectangle of the cell area to be activated</doc>
<type name="Gdk.Rectangle" c:type="const GdkRectangle*"/>
</parameter>
</parameters>
</method>
<method name="set_alignment_mode"
c:identifier="gtk_source_gutter_renderer_set_alignment_mode">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="616">Set the alignment mode. The alignment mode describes the manner in which the
renderer is aligned (see #GtkSourceGutterRenderer:xalign and
#GtkSourceGutterRenderer:yalign).</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="123"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="618">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="mode" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="619">a #GtkSourceGutterRendererAlignmentMode</doc>
<type name="GutterRendererAlignmentMode"
c:type="GtkSourceGutterRendererAlignmentMode"/>
</parameter>
</parameters>
</method>
<method name="set_xalign"
c:identifier="gtk_source_gutter_renderer_set_xalign"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="900">Adjusts the "xalign" property of the #GtkSourceGutterRenderer. This may be
used to adjust where within the cell rectangle the renderer will draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="103"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="902">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="xalign" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="903">the Y padding for the drawing cell</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
</parameters>
</method>
<method name="set_xpad"
c:identifier="gtk_source_gutter_renderer_set_xpad"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="806">Adjusts the "xpad" property of the #GtkSourceGutterRenderer. This may be
used to adjust the cell rectangle that the renderer will use to draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="113"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="808">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="xpad" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="809">the Y padding for the drawing cell</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_yalign"
c:identifier="gtk_source_gutter_renderer_set_yalign"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="947">Adjusts the "yalign" property of the #GtkSourceGutterRenderer. This may be
used to adjust where within the cell rectangle the renderer will draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="108"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="949">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="yalign" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="950">the Y padding for the drawing cell</doc>
<type name="gfloat" c:type="gfloat"/>
</parameter>
</parameters>
</method>
<method name="set_ypad"
c:identifier="gtk_source_gutter_renderer_set_ypad"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="853">Adjusts the "ypad" property of the #GtkSourceGutterRenderer. This may be
used to adjust the cell rectangle that the renderer will use to draw.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="118"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="855">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</instance-parameter>
<parameter name="ypad" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="856">the Y padding for the drawing cell</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="alignment-mode" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="456">The alignment mode of the renderer. This can be used to indicate
that in the case a cell spans multiple lines (due to text wrapping)
the alignment should work on either the full cell, the first line
or the last line.</doc>
<type name="GutterRendererAlignmentMode"/>
</property>
<property name="lines" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="369">The "lines" property contains information about the lines to be
rendered. It should be used by #GtkSourceGutterRenderer
implementations from gtk_widget_snapshot().</doc>
<type name="GutterLines"/>
</property>
<property name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="444">The view on which the renderer is placed.</doc>
<type name="Gtk.TextView"/>
</property>
<property name="xalign" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="411">The horizontal alignment of the renderer. Set to 0 for a left
alignment. 1 for a right alignment. And 0.5 for centering the cells.
A value lower than 0 doesn't modify the alignment.</doc>
<type name="gfloat" c:type="gfloat"/>
</property>
<property name="xpad" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="383">The left and right padding of the renderer.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="yalign" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="427">The vertical alignment of the renderer. Set to 0 for a top
alignment. 1 for a bottom alignment. And 0.5 for centering the cells.
A value lower than 0 doesn't modify the alignment.</doc>
<type name="gfloat" c:type="gfloat"/>
</property>
<property name="ypad" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="397">The top and bottom padding of the renderer.</doc>
<type name="gint" c:type="gint"/>
</property>
<field name="parent_instance">
<type name="Gtk.Widget" c:type="GtkWidget"/>
</field>
<glib:signal name="activate" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="475">The ::activate signal is emitted when the renderer is activated.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="478">a #GtkTextIter</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="479">a #GdkRectangle</doc>
<type name="Gdk.Rectangle"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="480">the button that was pressed</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="481">a #GdkModifierType of state</doc>
<type name="Gdk.ModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="482">the number of button presses</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="query-activatable" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="504">The ::query-activatable signal is emitted when the renderer
can possibly be activated.</doc>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="507">a #GtkTextIter</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="508">a #GdkRectangle</doc>
<type name="Gdk.Rectangle"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="query-data" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="GObject.Object"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<enumeration name="GutterRendererAlignmentMode"
glib:type-name="GtkSourceGutterRendererAlignmentMode"
glib:get-type="gtk_source_gutter_renderer_alignment_mode_get_type"
c:type="GtkSourceGutterRendererAlignmentMode">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="34">The alignment mode of the renderer, when a cell spans multiple lines (due to
text wrapping).</doc>
<member name="cell"
value="0"
c:identifier="GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_CELL"
glib:nick="cell">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="36">The full cell.</doc>
</member>
<member name="first"
value="1"
c:identifier="GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_FIRST"
glib:nick="first">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="37">The first line.</doc>
</member>
<member name="last"
value="2"
c:identifier="GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_LAST"
glib:nick="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="38">The last line.</doc>
</member>
</enumeration>
<record name="GutterRendererClass"
c:type="GtkSourceGutterRendererClass"
glib:is-gtype-struct-for="GutterRenderer">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="95"/>
<field name="parent_class">
<type name="Gtk.WidgetClass" c:type="GtkWidgetClass"/>
</field>
<field name="query_data">
<callback name="query_data">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="54"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="begin">
<callback name="begin">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="57"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="snapshot_line">
<callback name="snapshot_line">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="snapshot" transfer-ownership="none">
<type name="Gtk.Snapshot" c:type="GtkSnapshot*"/>
</parameter>
<parameter name="lines" transfer-ownership="none">
<type name="GutterLines" c:type="GtkSourceGutterLines*"/>
</parameter>
<parameter name="line" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="end">
<callback name="end">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="change_view">
<callback name="change_view">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="71"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="66">a #GtkSourceGutterRenderer.</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="old_view"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="67">the old #GtkTextView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="change_buffer">
<callback name="change_buffer">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="80"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="75">a #GtkSourceGutterRenderer.</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="old_buffer"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.h"
line="76">the old #GtkTextBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="query_activatable">
<callback name="query_activatable">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="83"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="563">%TRUE if the renderer can be activated, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="555">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="556">a #GtkTextIter at the start of the line to be activated</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="557">a #GdkRectangle of the cell area to be activated</doc>
<type name="Gdk.Rectangle" c:type="GdkRectangle*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="activate">
<callback name="activate">
<source-position filename="../gtksourceview/gtksourcegutterrenderer.h"
line="86"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="591">a #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="592">a #GtkTextIter at the start of the line where the renderer is activated</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="area" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="593">a #GdkRectangle of the cell area where the renderer is activated</doc>
<type name="Gdk.Rectangle" c:type="GdkRectangle*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="594">the button that was pressed</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="595">a #GdkModifierType</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="596">the number of button presses</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="GutterRendererPixbuf"
c:symbol-prefix="gutter_renderer_pixbuf"
c:type="GtkSourceGutterRendererPixbuf"
parent="GutterRenderer"
glib:type-name="GtkSourceGutterRendererPixbuf"
glib:get-type="gtk_source_gutter_renderer_pixbuf_get_type"
glib:type-struct="GutterRendererPixbufClass">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="42"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<constructor name="new"
c:identifier="gtk_source_gutter_renderer_pixbuf_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="286">Create a new #GtkSourceGutterRendererPixbuf.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="45"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="291">A #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</return-value>
</constructor>
<method name="get_gicon"
c:identifier="gtk_source_gutter_renderer_pixbuf_get_gicon">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="350">Get the gicon of the renderer</doc>
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="55"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="356">a #GIcon</doc>
<type name="Gio.Icon" c:type="GIcon*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="352">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icon_name"
c:identifier="gtk_source_gutter_renderer_pixbuf_get_icon_name">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="60"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_paintable"
c:identifier="gtk_source_gutter_renderer_pixbuf_get_paintable"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="412">Gets a #GdkPaintable that was set with
gtk_source_gutter_renderer_pixbuf_set_paintable()</doc>
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="62"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="419">a #GdkPaintable or %NULL</doc>
<type name="Gdk.Paintable" c:type="GdkPaintable*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="414">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixbuf"
c:identifier="gtk_source_gutter_renderer_pixbuf_get_pixbuf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="316">Get the pixbuf of the renderer.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="50"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="322">a #GdkPixbuf</doc>
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="318">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
</parameters>
</method>
<method name="overlay_paintable"
c:identifier="gtk_source_gutter_renderer_pixbuf_overlay_paintable"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="433">Allows overlaying a paintable on top of any other image that
has been set for the pixbuf. This will be applied when the
widget is next snapshot.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="67"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="435">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
<parameter name="paintable" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="436">a #GdkPaintable</doc>
<type name="Gdk.Paintable" c:type="GdkPaintable*"/>
</parameter>
</parameters>
</method>
<method name="set_gicon"
c:identifier="gtk_source_gutter_renderer_pixbuf_set_gicon">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="337">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
<parameter name="icon"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="338">the icon, or %NULL.</doc>
<type name="Gio.Icon" c:type="GIcon*"/>
</parameter>
</parameters>
</method>
<method name="set_icon_name"
c:identifier="gtk_source_gutter_renderer_pixbuf_set_icon_name">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="57"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="371">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
<parameter name="icon_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="372">the icon name, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_paintable"
c:identifier="gtk_source_gutter_renderer_pixbuf_set_paintable">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="64"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="395">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
<parameter name="paintable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="396">the paintable, or %NULL.</doc>
<type name="Gdk.Paintable" c:type="GdkPaintable*"/>
</parameter>
</parameters>
</method>
<method name="set_pixbuf"
c:identifier="gtk_source_gutter_renderer_pixbuf_set_pixbuf">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="302">a #GtkSourceGutterRendererPixbuf</doc>
<type name="GutterRendererPixbuf"
c:type="GtkSourceGutterRendererPixbuf*"/>
</instance-parameter>
<parameter name="pixbuf"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="303">the pixbuf, or %NULL.</doc>
<type name="GdkPixbuf.Pixbuf" c:type="GdkPixbuf*"/>
</parameter>
</parameters>
</method>
<property name="gicon" writable="1" transfer-ownership="none">
<type name="Gio.Icon"/>
</property>
<property name="icon-name" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="paintable" writable="1" transfer-ownership="none">
<type name="Gdk.Paintable"/>
</property>
<property name="pixbuf" writable="1" transfer-ownership="none">
<type name="GdkPixbuf.Pixbuf"/>
</property>
<field name="parent_instance">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer"/>
</field>
</class>
<record name="GutterRendererPixbufClass"
c:type="GtkSourceGutterRendererPixbufClass"
glib:is-gtype-struct-for="GutterRendererPixbuf">
<source-position filename="../gtksourceview/gtksourcegutterrendererpixbuf.h"
line="42"/>
<field name="parent_class">
<type name="GutterRendererClass"
c:type="GtkSourceGutterRendererClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="GutterRendererText"
c:symbol-prefix="gutter_renderer_text"
c:type="GtkSourceGutterRendererText"
parent="GutterRenderer"
glib:type-name="GtkSourceGutterRendererText"
glib:get-type="gtk_source_gutter_renderer_text_get_type"
glib:type-struct="GutterRendererTextClass">
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="39"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<constructor name="new"
c:identifier="gtk_source_gutter_renderer_text_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="437">Create a new #GtkSourceGutterRendererText.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="45"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="442">A #GtkSourceGutterRenderer</doc>
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer*"/>
</return-value>
</constructor>
<method name="measure"
c:identifier="gtk_source_gutter_renderer_text_measure">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="224">Measures the text provided using the pango layout used by the
#GtkSourceGutterRendererText.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="55"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="226">a #GtkSourceGutterRendererText.</doc>
<type name="GutterRendererText"
c:type="GtkSourceGutterRendererText*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="227">the text to measure.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="228">location to store the width of the text in pixels,
or %NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="230">location to store the height of the text in
pixels, or %NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="measure_markup"
c:identifier="gtk_source_gutter_renderer_text_measure_markup">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="248">Measures the pango markup provided using the pango layout used by the
#GtkSourceGutterRendererText.</doc>
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="250">a #GtkSourceGutterRendererText.</doc>
<type name="GutterRendererText"
c:type="GtkSourceGutterRendererText*"/>
</instance-parameter>
<parameter name="markup" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="251">the pango markup to measure.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="width"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="252">location to store the width of the text in pixels,
or %NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
<parameter name="height"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="254">location to store the height of the text in
pixels, or %NULL.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="set_markup"
c:identifier="gtk_source_gutter_renderer_text_set_markup">
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRendererText"
c:type="GtkSourceGutterRendererText*"/>
</instance-parameter>
<parameter name="markup" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_text"
c:identifier="gtk_source_gutter_renderer_text_set_text">
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="51"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="renderer" transfer-ownership="none">
<type name="GutterRendererText"
c:type="GtkSourceGutterRendererText*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="markup"
writable="1"
construct="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="text"
writable="1"
construct="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="GutterRenderer" c:type="GtkSourceGutterRenderer"/>
</field>
</class>
<record name="GutterRendererTextClass"
c:type="GtkSourceGutterRendererTextClass"
glib:is-gtype-struct-for="GutterRendererText">
<source-position filename="../gtksourceview/gtksourcegutterrenderertext.h"
line="39"/>
<field name="parent_class">
<type name="GutterRendererClass"
c:type="GtkSourceGutterRendererClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="Hover"
c:symbol-prefix="hover"
c:type="GtkSourceHover"
parent="GObject.Object"
glib:type-name="GtkSourceHover"
glib:get-type="gtk_source_hover_get_type"
glib:type-struct="HoverClass">
<source-position filename="../gtksourceview/gtksourcehover.h" line="37"/>
<method name="add_provider" c:identifier="gtk_source_hover_add_provider">
<source-position filename="../gtksourceview/gtksourcehover.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Hover" c:type="GtkSourceHover*"/>
</instance-parameter>
<parameter name="provider" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</parameter>
</parameters>
</method>
<method name="remove_provider"
c:identifier="gtk_source_hover_remove_provider">
<source-position filename="../gtksourceview/gtksourcehover.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="Hover" c:type="GtkSourceHover*"/>
</instance-parameter>
<parameter name="provider" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</parameter>
</parameters>
</method>
<property name="hover-delay" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehover.c"
line="312">The "hover-delay" property contains the number of milliseconds to
delay before showing the hover assistant.</doc>
<type name="guint" c:type="guint"/>
</property>
</class>
<record name="HoverClass"
c:type="GtkSourceHoverClass"
glib:is-gtype-struct-for="Hover">
<source-position filename="../gtksourceview/gtksourcehover.h" line="37"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="HoverContext"
c:symbol-prefix="hover_context"
c:type="GtkSourceHoverContext"
parent="GObject.Object"
glib:type-name="GtkSourceHoverContext"
glib:get-type="gtk_source_hover_context_get_type"
glib:type-struct="HoverContextClass">
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="37"/>
<method name="get_bounds"
c:identifier="gtk_source_hover_context_get_bounds">
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</instance-parameter>
<parameter name="begin" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_hover_context_get_buffer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="159">A convenience function to get the buffer.</doc>
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="165">The #GtkSourceBuffer for the view</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="161">a #GtkSourceHoverContext</doc>
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_iter" c:identifier="gtk_source_hover_context_get_iter">
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_view" c:identifier="gtk_source_hover_context_get_view">
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="149">the #GtkSourceView that owns the context</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="147">a #GtkSourceHoverContext</doc>
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</instance-parameter>
</parameters>
</method>
</class>
<record name="HoverContextClass"
c:type="GtkSourceHoverContextClass"
glib:is-gtype-struct-for="HoverContext">
<source-position filename="../gtksourceview/gtksourcehovercontext.h"
line="37"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="HoverDisplay"
c:symbol-prefix="hover_display"
c:type="GtkSourceHoverDisplay"
parent="Gtk.Widget"
glib:type-name="GtkSourceHoverDisplay"
glib:get-type="gtk_source_hover_display_get_type"
glib:type-struct="HoverDisplayClass">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="37"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<method name="append" c:identifier="gtk_source_hover_display_append">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</instance-parameter>
<parameter name="child" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
</parameters>
</method>
<method name="insert_after"
c:identifier="gtk_source_hover_display_insert_after">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</instance-parameter>
<parameter name="child" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
<parameter name="sibling" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
</parameters>
</method>
<method name="prepend" c:identifier="gtk_source_hover_display_prepend">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</instance-parameter>
<parameter name="child" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
</parameters>
</method>
<method name="remove" c:identifier="gtk_source_hover_display_remove">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</instance-parameter>
<parameter name="child" transfer-ownership="none">
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
</parameters>
</method>
</class>
<record name="HoverDisplayClass"
c:type="GtkSourceHoverDisplayClass"
glib:is-gtype-struct-for="HoverDisplay">
<source-position filename="../gtksourceview/gtksourcehoverdisplay.h"
line="37"/>
<field name="parent_class">
<type name="Gtk.WidgetClass" c:type="GtkWidgetClass"/>
</field>
</record>
<interface name="HoverProvider"
c:symbol-prefix="hover_provider"
c:type="GtkSourceHoverProvider"
glib:type-name="GtkSourceHoverProvider"
glib:get-type="gtk_source_hover_provider_get_type"
glib:type-struct="HoverProviderInterface">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="56"/>
<virtual-method name="populate" throws="1">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="populate_async" invoker="populate_async">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="4">
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="4">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="populate_finish"
invoker="populate_finish"
throws="1">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</virtual-method>
<method name="populate_async"
c:identifier="gtk_source_hover_provider_populate_async">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="4">
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="populate_finish"
c:identifier="gtk_source_hover_provider_populate_finish"
throws="1">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="66"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
</interface>
<record name="HoverProviderInterface"
c:type="GtkSourceHoverProviderInterface"
glib:is-gtype-struct-for="HoverProvider">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="56"/>
<field name="parent_iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="populate">
<callback name="populate" throws="1">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="populate_async">
<callback name="populate_async">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</parameter>
<parameter name="context" transfer-ownership="none">
<type name="HoverContext" c:type="GtkSourceHoverContext*"/>
</parameter>
<parameter name="display" transfer-ownership="none">
<type name="HoverDisplay" c:type="GtkSourceHoverDisplay*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="5">
<type name="Gio.AsyncReadyCallback"
c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="5">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="populate_finish">
<callback name="populate_finish" throws="1">
<source-position filename="../gtksourceview/gtksourcehoverprovider.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="HoverProvider" c:type="GtkSourceHoverProvider*"/>
</parameter>
<parameter name="result" transfer-ownership="none">
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<interface name="Indenter"
c:symbol-prefix="indenter"
c:type="GtkSourceIndenter"
glib:type-name="GtkSourceIndenter"
glib:get-type="gtk_source_indenter_get_type"
glib:type-struct="IndenterInterface">
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="51"/>
<virtual-method name="indent" invoker="indent" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="206">This function should be implemented to alter the indentation of text
within the view. @view is provided so that the indenter may retrieve
settings such as indentation and tab widths.
@iter is the location where the indentation was requested. This typically
is after having just inserted a newline (\n) character but can be other
situations such as a manually requested indentation or reformatting.
See gtk_source_indenter_is_trigger() for how to trigger indentation on
various characters inserted into the buffer.
The implementor of this function is expected to keep @iter valid across
calls to the function and should contain the location of the insert mark
after calling this function.
The default implementation for this virtual function will copy the
indentation of the previous line.</doc>
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="208">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</instance-parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="209">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="210">the location of the indentation request</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="is_trigger" invoker="is_trigger" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="170">This function is used to determine if a key pressed should cause the
indenter to automatically indent.
The default implementation of this virtual method will check to see
if @keyval is %GDK_KEY_Return or %GDK_KEY_KP_Enter and @state does
not have %GDK_SHIFT_MASK set. This is to allow the user to avoid
indentation when Shift+Return is pressed. Other indenters may want
to copy this behavior to provide a consistent experience to users.</doc>
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="43"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="187">%TRUE if indentation should be automatically triggered;
otherwise %FALSE and no indentation will be performed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="172">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</instance-parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="173">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="location" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="174">the location where @ch is to be inserted</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="175">modifier state for the insertion</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="176">the keyval pressed such as %GDK_KEY_Return</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<method name="indent"
c:identifier="gtk_source_indenter_indent"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="206">This function should be implemented to alter the indentation of text
within the view. @view is provided so that the indenter may retrieve
settings such as indentation and tab widths.
@iter is the location where the indentation was requested. This typically
is after having just inserted a newline (\n) character but can be other
situations such as a manually requested indentation or reformatting.
See gtk_source_indenter_is_trigger() for how to trigger indentation on
various characters inserted into the buffer.
The implementor of this function is expected to keep @iter valid across
calls to the function and should contain the location of the insert mark
after calling this function.
The default implementation for this virtual function will copy the
indentation of the previous line.</doc>
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="208">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</instance-parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="209">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="210">the location of the indentation request</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="is_trigger"
c:identifier="gtk_source_indenter_is_trigger"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="170">This function is used to determine if a key pressed should cause the
indenter to automatically indent.
The default implementation of this virtual method will check to see
if @keyval is %GDK_KEY_Return or %GDK_KEY_KP_Enter and @state does
not have %GDK_SHIFT_MASK set. This is to allow the user to avoid
indentation when Shift+Return is pressed. Other indenters may want
to copy this behavior to provide a consistent experience to users.</doc>
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="54"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="187">%TRUE if indentation should be automatically triggered;
otherwise %FALSE and no indentation will be performed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="172">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</instance-parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="173">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="location" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="174">the location where @ch is to be inserted</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="175">modifier state for the insertion</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="176">the keyval pressed such as %GDK_KEY_Return</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
</interface>
<record name="IndenterInterface"
c:type="GtkSourceIndenterInterface"
glib:is-gtype-struct-for="Indenter"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="64">The virtual function table for #GtkSourceIndenter.</doc>
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="51"/>
<field name="parent_iface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="is_trigger">
<callback name="is_trigger">
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="43"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="187">%TRUE if indentation should be automatically triggered;
otherwise %FALSE and no indentation will be performed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="172">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="173">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="location" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="174">the location where @ch is to be inserted</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="175">modifier state for the insertion</doc>
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="keyval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="176">the keyval pressed such as %GDK_KEY_Return</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="indent">
<callback name="indent">
<source-position filename="../gtksourceview/gtksourceindenter.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="208">a #GtkSourceIndenter</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="209">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="210">the location of the indentation request</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="Language"
c:symbol-prefix="language"
c:type="GtkSourceLanguage"
parent="GObject.Object"
glib:type-name="GtkSourceLanguage"
glib:get-type="gtk_source_language_get_type"
glib:type-struct="LanguageClass">
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="35"/>
<method name="get_globs" c:identifier="gtk_source_language_get_globs">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="629">Returns the globs associated to this language. This is just
an utility wrapper around gtk_source_language_get_metadata() to
retrieve the "globs" metadata property and split it into an array.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="51"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="637">
a newly-allocated %NULL terminated array containing the globs or %NULL
if no globs are found.
The returned array must be freed with g_strfreev().</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="631">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hidden" c:identifier="gtk_source_language_get_hidden">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="564">Returns whether the language should be hidden from the user.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="44"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="570">%TRUE if the language should be hidden, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="566">a #GtkSourceLanguage</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_id" c:identifier="gtk_source_language_get_id">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="505">Returns the ID of the language. The ID is not locale-dependent.
The returned string is owned by @language and should not be freed
or modified.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="38"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="513">the ID of @language.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="507">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_metadata"
c:identifier="gtk_source_language_get_metadata">
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="46"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="585">value of property @name stored in
the metadata of @language or %NULL if language does not contain the
specified metadata property.
The returned string is owned by @language and should not be freed
or modified.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="582">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="583">metadata property name.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_mime_types"
c:identifier="gtk_source_language_get_mime_types">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="601">Returns the mime types associated to this language. This is just
an utility wrapper around gtk_source_language_get_metadata() to
retrieve the "mimetypes" metadata property and split it into an
array.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="49"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="610">
a newly-allocated %NULL terminated array containing the mime types
or %NULL if no mime types are found.
The returned array must be freed with g_strfreev().</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="603">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="gtk_source_language_get_name">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="524">Returns the localized name of the language.
The returned string is owned by @language and should not be freed
or modified.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="532">the name of @language.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="526">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_section"
c:identifier="gtk_source_language_get_section">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="543">Returns the localized section of the language.
Each language belong to a section (ex. HTML belongs to the
Markup section).
The returned string is owned by @language and should not be freed
or modified.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="553">the section of @language.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="545">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_style_fallback"
c:identifier="gtk_source_language_get_style_fallback"
version="3.4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="935">Returns the ID of the style to use if the specified @style_id
is not present in the current style scheme.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="58"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="943">the ID of the style to use if the
specified @style_id is not present in the current style scheme or %NULL
if the style has no fallback defined.
The returned string is owned by the @language and must not be modified.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="937">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
<parameter name="style_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="938">a style ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_style_ids"
c:identifier="gtk_source_language_get_style_ids">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="869">Returns the ids of the styles defined by this @language.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="53"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="875">
a newly-allocated %NULL terminated array containing ids of the
styles defined by this @language or %NULL if no style is defined.
The returned array must be freed with g_strfreev().</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="871">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_style_name"
c:identifier="gtk_source_language_get_style_name">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="908">Returns the name of the style with ID @style_id defined by this @language.</doc>
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="55"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="915">the name of the style with ID @style_id
defined by this @language or %NULL if the style has no name or there is no
style with ID @style_id defined by this @language.
The returned string is owned by the @language and must not be modified.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="language" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="910">a #GtkSourceLanguage.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</instance-parameter>
<parameter name="style_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="911">a style ID.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="hidden" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="id" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="name" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="section" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
</class>
<record name="LanguageClass"
c:type="GtkSourceLanguageClass"
glib:is-gtype-struct-for="Language">
<source-position filename="../gtksourceview/gtksourcelanguage.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="LanguageManager"
c:symbol-prefix="language_manager"
c:type="GtkSourceLanguageManager"
parent="GObject.Object"
glib:type-name="GtkSourceLanguageManager"
glib:get-type="gtk_source_language_manager_get_type"
glib:type-struct="LanguageManagerClass">
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="35"/>
<constructor name="new" c:identifier="gtk_source_language_manager_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="180">Creates a new language manager. If you do not need more than one language
manager or a private language manager instance then use
gtk_source_language_manager_get_default() instead.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="187">a new #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</return-value>
</constructor>
<function name="get_default"
c:identifier="gtk_source_language_manager_get_default">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="195">Returns the default #GtkSourceLanguageManager instance.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="200">a #GtkSourceLanguageManager.
Return value is owned by GtkSourceView library and must not be unref'ed.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</return-value>
</function>
<method name="get_language"
c:identifier="gtk_source_language_manager_get_language">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="437">Gets the #GtkSourceLanguage identified by the given @id in the language
manager.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="49"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="445">a #GtkSourceLanguage, or %NULL
if there is no language identified by the given @id. Return value is
owned by @lm and should not be freed.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</return-value>
<parameters>
<instance-parameter name="lm" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="439">a #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</instance-parameter>
<parameter name="id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="440">a language id.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_language_ids"
c:identifier="gtk_source_language_manager_get_language_ids">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="415">Returns the ids of the available languages.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="47"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="421">
a %NULL-terminated array of strings containing the ids of the available
languages or %NULL if no language is available.
The array is sorted alphabetically according to the language name.
The array is owned by @lm and must not be modified.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="lm" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="417">a #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_search_path"
c:identifier="gtk_source_language_manager_get_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="272">Gets the list directories where @lm looks for language files.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="278">%NULL-terminated array
containing a list of language files directories.
The array is owned by @lm and must not be modified.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="lm" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="274">a #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="guess_language"
c:identifier="gtk_source_language_manager_guess_language"
version="2.4">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="606">Picks a #GtkSourceLanguage for given file name and content type,
according to the information in lang files. Either @filename or
@content_type may be %NULL. This function can be used as follows:
&lt;informalexample&gt;&lt;programlisting&gt;
GtkSourceLanguage *lang;
lang = gtk_source_language_manager_guess_language (filename, NULL);
gtk_source_buffer_set_language (buffer, lang);
&lt;/programlisting&gt;&lt;/informalexample&gt;
or
&lt;informalexample&gt;&lt;programlisting&gt;
GtkSourceLanguage *lang = NULL;
gboolean result_uncertain;
gchar *content_type;
content_type = g_content_type_guess (filename, NULL, 0, &amp;result_uncertain);
if (result_uncertain)
{
g_free (content_type);
content_type = NULL;
}
lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
gtk_source_buffer_set_language (buffer, lang);
g_free (content_type);
&lt;/programlisting&gt;&lt;/informalexample&gt;
etc. Use gtk_source_language_get_mime_types() and gtk_source_language_get_globs()
if you need full control over file -&gt; language mapping.</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="52"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="645">a #GtkSourceLanguage, or %NULL if there
is no suitable language for given @filename and/or @content_type. Return
value is owned by @lm and should not be freed.</doc>
<type name="Language" c:type="GtkSourceLanguage*"/>
</return-value>
<parameters>
<instance-parameter name="lm" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="608">a #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</instance-parameter>
<parameter name="filename"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="609">a filename in Glib filename encoding, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="content_type"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="610">a content type (as in GIO API), or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_search_path"
c:identifier="gtk_source_language_manager_set_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="229">Sets the list of directories where the @lm looks for
language files.
If @dirs is %NULL, the search path is reset to default.
&lt;note&gt;
&lt;para&gt;
At the moment this function can be called only before the
language files are loaded for the first time. In practice
to set a custom search path for a #GtkSourceLanguageManager,
you have to call this function right after creating it.
&lt;/para&gt;
&lt;/note&gt;</doc>
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="lm" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="231">a #GtkSourceLanguageManager.</doc>
<type name="LanguageManager" c:type="GtkSourceLanguageManager*"/>
</instance-parameter>
<parameter name="dirs"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="232">a %NULL-terminated array of
strings or %NULL.</doc>
<array c:type="const gchar* const*">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<property name="language-ids" transfer-ownership="none">
<array>
<type name="utf8"/>
</array>
</property>
<property name="search-path" writable="1" transfer-ownership="none">
<array>
<type name="utf8"/>
</array>
</property>
</class>
<record name="LanguageManagerClass"
c:type="GtkSourceLanguageManagerClass"
glib:is-gtype-struct-for="LanguageManager">
<source-position filename="../gtksourceview/gtksourcelanguagemanager.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="Map"
c:symbol-prefix="map"
c:type="GtkSourceMap"
parent="View"
glib:type-name="GtkSourceMap"
glib:get-type="gtk_source_map_get_type"
glib:type-struct="MapClass">
<source-position filename="../gtksourceview/gtksourcemap.h" line="43"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<implements name="Gtk.Scrollable"/>
<constructor name="new" c:identifier="gtk_source_map_new" version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1276">Creates a new #GtkSourceMap.</doc>
<source-position filename="../gtksourceview/gtksourcemap.h" line="46"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1281">a new #GtkSourceMap.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
</constructor>
<method name="get_view"
c:identifier="gtk_source_map_get_view"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1329">Gets the #GtkSourceMap:view property, which is the view this widget is mapping.</doc>
<source-position filename="../gtksourceview/gtksourcemap.h" line="51"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1335">a #GtkSourceView or %NULL.</doc>
<type name="View" c:type="GtkSourceView*"/>
</return-value>
<parameters>
<instance-parameter name="map" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1331">a #GtkSourceMap.</doc>
<type name="Map" c:type="GtkSourceMap*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_view"
c:identifier="gtk_source_map_set_view"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1291">Sets the view that @map will be doing the mapping to.</doc>
<source-position filename="../gtksourceview/gtksourcemap.h" line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="map" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1293">a #GtkSourceMap</doc>
<type name="Map" c:type="GtkSourceMap*"/>
</instance-parameter>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="1294">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
</parameters>
</method>
<property name="font-desc" writable="1" transfer-ownership="none">
<type name="Pango.FontDescription"/>
</property>
<property name="view" writable="1" transfer-ownership="none">
<type name="View"/>
</property>
<field name="parent_instance">
<type name="View" c:type="GtkSourceView"/>
</field>
</class>
<record name="MapClass"
c:type="GtkSourceMapClass"
glib:is-gtype-struct-for="Map">
<source-position filename="../gtksourceview/gtksourcemap.h" line="43"/>
<field name="parent_class">
<type name="ViewClass" c:type="GtkSourceViewClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="Mark"
c:symbol-prefix="mark"
c:type="GtkSourceMark"
parent="Gtk.TextMark"
glib:type-name="GtkSourceMark"
glib:get-type="gtk_source_mark_get_type"
glib:type-struct="MarkClass">
<source-position filename="../gtksourceview/gtksourcemark.h" line="43"/>
<constructor name="new" c:identifier="gtk_source_mark_new" version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="146">Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
If name is NULL, the mark is anonymous; otherwise, the mark can be retrieved
by name using gtk_text_buffer_get_mark().
Normally marks are created using the utility function
gtk_source_buffer_create_source_mark().</doc>
<source-position filename="../gtksourceview/gtksourcemark.h"
line="46"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="160">a new #GtkSourceMark that can be added using gtk_text_buffer_add_mark().</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</return-value>
<parameters>
<parameter name="name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="148">Name of the #GtkSourceMark or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="149">is used to classify marks according to common characteristics
(e.g. all the marks representing a bookmark could belong to the "bookmark"
category, or all the marks representing a compilation error could belong
to "error" category).</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<method name="get_category"
c:identifier="gtk_source_mark_get_category"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="177">Returns the mark category.</doc>
<source-position filename="../gtksourceview/gtksourcemark.h"
line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="183">the category of the #GtkSourceMark.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="179">a #GtkSourceMark.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</instance-parameter>
</parameters>
</method>
<method name="next" c:identifier="gtk_source_mark_next" version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="197">Returns the next #GtkSourceMark in the buffer or %NULL if the mark
was not added to a buffer. If there is no next mark, %NULL will be returned.
If @category is %NULL, looks for marks of any category.</doc>
<source-position filename="../gtksourceview/gtksourcemark.h"
line="51"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="207">the next #GtkSourceMark, or %NULL.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</return-value>
<parameters>
<instance-parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="199">a #GtkSourceMark.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</instance-parameter>
<parameter name="category"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="200">a string specifying the mark category, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="prev" c:identifier="gtk_source_mark_prev" version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="231">Returns the previous #GtkSourceMark in the buffer or %NULL if the mark
was not added to a buffer. If there is no previous mark, %NULL is returned.
If @category is %NULL, looks for marks of any category</doc>
<source-position filename="../gtksourceview/gtksourcemark.h"
line="54"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="241">the previous #GtkSourceMark, or %NULL.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</return-value>
<parameters>
<instance-parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="233">a #GtkSourceMark.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="234">a string specifying the mark category, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="category"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="124">The category of the #GtkSourceMark, classifies the mark and controls
which pixbuf is used and with which priority it is drawn.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent_instance">
<type name="Gtk.TextMark" c:type="GtkTextMark"/>
</field>
</class>
<class name="MarkAttributes"
c:symbol-prefix="mark_attributes"
c:type="GtkSourceMarkAttributes"
parent="GObject.Object"
glib:type-name="GtkSourceMarkAttributes"
glib:get-type="gtk_source_mark_attributes_get_type"
glib:type-struct="MarkAttributesClass">
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="36"/>
<constructor name="new" c:identifier="gtk_source_mark_attributes_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="375">Creates a new source mark attributes.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="39"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="380">a new source mark attributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</return-value>
</constructor>
<method name="get_background"
c:identifier="gtk_source_mark_attributes_get_background">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="404">Stores background color in @background.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="44"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="411">whether background color for @attributes was set.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="406">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="background"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="407">a #GdkRGBA.</doc>
<type name="Gdk.RGBA" c:type="GdkRGBA*"/>
</parameter>
</parameters>
</method>
<method name="get_gicon"
c:identifier="gtk_source_mark_attributes_get_gicon">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="476">Gets a #GIcon to be used as a base for rendered icon. Note that the icon can
be %NULL if it wasn't set earlier.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="55"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="483">An icon. The icon belongs to @attributes and should
not be unreffed.</doc>
<type name="Gio.Icon" c:type="GIcon*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="478">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_icon_name"
c:identifier="gtk_source_mark_attributes_get_icon_name">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="442">Gets a name of an icon to be used as a base for rendered icon. Note that the
icon name can be %NULL if it wasn't set earlier.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="50"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="449">An icon name. The string belongs to @attributes and
should not be freed.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="444">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pixbuf"
c:identifier="gtk_source_mark_attributes_get_pixbuf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="510">Gets a #GdkPixbuf to be used as a base for rendered icon. Note that the
pixbuf can be %NULL if it wasn't set earlier.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="60"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="517">A pixbuf. The pixbuf belongs to @attributes and
should not be unreffed.</doc>
<type name="GdkPixbuf.Pixbuf" c:type="const GdkPixbuf*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="512">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tooltip_markup"
c:identifier="gtk_source_mark_attributes_get_tooltip_markup">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="589">Queries for a tooltip by emitting
a #GtkSourceMarkAttributes::query-tooltip-markup signal. The tooltip may contain
a markup.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="69"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="598">A tooltip. The returned string should be freed by
using g_free() when done with it.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="591">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="592">a #GtkSourceMark.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</parameter>
</parameters>
</method>
<method name="get_tooltip_text"
c:identifier="gtk_source_mark_attributes_get_tooltip_text">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="562">Queries for a tooltip by emitting
a #GtkSourceMarkAttributes::query-tooltip-text signal. The tooltip is a plain
text.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="66"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="571">A tooltip. The returned string should be freed by
using g_free() when done with it.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="564">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="565">a #GtkSourceMark.</doc>
<type name="Mark" c:type="GtkSourceMark*"/>
</parameter>
</parameters>
</method>
<method name="render_icon"
c:identifier="gtk_source_mark_attributes_render_icon">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="528">Renders an icon of given size. The base of the icon is set by the last call
to one of: gtk_source_mark_attributes_set_pixbuf(),
gtk_source_mark_attributes_set_gicon() or
gtk_source_mark_attributes_set_icon_name(). @size cannot be lower than 1.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="62"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="539">A #GdkPaintable. The paintable belongs to @attributes
and should not be unreffed.</doc>
<type name="Gdk.Paintable" c:type="GdkPaintable*"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="530">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="widget" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="531">widget of which style settings may be used.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</parameter>
<parameter name="size" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="532">size of the rendered icon.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_background"
c:identifier="gtk_source_mark_attributes_set_background">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="388">Sets background color to the one given in @background.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="41"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="390">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="background" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="391">a #GdkRGBA.</doc>
<type name="Gdk.RGBA" c:type="const GdkRGBA*"/>
</parameter>
</parameters>
</method>
<method name="set_gicon"
c:identifier="gtk_source_mark_attributes_set_gicon">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="460">Sets an icon to be used as a base for rendered icon.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="462">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="gicon" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="463">a #GIcon to be used.</doc>
<type name="Gio.Icon" c:type="GIcon*"/>
</parameter>
</parameters>
</method>
<method name="set_icon_name"
c:identifier="gtk_source_mark_attributes_set_icon_name">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="426">Sets a name of an icon to be used as a base for rendered icon.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="428">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="icon_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="429">name of an icon to be used.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_pixbuf"
c:identifier="gtk_source_mark_attributes_set_pixbuf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="494">Sets a pixbuf to be used as a base for rendered icon.</doc>
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="57"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="496">a #GtkSourceMarkAttributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</instance-parameter>
<parameter name="pixbuf" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="497">a #GdkPixbuf to be used.</doc>
<type name="GdkPixbuf.Pixbuf" c:type="const GdkPixbuf*"/>
</parameter>
</parameters>
</method>
<property name="background" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="260">A color used for background of a line.</doc>
<type name="Gdk.RGBA"/>
</property>
<property name="gicon" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="302">A #GIcon that may be a base of a rendered icon.</doc>
<type name="Gio.Icon"/>
</property>
<property name="icon-name" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="288">An icon name that may be a base of a rendered icon.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="pixbuf" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="274">A #GdkPixbuf that may be a base of a rendered icon.</doc>
<type name="GdkPixbuf.Pixbuf"/>
</property>
<glib:signal name="query-tooltip-markup" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="343">The code should connect to this signal to provide a tooltip for given
@mark. The tooltip can contain a markup.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="351">A tooltip. The string should be freed with
g_free() when done with it.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="346">The #GtkSourceMark.</doc>
<type name="Mark"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="query-tooltip-text" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="318">The code should connect to this signal to provide a tooltip for given
@mark. The tooltip should be just a plain text.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="326">A tooltip. The string should be freed with
g_free() when done with it.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="mark" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="321">The #GtkSourceMark.</doc>
<type name="Mark"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="MarkAttributesClass"
c:type="GtkSourceMarkAttributesClass"
glib:is-gtype-struct-for="MarkAttributes">
<source-position filename="../gtksourceview/gtksourcemarkattributes.h"
line="36"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<record name="MarkClass"
c:type="GtkSourceMarkClass"
glib:is-gtype-struct-for="Mark">
<source-position filename="../gtksourceview/gtksourcemark.h" line="43"/>
<field name="parent_class">
<type name="Gtk.TextMarkClass" c:type="GtkTextMarkClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<callback name="MountOperationFactory"
c:type="GtkSourceMountOperationFactory"
version="3.14"
introspectable="0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="76">Type definition for a function that will be called to create a
#GMountOperation. This is useful for creating a #GtkMountOperation.</doc>
<source-position filename="../gtksourceview/gtksourcefile.h" line="86"/>
<return-value>
<type name="Gio.MountOperation" c:type="GMountOperation*"/>
</return-value>
<parameters>
<parameter name="file" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="78">a #GtkSourceFile.</doc>
<type name="File" c:type="GtkSourceFile*"/>
</parameter>
<parameter name="userdata"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="79">user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<enumeration name="NewlineType"
version="3.14"
glib:type-name="GtkSourceNewlineType"
glib:get-type="gtk_source_newline_type_get_type"
c:type="GtkSourceNewlineType">
<member name="lf"
value="0"
c:identifier="GTK_SOURCE_NEWLINE_TYPE_LF"
glib:nick="lf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="36">line feed, used on UNIX.</doc>
</member>
<member name="cr"
value="1"
c:identifier="GTK_SOURCE_NEWLINE_TYPE_CR"
glib:nick="cr">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="37">carriage return, used on Mac.</doc>
</member>
<member name="cr_lf"
value="2"
c:identifier="GTK_SOURCE_NEWLINE_TYPE_CR_LF"
glib:nick="cr-lf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.h"
line="38">carriage return followed by a line feed, used
on Windows.</doc>
</member>
</enumeration>
<class name="PrintCompositor"
c:symbol-prefix="print_compositor"
c:type="GtkSourcePrintCompositor"
parent="GObject.Object"
glib:type-name="GtkSourcePrintCompositor"
glib:get-type="gtk_source_print_compositor_get_type"
glib:type-struct="PrintCompositorClass">
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="44"/>
<constructor name="new"
c:identifier="gtk_source_print_compositor_new"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="749">Creates a new print compositor that can be used to print @buffer.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="47"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="755">a new print compositor object.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="751">the #GtkSourceBuffer to print.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_view"
c:identifier="gtk_source_print_compositor_new_from_view"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="769">Creates a new print compositor that can be used to print the buffer
associated with @view.
This constructor sets some configuration properties to make the
printed output match @view as much as possible. The properties set are
#GtkSourcePrintCompositor:tab-width, #GtkSourcePrintCompositor:highlight-syntax,
#GtkSourcePrintCompositor:wrap-mode, #GtkSourcePrintCompositor:body-font-name and
#GtkSourcePrintCompositor:print-line-numbers.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="49"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="781">a new print compositor object.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="771">a #GtkSourceView to get configuration from.</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
</parameters>
</constructor>
<method name="draw_page"
c:identifier="gtk_source_print_compositor_draw_page">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3092">Draw page @page_nr for printing on the the Cairo context encapsuled in @context.
This method has been designed to be called in the handler of the #GtkPrintOperation::draw_page signal
as shown in the following example:
&lt;informalexample&gt;&lt;programlisting&gt;
// Signal handler for the GtkPrintOperation::draw_page signal
static void
draw_page (GtkPrintOperation *operation,
GtkPrintContext *context,
gint page_nr,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
gtk_source_print_compositor_draw_page (compositor,
context,
page_nr);
}
&lt;/programlisting&gt;&lt;/informalexample&gt;</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="150"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3094">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3095">the #GtkPrintContext encapsulating the context information that is required when
drawing the page for printing.</doc>
<type name="Gtk.PrintContext" c:type="GtkPrintContext*"/>
</parameter>
<parameter name="page_nr" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3097">the number of the page to print.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_body_font_name"
c:identifier="gtk_source_print_compositor_get_body_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1337">Returns the name of the font used to print the text body. The returned string
must be freed with g_free().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="76"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1344">a new string containing the name of the font used to print the
text body.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1339">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_bottom_margin"
c:identifier="gtk_source_print_compositor_get_bottom_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1625">Gets the bottom margin in units of @unit.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1632">the bottom margin.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1627">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1628">the unit for the return value.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_print_compositor_get_buffer"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="819">Gets the #GtkSourceBuffer associated with the compositor. The returned
object reference is owned by the compositor object and
should not be unreferenced.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="51"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="827">the #GtkSourceBuffer associated with the compositor.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="821">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_footer_font_name"
c:identifier="gtk_source_print_compositor_get_footer_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1531">Returns the name of the font used to print the page footer.
The returned string must be freed with g_free().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="91"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1538">a new string containing the name of the font used to print
the page footer.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1533">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_header_font_name"
c:identifier="gtk_source_print_compositor_get_header_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1464">Returns the name of the font used to print the page header.
The returned string must be freed with g_free().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="86"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1471">a new string containing the name of the font used to print
the page header.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1466">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_highlight_syntax"
c:identifier="gtk_source_print_compositor_get_highlight_syntax"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="975">Determines whether the printed text will be highlighted according to the
buffer rules. Note that highlighting will happen
only if the buffer to print has highlighting activated.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="983">%TRUE if the printed output will be highlighted.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="977">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_left_margin"
c:identifier="gtk_source_print_compositor_get_left_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1669">Gets the left margin in units of @unit.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="107"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1676">the left margin</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1671">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1672">the unit for the return value.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="get_line_numbers_font_name"
c:identifier="gtk_source_print_compositor_get_line_numbers_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1397">Returns the name of the font used to print line numbers on the left margin.
The returned string must be freed with g_free().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="81"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1404">a new string containing the name of the font used to print
line numbers on the left margin.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1399">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_n_pages"
c:identifier="gtk_source_print_compositor_get_n_pages"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1735">Returns the number of pages in the document or &lt;code&gt;-1&lt;/code&gt; if the
document has not been completely paginated.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="143"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1742">the number of pages in the document or &lt;code&gt;-1&lt;/code&gt; if the
document has not been completely paginated.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1737">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_pagination_progress"
c:identifier="gtk_source_print_compositor_get_pagination_progress"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2805">Returns the current fraction of the document pagination that has been completed.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="148"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2811">a fraction from 0.0 to 1.0 inclusive.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2807">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_print_footer"
c:identifier="gtk_source_print_compositor_get_print_footer"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1131">Determines if a footer is set to be printed for each page. A
footer will be printed if this function returns %TRUE
&lt;emphasis&gt;and&lt;/emphasis&gt; some format strings have been specified
with gtk_source_print_compositor_set_footer_format().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="129"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1140">%TRUE if the footer is set to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1133">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_print_header"
c:identifier="gtk_source_print_compositor_get_print_header"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1070">Determines if a header is set to be printed for each page. A
header will be printed if this function returns %TRUE
&lt;emphasis&gt;and&lt;/emphasis&gt; some format strings have been specified
with gtk_source_print_compositor_set_header_format().</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="124"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1079">%TRUE if the header is set to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1072">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_print_line_numbers"
c:identifier="gtk_source_print_compositor_get_print_line_numbers"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1247">Returns the interval used for line number printing. If the
value is 0, no line numbers will be printed. The default value is
1 (i.e. numbers printed in all lines).</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1255">the interval of printed line numbers.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1249">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_right_margin"
c:identifier="gtk_source_print_compositor_get_right_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1713">Gets the right margin in units of @unit.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="114"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1720">the right margin.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1715">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1716">the unit for the return value.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="get_tab_width"
c:identifier="gtk_source_print_compositor_get_tab_width"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="872">Returns the width of tabulation in characters for printed text.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="56"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="878">width of tab.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="874">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_top_margin"
c:identifier="gtk_source_print_compositor_get_top_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1581">Gets the top margin in units of @unit.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="93"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1588">the top margin.</doc>
<type name="gdouble" c:type="gdouble"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1583">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1584">the unit for the return value.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="get_wrap_mode"
c:identifier="gtk_source_print_compositor_get_wrap_mode"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="922">Gets the line wrapping mode for the printed text.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="61"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="928">the line wrap mode.</doc>
<type name="Gtk.WrapMode" c:type="GtkWrapMode"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="924">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
</parameters>
</method>
<method name="ignore_tag"
c:identifier="gtk_source_print_compositor_ignore_tag"
version="5.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3309">Specifies a tag whose style should be ignored when compositing the
document to the printable page.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="154"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3311">a #GtkSourcePrintCompositor</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="3312">a #GtkTextTag</doc>
<type name="Gtk.TextTag" c:type="GtkTextTag*"/>
</parameter>
</parameters>
</method>
<method name="paginate"
c:identifier="gtk_source_print_compositor_paginate"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2493">Paginate the document associated with the @compositor.
In order to support non-blocking pagination, document is paginated in small chunks.
Each time gtk_source_print_compositor_paginate() is invoked, a chunk of the document
is paginated. To paginate the entire document, gtk_source_print_compositor_paginate()
must be invoked multiple times.
It returns %TRUE if the document has been completely paginated, otherwise it returns %FALSE.
This method has been designed to be invoked in the handler of the #GtkPrintOperation::paginate signal,
as shown in the following example:
&lt;informalexample&gt;&lt;programlisting&gt;
// Signal handler for the GtkPrintOperation::paginate signal
static gboolean
paginate (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
if (gtk_source_print_compositor_paginate (compositor, context))
{
gint n_pages;
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
return TRUE;
}
return FALSE;
}
&lt;/programlisting&gt;&lt;/informalexample&gt;
If you don't need to do pagination in chunks, you can simply do it all in the
#GtkPrintOperation::begin-print handler, and set the number of pages from there, like
in the following example:
&lt;informalexample&gt;&lt;programlisting&gt;
// Signal handler for the GtkPrintOperation::begin-print signal
static void
begin_print (GtkPrintOperation *operation,
GtkPrintContext *context,
gpointer user_data)
{
GtkSourcePrintCompositor *compositor;
gint n_pages;
compositor = GTK_SOURCE_PRINT_COMPOSITOR (user_data);
while (!gtk_source_print_compositor_paginate (compositor, context));
n_pages = gtk_source_print_compositor_get_n_pages (compositor);
gtk_print_operation_set_n_pages (operation, n_pages);
}
&lt;/programlisting&gt;&lt;/informalexample&gt;</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="145"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2560">%TRUE if the document has been completely paginated, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2495">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="2496">the #GtkPrintContext whose parameters (e.g. paper size, print margins, etc.)
are used by the the @compositor to paginate the document.</doc>
<type name="Gtk.PrintContext" c:type="GtkPrintContext*"/>
</parameter>
</parameters>
</method>
<method name="set_body_font_name"
c:identifier="gtk_source_print_compositor_set_body_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1301">Sets the default font for the printed text.
@font_name should be a
string representation of a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="73"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1303">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="font_name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1304">the name of the default font for the body text.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_bottom_margin"
c:identifier="gtk_source_print_compositor_set_bottom_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1603">Sets the bottom margin used by @compositor.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="103"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1605">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="margin" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1606">the new bottom margin in units of @unit.</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1607">the units for @margin.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="set_footer_font_name"
c:identifier="gtk_source_print_compositor_set_footer_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1492">Sets the font for printing the page footer. If
%NULL is supplied, the default font (i.e. the one being used for the
text) will be used instead.
@font_name should be a
string representation of a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="88"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1494">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="font_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1495">the name of the font for the footer text, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_footer_format"
c:identifier="gtk_source_print_compositor_set_footer_format"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1210">See gtk_source_print_compositor_set_header_format() for more information
about the parameters.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="137"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1212">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="separator" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1213">%TRUE if you want a separator line to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="left"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1214">a format string to print on the left of the footer.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="center"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1215">a format string to print on the center of the footer.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="right"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1216">a format string to print on the right of the footer.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_header_font_name"
c:identifier="gtk_source_print_compositor_set_header_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1425">Sets the font for printing the page header. If
%NULL is supplied, the default font (i.e. the one being used for the
text) will be used instead.
@font_name should be a
string representation of a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="83"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1427">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="font_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1428">the name of the font for header text, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_header_format"
c:identifier="gtk_source_print_compositor_set_header_format"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1154">Sets strftime like header format strings, to be printed on the
left, center and right of the top of each page. The strings may
include strftime(3) codes which will be expanded at print time.
A subset of strftime() codes are accepted, see g_date_time_format()
for more details on the accepted format specifiers.
Additionally the following format specifiers are accepted:
- #N: the page number
- #Q: the page count.
@separator specifies if a solid line should be drawn to separate
the header from the document text.
If %NULL is given for any of the three arguments, that particular
string will not be printed.
For the header to be printed, in
addition to specifying format strings, you need to enable header
printing with gtk_source_print_compositor_set_print_header().
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="131"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1156">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="separator" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1157">%TRUE if you want a separator line to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="left"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1158">a format string to print on the left of the header.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="center"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1159">a format string to print on the center of the header.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="right"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1160">a format string to print on the right of the header.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_highlight_syntax"
c:identifier="gtk_source_print_compositor_set_highlight_syntax"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="942">Sets whether the printed text will be highlighted according to the
buffer rules. Both color and font style are applied.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="944">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="highlight" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="945">whether syntax should be highlighted.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_left_margin"
c:identifier="gtk_source_print_compositor_set_left_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1647">Sets the left margin used by @compositor.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="110"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1649">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="margin" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1650">the new left margin in units of @unit.</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1651">the units for @margin.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="set_line_numbers_font_name"
c:identifier="gtk_source_print_compositor_set_line_numbers_font_name"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1359">Sets the font for printing line numbers on the left margin. If
%NULL is supplied, the default font (i.e. the one being used for the
text) will be used instead.
@font_name should be a
string representation of a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="78"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1361">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="font_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1362">the name of the font for line numbers, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_print_footer"
c:identifier="gtk_source_print_compositor_set_print_footer"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1093">Sets whether you want to print a footer in each page. The
footer consists of three pieces of text and an optional line
separator, configurable with
gtk_source_print_compositor_set_footer_format().
Note that by default the footer format is unspecified, and if it's
empty it will not be printed, regardless of this setting.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="126"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1095">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="print" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1096">%TRUE if you want the footer to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_print_header"
c:identifier="gtk_source_print_compositor_set_print_header"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1032">Sets whether you want to print a header in each page. The
header consists of three pieces of text and an optional line
separator, configurable with
gtk_source_print_compositor_set_header_format().
Note that by default the header format is unspecified, and if it's
empty it will not be printed, regardless of this setting.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="121"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1034">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="print" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1035">%TRUE if you want the header to be printed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_print_line_numbers"
c:identifier="gtk_source_print_compositor_set_print_line_numbers"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="997">Sets the interval for printed line numbers. If @interval is 0 no
numbers will be printed. If greater than 0, a number will be
printed every @interval lines (i.e. 1 will print all line numbers).
Maximum accepted value for @interval is 100.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="999">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="interval" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1000">interval for printed line numbers.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_right_margin"
c:identifier="gtk_source_print_compositor_set_right_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1691">Sets the right margin used by @compositor.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="117"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1693">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="margin" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1694">the new right margin in units of @unit.</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1695">the units for @margin.</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="set_tab_width"
c:identifier="gtk_source_print_compositor_set_tab_width"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="841">Sets the width of tabulation in characters for printed text.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="843">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="844">width of tab in characters.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_top_margin"
c:identifier="gtk_source_print_compositor_set_top_margin"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1559">Sets the top margin used by @compositor.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="96"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1561">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="margin" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1562">the new top margin in units of @unit</doc>
<type name="gdouble" c:type="gdouble"/>
</parameter>
<parameter name="unit" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="1563">the units for @margin</doc>
<type name="Gtk.Unit" c:type="GtkUnit"/>
</parameter>
</parameters>
</method>
<method name="set_wrap_mode"
c:identifier="gtk_source_print_compositor_set_wrap_mode"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="892">Sets the line wrapping mode for the printed text.
This function cannot be called anymore after the first call to the
gtk_source_print_compositor_paginate() function.</doc>
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="58"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="compositor" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="894">a #GtkSourcePrintCompositor.</doc>
<type name="PrintCompositor" c:type="GtkSourcePrintCompositor*"/>
</instance-parameter>
<parameter name="wrap_mode" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="895">a #GtkWrapMode.</doc>
<type name="Gtk.WrapMode" c:type="GtkWrapMode"/>
</parameter>
</parameters>
</method>
<property name="body-font-name"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="576">Name of the font used for the text body.
Accepted values are strings representing a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="buffer"
version="2.2"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="432">The GtkSourceBuffer object to print.</doc>
<type name="Buffer"/>
</property>
<property name="footer-font-name"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="647">Name of the font used to print page footer.
If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="header-font-name"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="623">Name of the font used to print page header.
If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="highlight-syntax"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="490">Whether to print the document with highlighted syntax.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="line-numbers-font-name"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="599">Name of the font used to print line numbers on the left margin.
If this property is unspecified, the text body font is used.
Accepted values are strings representing a font description Pango can understand.
(e.g. &amp;quot;Monospace 10&amp;quot;). See pango_font_description_from_string()
for a description of the format of the string representation.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="n-pages" version="2.2" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="671">The number of pages in the document or &lt;code&gt;-1&lt;/code&gt; if the
document has not been completely paginated.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="print-footer"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="553">Whether to print a footer in each page.
Note that by default the footer format is unspecified, and if it is
unspecified the footer will not be printed, regardless of the value of
this property.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="print-header"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="530">Whether to print a header in each page.
Note that by default the header format is unspecified, and if it is
unspecified the header will not be printed, regardless of the value of
this property.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="print-line-numbers"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="509">Interval of printed line numbers. If this property is set to 0 no
numbers will be printed. If greater than 0, a number will be
printed every "print-line-numbers" lines (i.e. 1 will print all line numbers).
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="tab-width"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="448">Width of a tab character expressed in spaces.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="wrap-mode"
version="2.2"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="470">Whether to wrap lines never, at word boundaries, or at character boundaries.
The value of this property cannot be changed anymore after the first
call to the gtk_source_print_compositor_paginate() function.</doc>
<type name="Gtk.WrapMode"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="PrintCompositorClass"
c:type="GtkSourcePrintCompositorClass"
glib:is-gtype-struct-for="PrintCompositor">
<source-position filename="../gtksourceview/gtksourceprintcompositor.h"
line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="Region"
c:symbol-prefix="region"
c:type="GtkSourceRegion"
parent="GObject.Object"
glib:type-name="GtkSourceRegion"
glib:get-type="gtk_source_region_get_type"
glib:type-struct="RegionClass">
<source-position filename="../gtksourceview/gtksourceregion.h"
line="44"/>
<constructor name="new"
c:identifier="gtk_source_region_new"
version="3.22">
<source-position filename="../gtksourceview/gtksourceregion.h"
line="64"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="328">a new #GtkSourceRegion object for @buffer.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="326">a #GtkTextBuffer.</doc>
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer*"/>
</parameter>
</parameters>
</constructor>
<method name="add_region"
c:identifier="gtk_source_region_add_region"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="523">Adds @region_to_add to @region. @region_to_add is not modified.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="72"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="525">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="region_to_add"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="526">the #GtkSourceRegion to add to @region, or %NULL.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</parameter>
</parameters>
</method>
<method name="add_subregion"
c:identifier="gtk_source_region_add_subregion"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="399">Adds the subregion delimited by @_start and @_end to @region.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="401">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="_start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="402">the start of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="403">the end of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_bounds"
c:identifier="gtk_source_region_get_bounds"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="858">Gets the @start and @end bounds of the @region.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="91"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="868">%TRUE if @start and @end have been set successfully (if non-%NULL),
or %FALSE if the @region is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="860">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="861">iterator to initialize with the start of @region,
or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="863">iterator to initialize with the end of @region,
or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_region_get_buffer"
version="3.22">
<source-position filename="../gtksourceview/gtksourceregion.h"
line="66"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="345">the #GtkTextBuffer.</doc>
<type name="Gtk.TextBuffer" c:type="GtkTextBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="343">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_start_region_iter"
c:identifier="gtk_source_region_get_start_region_iter"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1185">Initializes a #GtkSourceRegionIter to the first subregion of @region. If
@region is empty, @iter will be initialized to the end iterator.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="95"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1187">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1188">iterator to initialize to the first subregion.</doc>
<type name="RegionIter" c:type="GtkSourceRegionIter*"/>
</parameter>
</parameters>
</method>
<method name="intersect_region"
c:identifier="gtk_source_region_intersect_region"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1079">Returns the intersection between @region1 and @region2. @region1 and
@region2 are not modified.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="86"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1087">the intersection as a #GtkSourceRegion
object.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</return-value>
<parameters>
<instance-parameter name="region1"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1081">a #GtkSourceRegion, or %NULL.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="region2"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1082">a #GtkSourceRegion, or %NULL.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</parameter>
</parameters>
</method>
<method name="intersect_subregion"
c:identifier="gtk_source_region_intersect_subregion"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="906">Returns the intersection between @region and the subregion delimited by
@_start and @_end. @region is not modified.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="82"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="915">the intersection as a new
#GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="908">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="_start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="909">the start of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="910">the end of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="is_empty"
c:identifier="gtk_source_region_is_empty"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="806">Returns whether the @region is empty. A %NULL @region is considered empty.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="89"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="812">whether the @region is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="region"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="808">a #GtkSourceRegion, or %NULL.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
</parameters>
</method>
<method name="subtract_region"
c:identifier="gtk_source_region_subtract_region"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="753">Subtracts @region_to_subtract from @region. @region_to_subtract is not
modified.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="79"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="755">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="region_to_subtract"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="756">the #GtkSourceRegion to subtract from
@region, or %NULL.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</parameter>
</parameters>
</method>
<method name="subtract_subregion"
c:identifier="gtk_source_region_subtract_subregion"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="579">Subtracts the subregion delimited by @_start and @_end from @region.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="75"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="581">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
<parameter name="_start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="582">the start of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="583">the end of the subregion.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="to_string"
c:identifier="gtk_source_region_to_string"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1318">Gets a string represention of @region, for debugging purposes.
The returned string contains the character offsets of the subregions. It
doesn't include a newline character at the end of the string.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="106"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1327">a string represention of @region. Free
with g_free() when no longer needed.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="region" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1320">a #GtkSourceRegion.</doc>
<type name="Region" c:type="GtkSourceRegion*"/>
</instance-parameter>
</parameters>
</method>
<property name="buffer"
version="3.22"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="299">The #GtkTextBuffer. The #GtkSourceRegion has a weak reference to the
buffer.</doc>
<type name="Gtk.TextBuffer"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="RegionClass"
c:type="GtkSourceRegionClass"
glib:is-gtype-struct-for="Region">
<source-position filename="../gtksourceview/gtksourceregion.h"
line="44"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="RegionIter" c:type="GtkSourceRegionIter" version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.h"
line="46">#GtkSourceRegionIter is an opaque datatype; ignore all its fields.
Initialize the iter with gtk_source_region_get_start_region_iter().</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="61"/>
<field name="dummy1" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy2" readable="0" private="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="dummy3" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<method name="get_subregion"
c:identifier="gtk_source_region_iter_get_subregion"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1264">Gets the subregion at this iterator.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="102"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1272">%TRUE if @start and @end have been set successfully (if non-%NULL),
or %FALSE if @iter is the end iterator or if the region is empty.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1266">a #GtkSourceRegionIter.</doc>
<type name="RegionIter" c:type="GtkSourceRegionIter*"/>
</instance-parameter>
<parameter name="start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1267">iterator to initialize with the subregion start, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1268">iterator to initialize with the subregion end, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="is_end"
c:identifier="gtk_source_region_iter_is_end"
version="3.22">
<source-position filename="../gtksourceview/gtksourceregion.h"
line="98"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1219">whether @iter is the end iterator.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1217">a #GtkSourceRegionIter.</doc>
<type name="RegionIter" c:type="GtkSourceRegionIter*"/>
</instance-parameter>
</parameters>
</method>
<method name="next"
c:identifier="gtk_source_region_iter_next"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1235">Moves @iter to the next subregion.</doc>
<source-position filename="../gtksourceview/gtksourceregion.h"
line="100"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1241">%TRUE if @iter moved and is dereferenceable, or %FALSE if @iter has
been set to the end iterator.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="1237">a #GtkSourceRegionIter.</doc>
<type name="RegionIter" c:type="GtkSourceRegionIter*"/>
</instance-parameter>
</parameters>
</method>
</record>
<callback name="SchedulerCallback"
c:type="GtkSourceSchedulerCallback"
version="5.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.h"
line="34">This function is called incrementally to process additional background work.
A deadline is provided which can be checked using g_get_monotonic_time() so
that additional work can be processed each frame.
This is useful for situations where you are incrementally performing
background work such as spell checking or semantic syntax highlighting.</doc>
<source-position filename="../gtksourceview/gtksourcescheduler.h"
line="51"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.h"
line="46">%TRUE if there is more work to process, otherwise %FALSE and the
handler is unregistered.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="deadline" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.h"
line="36">the time the callback should complete by</doc>
<type name="gint64" c:type="gint64"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.h"
line="37">closure data provided when registering callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="SearchContext"
c:symbol-prefix="search_context"
c:type="GtkSourceSearchContext"
parent="GObject.Object"
glib:type-name="GtkSourceSearchContext"
glib:get-type="gtk_source_search_context_get_type"
glib:type-struct="SearchContextClass">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="35"/>
<constructor name="new"
c:identifier="gtk_source_search_context_new"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2895">Creates a new search context, associated with @buffer, and customized with
@settings. If @settings is %NULL, a new #GtkSourceSearchSettings object will
be created, that you can retrieve with
gtk_source_search_context_get_settings().</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2905">a new search context.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2897">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
<parameter name="settings"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2898">a #GtkSourceSearchSettings, or %NULL.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</parameter>
</parameters>
</constructor>
<method name="backward"
c:identifier="gtk_source_search_context_backward"
version="4.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3400">Synchronous backward search. It is recommended to use the asynchronous
functions instead, to not block the user interface. However, if you are sure
that the @buffer is small, this function is more convenient to use.
If the #GtkSourceSearchSettings:wrap-around property is %FALSE, this function
doesn't try to wrap around.
The @has_wrapped_around out parameter is set independently of whether a match
is found. So if this function returns %FALSE, @has_wrapped_around will have
the same value as the #GtkSourceSearchSettings:wrap-around property.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="82"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3420">whether a match was found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3402">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3403">start of search.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="match_start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3404">return location for start of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="match_end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3405">return location for end of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="has_wrapped_around"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3406">return location to know whether the
search has wrapped around, or %NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="backward_async"
c:identifier="gtk_source_search_context_backward_async"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3476">The asynchronous version of gtk_source_search_context_backward().
See the documentation of gtk_source_search_context_backward() for more
details.
See the #GAsyncResult documentation to know how to use this function.
If the operation is cancelled, the @callback will only be called if
@cancellable was not %NULL. gtk_source_search_context_backward_async() takes
ownership of @cancellable, so you can unref it after calling this function.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="88"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3478">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3479">start of search.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3480">a #GCancellable, or %NULL.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3481">a #GAsyncReadyCallback to call when the operation is finished.</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3482">the data to pass to the @callback function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="backward_finish"
c:identifier="gtk_source_search_context_backward_finish"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3518">Finishes a backward search started with
gtk_source_search_context_backward_async().
See the documentation of gtk_source_search_context_backward() for more
details.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="94"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3534">whether a match was found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3520">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3521">a #GAsyncResult.</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
<parameter name="match_start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3522">return location for start of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="match_end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3523">return location for end of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="has_wrapped_around"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3524">return location to know whether the
search has wrapped around, or %NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="forward"
c:identifier="gtk_source_search_context_forward"
version="4.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3204">Synchronous forward search. It is recommended to use the asynchronous
functions instead, to not block the user interface. However, if you are sure
that the @buffer is small, this function is more convenient to use.
If the #GtkSourceSearchSettings:wrap-around property is %FALSE, this function
doesn't try to wrap around.
The @has_wrapped_around out parameter is set independently of whether a match
is found. So if this function returns %FALSE, @has_wrapped_around will have
the same value as the #GtkSourceSearchSettings:wrap-around property.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="63"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3224">whether a match was found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3206">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3207">start of search.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="match_start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3208">return location for start of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="match_end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3209">return location for end of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="has_wrapped_around"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3210">return location to know whether the
search has wrapped around, or %NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="forward_async"
c:identifier="gtk_source_search_context_forward_async"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3279">The asynchronous version of gtk_source_search_context_forward().
See the documentation of gtk_source_search_context_forward() for more
details.
See the #GAsyncResult documentation to know how to use this function.
If the operation is cancelled, the @callback will only be called if
@cancellable was not %NULL. gtk_source_search_context_forward_async() takes
ownership of @cancellable, so you can unref it after calling this function.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3281">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3282">start of search.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3283">a #GCancellable, or %NULL.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3284">a #GAsyncReadyCallback to call when the operation is finished.</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3285">the data to pass to the @callback function.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="forward_finish"
c:identifier="gtk_source_search_context_forward_finish"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3321">Finishes a forward search started with
gtk_source_search_context_forward_async().
See the documentation of gtk_source_search_context_forward() for more
details.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="75"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3337">whether a match was found.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3323">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3324">a #GAsyncResult.</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
<parameter name="match_start"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3325">return location for start of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="match_end"
direction="out"
caller-allocates="1"
transfer-ownership="none"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3326">return location for end of match, or %NULL.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="has_wrapped_around"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3327">return location to know whether the
search has wrapped around, or %NULL.</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
</parameters>
</method>
<method name="get_buffer"
c:identifier="gtk_source_search_context_get_buffer"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="41"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2925">the associated buffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2923">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_highlight"
c:identifier="gtk_source_search_context_get_highlight"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="45"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2955">whether to highlight the search occurrences.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2953">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_match_style"
c:identifier="gtk_source_search_context_get_match_style"
version="3.16">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="50"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2996">the #GtkSourceStyle to apply on search matches.</doc>
<type name="Style" c:type="GtkSourceStyle*"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2994">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_occurrence_position"
c:identifier="gtk_source_search_context_get_occurrence_position"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3099">Gets the position of a search occurrence. If the buffer is not already fully
scanned, the position may be unknown, and -1 is returned. If 0 is returned,
it means that this part of the buffer has already been scanned, and that
@match_start and @match_end don't delimit an occurrence.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="59"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3110">the position of the search occurrence. The first occurrence has the
position 1 (not 0). Returns 0 if @match_start and @match_end don't delimit
an occurrence. Returns -1 if the position is not yet known.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3101">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="match_start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3102">the start of the occurrence.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="match_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3103">the end of the occurrence.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="get_occurrences_count"
c:identifier="gtk_source_search_context_get_occurrences_count"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3075">Gets the total number of search occurrences. If the buffer is not already
fully scanned, the total number of occurrences is unknown, and -1 is
returned.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="57"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3083">the total number of search occurrences, or -1 if unknown.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3077">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_regex_error"
c:identifier="gtk_source_search_context_get_regex_error"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3047">Regular expression patterns must follow certain rules. If
#GtkSourceSearchSettings:search-text breaks a rule, the error can be
retrieved with this function. The error domain is #G_REGEX_ERROR.
Free the return value with g_error_free().</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="55"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3057">the #GError, or %NULL if the
pattern is valid.</doc>
<type name="GLib.Error" c:type="GError*"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3049">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_settings"
c:identifier="gtk_source_search_context_get_settings"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="43"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2940">the search settings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2938">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="replace"
c:identifier="gtk_source_search_context_replace"
version="4.0"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3650">Replaces a search match by another text. If @match_start and @match_end
doesn't correspond to a search match, %FALSE is returned.
@match_start and @match_end iters are revalidated to point to the replacement
text boundaries.
For a regular expression replacement, you can check if @replace is valid by
calling g_regex_check_replacement(). The @replace text can contain
backreferences.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="101"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3669">whether the match has been replaced.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3652">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="match_start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3653">the start of the match to replace.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="match_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3654">the end of the match to replace.</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="replace" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3655">the replacement text.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="replace_length" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3656">the length of @replace in bytes, or -1.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="replace_all"
c:identifier="gtk_source_search_context_replace_all"
version="3.10"
throws="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3734">Replaces all search matches by another text. It is a synchronous function, so
it can block the user interface.
For a regular expression replacement, you can check if @replace is valid by
calling g_regex_check_replacement(). The @replace text can contain
backreferences.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="108"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3748">the number of replaced matches.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3736">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="replace" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3737">the replacement text.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="replace_length" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3738">the length of @replace in bytes, or -1.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_highlight"
c:identifier="gtk_source_search_context_set_highlight"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2966">Enables or disables the search occurrences highlighting.</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="47"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2968">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="highlight" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2969">the setting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_match_style"
c:identifier="gtk_source_search_context_set_match_style"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3008">Set the style to apply on search matches. If @match_style is %NULL, default
theme's scheme 'match-style' will be used.
To enable or disable the search highlighting, use
gtk_source_search_context_set_highlight().</doc>
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="52"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="search" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3010">a #GtkSourceSearchContext.</doc>
<type name="SearchContext" c:type="GtkSourceSearchContext*"/>
</instance-parameter>
<parameter name="match_style"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="3011">a #GtkSourceStyle, or %NULL.</doc>
<type name="Style" c:type="GtkSourceStyle*"/>
</parameter>
</parameters>
</method>
<property name="buffer"
version="3.10"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2782">The #GtkSourceBuffer associated to the search context.</doc>
<type name="Buffer"/>
</property>
<property name="highlight"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2816">Highlight the search occurrences.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="match-style"
version="3.16"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2832">A #GtkSourceStyle, or %NULL for theme's scheme default style.</doc>
<type name="Style"/>
</property>
<property name="occurrences-count"
version="3.10"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2848">The total number of search occurrences. If the search is disabled,
the value is 0. If the buffer is not already fully scanned, the value
is -1.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="regex-error" version="3.10" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2867">If the regex search pattern doesn't follow all the rules, this
#GError property will be set. If the pattern is valid, the value is
%NULL.
Free with g_error_free().</doc>
<type name="GLib.Error"/>
</property>
<property name="settings"
version="3.10"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="2798">The #GtkSourceSearchSettings associated to the search context.
This property is construct-only since version 4.0.</doc>
<type name="SearchSettings"/>
</property>
</class>
<record name="SearchContextClass"
c:type="GtkSourceSearchContextClass"
glib:is-gtype-struct-for="SearchContext">
<source-position filename="../gtksourceview/gtksourcesearchcontext.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="SearchSettings"
c:symbol-prefix="search_settings"
c:type="GtkSourceSearchSettings"
parent="GObject.Object"
glib:type-name="GtkSourceSearchSettings"
glib:get-type="gtk_source_search_settings_get_type"
glib:type-struct="SearchSettingsClass">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="43"/>
<constructor name="new"
c:identifier="gtk_source_search_settings_new"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="237">Creates a new search settings object.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="46"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="242">a new search settings object.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</return-value>
</constructor>
<method name="get_at_word_boundaries"
c:identifier="gtk_source_search_settings_get_at_word_boundaries"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="61"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="393">whether to search at word boundaries.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="391">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_case_sensitive"
c:identifier="gtk_source_search_settings_get_case_sensitive"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="56"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="347">whether the search is case sensitive.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="345">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_regex_enabled"
c:identifier="gtk_source_search_settings_get_regex_enabled"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="71"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="488">whether to search by regular expressions.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="486">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_search_text"
c:identifier="gtk_source_search_settings_get_search_text"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="295">Gets the text to search. The return value must not be freed.
You may be interested to call gtk_source_utils_escape_search_text() after
this function.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="51"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="304">the text to search, or %NULL if the search is disabled.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="297">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_wrap_around"
c:identifier="gtk_source_search_settings_get_wrap_around"
version="3.10">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="439">whether to wrap around the search.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="437">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_at_word_boundaries"
c:identifier="gtk_source_search_settings_set_at_word_boundaries"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="360">Change whether the search is done at word boundaries. If @at_word_boundaries
is %TRUE, a search match must start and end a word. The match can span
multiple words. See also gtk_text_iter_starts_word() and
gtk_text_iter_ends_word().</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="58"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="362">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
<parameter name="at_word_boundaries" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="363">the setting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_case_sensitive"
c:identifier="gtk_source_search_settings_set_case_sensitive"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="317">Enables or disables the case sensitivity for the search.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="319">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
<parameter name="case_sensitive" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="320">the setting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_regex_enabled"
c:identifier="gtk_source_search_settings_set_regex_enabled"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="452">Enables or disables whether to search by regular expressions.
If enabled, the #GtkSourceSearchSettings:search-text property contains the
pattern of the regular expression.
#GtkSourceSearchContext uses #GRegex when regex search is enabled. See the
[Regular expression syntax](https://developer.gnome.org/glib/stable/glib-regex-syntax.html)
page in the GLib reference manual.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="68"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="454">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
<parameter name="regex_enabled" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="455">the setting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_search_text"
c:identifier="gtk_source_search_settings_set_search_text"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="251">Sets the text to search. If @search_text is %NULL or is empty, the search
will be disabled. A copy of @search_text will be made, so you can safely free
@search_text after a call to this function.
You may be interested to call gtk_source_utils_unescape_search_text() before
this function.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="253">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
<parameter name="search_text"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="254">the nul-terminated text to search, or %NULL to disable the search.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_wrap_around"
c:identifier="gtk_source_search_settings_set_wrap_around"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="406">Enables or disables the wrap around search. If @wrap_around is %TRUE, the
forward search continues at the beginning of the buffer if no search
occurrences are found. Similarly, the backward search continues to search at
the end of the buffer.</doc>
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="408">a #GtkSourceSearchSettings.</doc>
<type name="SearchSettings" c:type="GtkSourceSearchSettings*"/>
</instance-parameter>
<parameter name="wrap_around" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="409">the setting.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<property name="at-word-boundaries"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="183">If %TRUE, a search match must start and end a word. The match can
span multiple words.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="case-sensitive"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="169">Whether the search is case sensitive.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="regex-enabled"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="214">Search by regular expressions with
#GtkSourceSearchSettings:search-text as the pattern.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="search-text"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="153">A search string, or %NULL if the search is disabled. If the regular
expression search is enabled, #GtkSourceSearchSettings:search-text is
the pattern.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="wrap-around"
version="3.10"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="198">For a forward search, continue at the beginning of the buffer if no
search occurrence is found. For a backward search, continue at the
end of the buffer.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="SearchSettingsClass"
c:type="GtkSourceSearchSettingsClass"
glib:is-gtype-struct-for="SearchSettings">
<source-position filename="../gtksourceview/gtksourcesearchsettings.h"
line="43"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="SmartHomeEndType"
glib:type-name="GtkSourceSmartHomeEndType"
glib:get-type="gtk_source_smart_home_end_type_get_type"
c:type="GtkSourceSmartHomeEndType">
<member name="disabled"
value="0"
c:identifier="GTK_SOURCE_SMART_HOME_END_DISABLED"
glib:nick="disabled">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="51">smart-home-end disabled.</doc>
</member>
<member name="before"
value="1"
c:identifier="GTK_SOURCE_SMART_HOME_END_BEFORE"
glib:nick="before">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="52">move to the first/last
non-whitespace character on the first press of the HOME/END keys and
to the beginning/end of the line on the second press.</doc>
</member>
<member name="after"
value="2"
c:identifier="GTK_SOURCE_SMART_HOME_END_AFTER"
glib:nick="after">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="55">move to the beginning/end of the
line on the first press of the HOME/END keys and to the first/last
non-whitespace character on the second press.</doc>
</member>
<member name="always"
value="3"
c:identifier="GTK_SOURCE_SMART_HOME_END_ALWAYS"
glib:nick="always">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="58">always move to the first/last
non-whitespace character when the HOME/END keys are pressed.</doc>
</member>
</enumeration>
<class name="Snippet"
c:symbol-prefix="snippet"
c:type="GtkSourceSnippet"
parent="GObject.Object"
glib:type-name="GtkSourceSnippet"
glib:get-type="gtk_source_snippet_get_type"
glib:type-struct="SnippetClass">
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="35"/>
<constructor name="new"
c:identifier="gtk_source_snippet_new"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="116">Creates a new #GtkSourceSnippet</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="123">A new #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</return-value>
<parameters>
<parameter name="trigger"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="118">the trigger word</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="language_id"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="119">the source language</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<method name="add_chunk"
c:identifier="gtk_source_snippet_add_chunk"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="861">Appends @chunk to the @snippet.
This may only be called before the snippet has been expanded.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="63"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="863">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="864">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="gtk_source_snippet_copy" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="137">Does a deep copy of the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="41"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="143">A new #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="139">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context"
c:identifier="gtk_source_snippet_get_context"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="1199">Gets the context used for expanding the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="73"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="1205">an #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="1201">an #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="gtk_source_snippet_get_description"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="325">Gets the description for the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="58"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="327">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_focus_position"
c:identifier="gtk_source_snippet_get_focus_position"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="171">Gets the current focus for the snippet. This is changed
as the user tabs through focus locations.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="68"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="178">The focus position, or -1 if unset.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="173">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_language_id"
c:identifier="gtk_source_snippet_get_language_id"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="277">Gets the language-id used for the source snippet.
The language identifier should be one that matches a
source language #GtkSourceLanguage:id property.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="53"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="286">the language identifier</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="279">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_n_chunks"
c:identifier="gtk_source_snippet_get_n_chunks"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="190">Gets the number of chunks in the snippet.
Note that not all chunks are editable.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="66"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="198">The number of chunks.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="192">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="gtk_source_snippet_get_name"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="365">Gets the name for the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="43"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="367">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_nth_chunk"
c:identifier="gtk_source_snippet_get_nth_chunk"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="210">Gets the chunk at @nth.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="70"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="217">an #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="212">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="nth" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="213">the nth chunk to get</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_trigger"
c:identifier="gtk_source_snippet_get_trigger"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="233">Gets the trigger for the source snippet. A trigger is
a word that can be expanded into the full snippet when
the user presses Tab.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="48"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="241">A string or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="235">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_description"
c:identifier="gtk_source_snippet_set_description"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="341">Sets the description for the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="60"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="343">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="description" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="344">the snippet description</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_language_id"
c:identifier="gtk_source_snippet_set_language_id"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="298">Sets the language identifier for the snippet.
This should match the #GtkSourceLanguage:id identifier.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="55"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="300">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="language_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="301">the language identifier for the snippet</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_name"
c:identifier="gtk_source_snippet_set_name"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="381">Sets the name for the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="383">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="384">the snippet name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_trigger"
c:identifier="gtk_source_snippet_set_trigger"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="253">Sets the trigger for the snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="50"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="255">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</instance-parameter>
<parameter name="trigger" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="256">the trigger word</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="buffer" transfer-ownership="none">
<type name="Gtk.TextBuffer"/>
</property>
<property name="description" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="focus-position" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="language-id" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="name" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="trigger" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
</class>
<class name="SnippetChunk"
c:symbol-prefix="snippet_chunk"
c:type="GtkSourceSnippetChunk"
parent="GObject.InitiallyUnowned"
glib:type-name="GtkSourceSnippetChunk"
glib:get-type="gtk_source_snippet_chunk_get_type"
glib:type-struct="SnippetChunkClass">
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="35"/>
<constructor name="new"
c:identifier="gtk_source_snippet_chunk_new"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="53">Create a new #GtkSourceSnippetChunk that can be added to
a #GtkSourceSnippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="38"/>
<return-value transfer-ownership="none">
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</return-value>
</constructor>
<method name="copy"
c:identifier="gtk_source_snippet_chunk_copy"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="67">Copies the source snippet.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="40"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="73">A #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="69">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_context"
c:identifier="gtk_source_snippet_chunk_get_context"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="105">Gets the context for the snippet insertion.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="111">A #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="107">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_focus_position"
c:identifier="gtk_source_snippet_chunk_get_focus_position"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="204">Gets the #GtkSourceSnippetChunk:focus-position.
The focus-position is used to determine how many tabs it takes for the
snippet to advanced to this chunk.
A focus-position of zero will be the last focus position of the snippet
and snippet editing ends when it has been reached.
A focus-position of -1 means the chunk cannot be focused by the user.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="52"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="218">the focus-position</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="206">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_spec"
c:identifier="gtk_source_snippet_chunk_get_spec"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="152">Gets the specification for the chunk.
The specification is evaluated for variables when other chunks are edited
within the snippet context. If the user has changed the text, the
#GtkSourceSnippetChunk:text and #GtkSourceSnippetChunk:text-set properties
are updated.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="47"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="163">the specification, if any</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="154">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_text"
c:identifier="gtk_source_snippet_chunk_get_text"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="263">Gets the #GtkSourceSnippetChunk:text property.
The text property is updated when the user edits the text of the chunk.
If it has not been edited, the #GtkSourceSnippetChunk:spec property is
returned.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="57"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="273">the text of the chunk</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="265">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_text_set"
c:identifier="gtk_source_snippet_chunk_get_text_set"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="313">Gets the #GtkSourceSnippetChunk:text-set property.
This is typically set when the user has edited a snippet chunk.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="315">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tooltip_text"
c:identifier="gtk_source_snippet_chunk_get_tooltip_text">
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="67"/>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_context"
c:identifier="gtk_source_snippet_chunk_set_context">
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="context" transfer-ownership="none">
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</parameter>
</parameters>
</method>
<method name="set_focus_position"
c:identifier="gtk_source_snippet_chunk_set_focus_position"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="230">Sets the #GtkSourceSnippetChunk:focus-position property.
The focus-position is used to determine how many tabs it takes for the
snippet to advanced to this chunk.
A focus-position of zero will be the last focus position of the snippet
and snippet editing ends when it has been reached.
A focus-position of -1 means the chunk cannot be focused by the user.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="54"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="232">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="focus_position" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="233">the focus-position</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_spec"
c:identifier="gtk_source_snippet_chunk_set_spec"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="175">Sets the specification for the chunk.
The specification is evaluated for variables when other chunks are edited
within the snippet context. If the user has changed the text, the
#GtkSourceSnippetChunk:text and #GtkSourceSnippetChunk:text-set properties
are updated.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="49"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="177">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="spec" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="178">the new specification for the chunk</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_text"
c:identifier="gtk_source_snippet_chunk_set_text"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="285">Sets the text for the snippet chunk.
This is usually used by the snippet engine to update the text, but may
be useful when creating custom snippets to avoid expansion of any
specification.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="287">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="288">the text of the property</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_text_set"
c:identifier="gtk_source_snippet_chunk_set_text_set"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="331">Sets the #GtkSourceSnippetChunk:text-set property.
This is typically set when the user has edited a snippet chunk by the
snippet engine.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="64"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="333">a #GtkSourceSnippetChunk</doc>
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="text_set" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="334">the property value</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_tooltip_text"
c:identifier="gtk_source_snippet_chunk_set_tooltip_text">
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="69"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chunk" transfer-ownership="none">
<type name="SnippetChunk" c:type="GtkSourceSnippetChunk*"/>
</instance-parameter>
<parameter name="tooltip_text" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<property name="context" writable="1" transfer-ownership="none">
<type name="SnippetContext"/>
</property>
<property name="focus-position" writable="1" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="spec" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="text" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="text-set" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="tooltip-text" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
</class>
<record name="SnippetChunkClass"
c:type="GtkSourceSnippetChunkClass"
glib:is-gtype-struct-for="SnippetChunk">
<source-position filename="../gtksourceview/gtksourcesnippetchunk.h"
line="35"/>
<field name="parent_class">
<type name="GObject.InitiallyUnownedClass"
c:type="GInitiallyUnownedClass"/>
</field>
</record>
<record name="SnippetClass"
c:type="GtkSourceSnippetClass"
glib:is-gtype-struct-for="Snippet">
<source-position filename="../gtksourceview/gtksourcesnippet.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="SnippetContext"
c:symbol-prefix="snippet_context"
c:type="GtkSourceSnippetContext"
parent="GObject.Object"
glib:type-name="GtkSourceSnippetContext"
glib:get-type="gtk_source_snippet_context_get_type"
glib:type-struct="SnippetContextClass">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="35"/>
<constructor name="new"
c:identifier="gtk_source_snippet_context_new"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="72">Creates a new #GtkSourceSnippetContext.
Generally, this isn't needed unless you are controlling the
expansion of snippets manually.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="80">a #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</return-value>
</constructor>
<method name="clear_variables"
c:identifier="gtk_source_snippet_context_clear_variables"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="90">Removes all variables from the context.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="92">a #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="expand" c:identifier="gtk_source_snippet_context_expand">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="53"/>
<return-value transfer-ownership="full">
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="input" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_variable"
c:identifier="gtk_source_snippet_context_get_variable"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="155">Gets the current value for a variable named @key.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="50"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="162">the value for the variable, or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="157">a #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="158">the name of the variable</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_constant"
c:identifier="gtk_source_snippet_context_set_constant"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="130">Sets a constatnt within the context. This is similar to
a variable set with gtk_source_snippet_context_set_variable()
but is expected to not change during use of the snippet.
Examples would be the date or users name.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="46"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="132">a #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="133">the constant name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="134">the value of the constant</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_line_prefix"
c:identifier="gtk_source_snippet_context_set_line_prefix">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="line_prefix" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_tab_width"
c:identifier="gtk_source_snippet_context_set_tab_width">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="56"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="tab_width" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_use_spaces"
c:identifier="gtk_source_snippet_context_set_use_spaces">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="59"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="use_spaces" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_variable"
c:identifier="gtk_source_snippet_context_set_variable"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="106">Sets a variable within the context.
This variable may be overridden by future updates to the
context.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="108">a #GtkSourceSnippetContext</doc>
<type name="SnippetContext" c:type="GtkSourceSnippetContext*"/>
</instance-parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="109">the variable name</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="110">the value for the variable</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<glib:signal name="changed" when="first" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="840">The "changed" signal is emitted when a change has been
discovered in one of the chunks of the snippet which has
caused a variable or other dynamic data within the context
to have changed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<record name="SnippetContextClass"
c:type="GtkSourceSnippetContextClass"
glib:is-gtype-struct-for="SnippetContext">
<source-position filename="../gtksourceview/gtksourcesnippetcontext.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="SnippetManager"
c:symbol-prefix="snippet_manager"
c:type="GtkSourceSnippetManager"
parent="GObject.Object"
glib:type-name="GtkSourceSnippetManager"
glib:get-type="gtk_source_snippet_manager_get_type"
glib:type-struct="SnippetManagerClass">
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="35"/>
<function name="get_default"
c:identifier="gtk_source_snippet_manager_get_default"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="186">Returns the default #GtkSourceSnippetManager instance.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="38"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="191">a #GtkSourceSnippetManager which
is owned by GtkSourceView library and must not be unref'd.</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</return-value>
</function>
<method name="get_search_path"
c:identifier="gtk_source_snippet_manager_get_search_path"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="276">Gets the list directories where @self looks for snippet files.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="282">%NULL-terminated array
containing a list of snippet files directories.
The array is owned by @lm and must not be modified.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="278">a #GtkSourceSnippetManager.</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_snippet"
c:identifier="gtk_source_snippet_manager_get_snippet"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="394">Queries the known snippets for the first matching @group, @language_id,
and/or @trigger. If @group or @language_id are %NULL, they will be ignored.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="45"/>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="404">a #GtkSourceSnippet or %NULL if no
matching snippet was found.</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="396">a #GtkSourceSnippetManager</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</instance-parameter>
<parameter name="group"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="397">a group name or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="language_id"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="398">a #GtkSourceLanguage:id or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="trigger" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="399">the trigger for the snippet</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="list_groups"
c:identifier="gtk_source_snippet_manager_list_groups"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="337">List all the known groups within the snippet manager.
The result should be freed with g_free(), and the individual strings are
owned by @self and should never be freed by the caller.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="50"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="346">
An array of strings which should be freed with g_free().</doc>
<array c:type="const gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="339">a #GtkSourceSnippetManager</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="list_matching"
c:identifier="gtk_source_snippet_manager_list_matching"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="361">Queries the known snippets for those matching @group, @language_id, and/or
@trigger_prefix. If any of these are %NULL, they will be ignored when
filtering the available snippets.
The #GListModel only contains information about the available snippets until
g_list_model_get_item() is called for a specific snippet. This helps reduce
the number of #GObject's that are created at runtime to those needed by
the calling application.</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="52"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="377">a #GListModel of #GtkSourceSnippet.</doc>
<type name="Gio.ListModel" c:type="GListModel*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="363">a #GtkSourceSnippetManager</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</instance-parameter>
<parameter name="group"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="364">a group name or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="language_id"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="365">a #GtkSourceLanguage:id or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="trigger_prefix"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="366">a prefix for a trigger to activate</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_search_path"
c:identifier="gtk_source_snippet_manager_set_search_path"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="235">Sets the list of directories in which the #GtkSourceSnippetManagerlooks for
snippet files. If @dirs is %NULL, the search path is reset to default.
&lt;note&gt;
&lt;para&gt;
At the moment this function can be called only before the
snippet files are loaded for the first time. In practice
to set a custom search path for a #GtkSourceSnippetManager,
you have to call this function right after creating it.
&lt;/para&gt;
&lt;/note&gt;</doc>
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="237">a #GtkSourceSnippetManager</doc>
<type name="SnippetManager" c:type="GtkSourceSnippetManager*"/>
</instance-parameter>
<parameter name="dirs"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="238">a %NULL-terminated array of
strings or %NULL.</doc>
<array c:type="const gchar* const*">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<property name="search-path"
version="5.0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="161">The "search-path" property contains a list of directories to search
for files containing snippets (*.snippets).</doc>
<array>
<type name="utf8"/>
</array>
</property>
</class>
<record name="SnippetManagerClass"
c:type="GtkSourceSnippetManagerClass"
glib:is-gtype-struct-for="SnippetManager">
<source-position filename="../gtksourceview/gtksourcesnippetmanager.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<bitfield name="SortFlags"
version="3.18"
glib:type-name="GtkSourceSortFlags"
glib:get-type="gtk_source_sort_flags_get_type"
c:type="GtkSourceSortFlags">
<member name="none"
value="0"
c:identifier="GTK_SOURCE_SORT_FLAGS_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="76">no flags specified</doc>
</member>
<member name="case_sensitive"
value="1"
c:identifier="GTK_SOURCE_SORT_FLAGS_CASE_SENSITIVE"
glib:nick="case-sensitive">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="77">case sensitive sort</doc>
</member>
<member name="reverse_order"
value="2"
c:identifier="GTK_SOURCE_SORT_FLAGS_REVERSE_ORDER"
glib:nick="reverse-order">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="78">sort in reverse order</doc>
</member>
<member name="remove_duplicates"
value="4"
c:identifier="GTK_SOURCE_SORT_FLAGS_REMOVE_DUPLICATES"
glib:nick="remove-duplicates">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.h"
line="79">remove duplicates</doc>
</member>
</bitfield>
<class name="SpaceDrawer"
c:symbol-prefix="space_drawer"
c:type="GtkSourceSpaceDrawer"
parent="GObject.Object"
glib:type-name="GtkSourceSpaceDrawer"
glib:get-type="gtk_source_space_drawer_get_type"
glib:type-struct="SpaceDrawerClass">
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="85"/>
<constructor name="new"
c:identifier="gtk_source_space_drawer_new"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="409">Creates a new #GtkSourceSpaceDrawer object. Useful for storing space drawing
settings independently of a #GtkSourceView.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="88"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="415">a new #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</return-value>
</constructor>
<method name="bind_matrix_setting"
c:identifier="gtk_source_space_drawer_bind_matrix_setting"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="678">Binds the #GtkSourceSpaceDrawer:matrix property to a #GSettings key.
The #GSettings key must be of the same type as the
#GtkSourceSpaceDrawer:matrix property, that is, `"au"`.
The g_settings_bind() function cannot be used, because the default GIO
mapping functions don't support #GVariant properties (maybe it will be
supported by a future GIO version, in which case this function can be
deprecated).</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="107"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="680">a #GtkSourceSpaceDrawer object.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
<parameter name="settings" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="681">a #GSettings object.</doc>
<type name="Gio.Settings" c:type="GSettings*"/>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="682">the @settings key to bind.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="683">flags for the binding.</doc>
<type name="Gio.SettingsBindFlags" c:type="GSettingsBindFlags"/>
</parameter>
</parameters>
</method>
<method name="get_enable_matrix"
c:identifier="gtk_source_space_drawer_get_enable_matrix"
version="3.24">
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="102"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="626">whether the #GtkSourceSpaceDrawer:matrix property is enabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="624">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_matrix"
c:identifier="gtk_source_space_drawer_get_matrix"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="494">Gets the value of the #GtkSourceSpaceDrawer:matrix property, as a #GVariant.
An empty array can be returned in case the matrix is a zero matrix.
The gtk_source_space_drawer_get_types_for_locations() function may be more
convenient to use.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="97"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="504">the #GtkSourceSpaceDrawer:matrix value as a new floating #GVariant
instance.</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="496">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_types_for_locations"
c:identifier="gtk_source_space_drawer_get_types_for_locations"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="424">If only one location is specified, this function returns what kind of
white spaces are drawn at that location. The value is retrieved from the
#GtkSourceSpaceDrawer:matrix property.
If several locations are specified, this function returns the logical AND for
those locations. Which means that if a certain kind of white space is present
in the return value, then that kind of white space is drawn at all the
specified @locations.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="90"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="438">a combination of #GtkSourceSpaceTypeFlags.</doc>
<type name="SpaceTypeFlags" c:type="GtkSourceSpaceTypeFlags"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="426">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
<parameter name="locations" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="427">one or several #GtkSourceSpaceLocationFlags.</doc>
<type name="SpaceLocationFlags"
c:type="GtkSourceSpaceLocationFlags"/>
</parameter>
</parameters>
</method>
<method name="set_enable_matrix"
c:identifier="gtk_source_space_drawer_set_enable_matrix"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="637">Sets whether the #GtkSourceSpaceDrawer:matrix property is enabled.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="104"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="639">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
<parameter name="enable_matrix" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="640">the new value.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_matrix"
c:identifier="gtk_source_space_drawer_set_matrix"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="538">Sets a new value to the #GtkSourceSpaceDrawer:matrix property, as a
#GVariant. If @matrix is %NULL, then an empty array is set.
If @matrix is floating, it is consumed.
The gtk_source_space_drawer_set_types_for_locations() function may be more
convenient to use.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="99"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="540">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
<parameter name="matrix"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="541">the new matrix value, or %NULL.</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</method>
<method name="set_types_for_locations"
c:identifier="gtk_source_space_drawer_set_types_for_locations"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="450">Modifies the #GtkSourceSpaceDrawer:matrix property at the specified
@locations.</doc>
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="93"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="drawer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="452">a #GtkSourceSpaceDrawer.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</instance-parameter>
<parameter name="locations" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="453">one or several #GtkSourceSpaceLocationFlags.</doc>
<type name="SpaceLocationFlags"
c:type="GtkSourceSpaceLocationFlags"/>
</parameter>
<parameter name="types" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="454">a combination of #GtkSourceSpaceTypeFlags.</doc>
<type name="SpaceTypeFlags" c:type="GtkSourceSpaceTypeFlags"/>
</parameter>
</parameters>
</method>
<property name="enable-matrix"
version="3.24"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="355">Whether the #GtkSourceSpaceDrawer:matrix property is enabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="matrix"
version="3.24"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="371">The :matrix property is a #GVariant property to specify where and
what kind of white spaces to draw.
The #GVariant is of type `"au"`, an array of unsigned integers. Each
integer is a combination of #GtkSourceSpaceTypeFlags. There is one
integer for each #GtkSourceSpaceLocationFlags, in the same order as
they are defined in the enum (%GTK_SOURCE_SPACE_LOCATION_NONE and
%GTK_SOURCE_SPACE_LOCATION_ALL are not taken into account).
If the array is shorter than the number of locations, then the value
for the missing locations will be %GTK_SOURCE_SPACE_TYPE_NONE.
By default, %GTK_SOURCE_SPACE_TYPE_ALL is set for all locations.</doc>
<type name="GLib.Variant"/>
</property>
</class>
<record name="SpaceDrawerClass"
c:type="GtkSourceSpaceDrawerClass"
glib:is-gtype-struct-for="SpaceDrawer">
<source-position filename="../gtksourceview/gtksourcespacedrawer.h"
line="85"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<bitfield name="SpaceLocationFlags"
version="3.24"
glib:type-name="GtkSourceSpaceLocationFlags"
glib:get-type="gtk_source_space_location_flags_get_type"
c:type="GtkSourceSpaceLocationFlags">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="59">#GtkSourceSpaceLocationFlags contains flags for white space locations.
If a line contains only white spaces (no text), the white spaces match both
%GTK_SOURCE_SPACE_LOCATION_LEADING and %GTK_SOURCE_SPACE_LOCATION_TRAILING.</doc>
<member name="none"
value="0"
c:identifier="GTK_SOURCE_SPACE_LOCATION_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="61">No flags.</doc>
</member>
<member name="leading"
value="1"
c:identifier="GTK_SOURCE_SPACE_LOCATION_LEADING"
glib:nick="leading">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="62">Leading white spaces on a line, i.e. the
indentation.</doc>
</member>
<member name="inside_text"
value="2"
c:identifier="GTK_SOURCE_SPACE_LOCATION_INSIDE_TEXT"
glib:nick="inside-text">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="64">White spaces inside a line of text.</doc>
</member>
<member name="trailing"
value="4"
c:identifier="GTK_SOURCE_SPACE_LOCATION_TRAILING"
glib:nick="trailing">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="65">Trailing white spaces on a line.</doc>
</member>
<member name="all"
value="7"
c:identifier="GTK_SOURCE_SPACE_LOCATION_ALL"
glib:nick="all">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="66">White spaces anywhere.</doc>
</member>
</bitfield>
<bitfield name="SpaceTypeFlags"
version="3.24"
glib:type-name="GtkSourceSpaceTypeFlags"
glib:get-type="gtk_source_space_type_flags_get_type"
c:type="GtkSourceSpaceTypeFlags">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="34">#GtkSourceSpaceTypeFlags contains flags for white space types.</doc>
<member name="none"
value="0"
c:identifier="GTK_SOURCE_SPACE_TYPE_NONE"
glib:nick="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="36">No flags.</doc>
</member>
<member name="space"
value="1"
c:identifier="GTK_SOURCE_SPACE_TYPE_SPACE"
glib:nick="space">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="37">Space character.</doc>
</member>
<member name="tab"
value="2"
c:identifier="GTK_SOURCE_SPACE_TYPE_TAB"
glib:nick="tab">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="38">Tab character.</doc>
</member>
<member name="newline"
value="4"
c:identifier="GTK_SOURCE_SPACE_TYPE_NEWLINE"
glib:nick="newline">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="39">Line break character. If the
#GtkSourceBuffer:implicit-trailing-newline property is %TRUE,
#GtkSourceSpaceDrawer also draws a line break at the end of the buffer.</doc>
</member>
<member name="nbsp"
value="8"
c:identifier="GTK_SOURCE_SPACE_TYPE_NBSP"
glib:nick="nbsp">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="42">Non-breaking space character.</doc>
</member>
<member name="all"
value="15"
c:identifier="GTK_SOURCE_SPACE_TYPE_ALL"
glib:nick="all">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.h"
line="43">All white spaces.</doc>
</member>
</bitfield>
<class name="Style"
c:symbol-prefix="style"
c:type="GtkSourceStyle"
parent="GObject.Object"
glib:type-name="GtkSourceStyle"
glib:get-type="gtk_source_style_get_type"
glib:type-struct="StyleClass">
<source-position filename="../gtksourceview/gtksourcestyle.h" line="35"/>
<method name="apply"
c:identifier="gtk_source_style_apply"
version="3.22">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="515">This function modifies the #GtkTextTag properties that are related to the
#GtkSourceStyle properties. Other #GtkTextTag properties are left untouched.
If @style is non-%NULL, applies @style to @tag.
If @style is %NULL, the related *-set properties of #GtkTextTag are set to
%FALSE.</doc>
<source-position filename="../gtksourceview/gtksourcestyle.h"
line="40"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="style"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="517">a #GtkSourceStyle to apply, or %NULL.</doc>
<type name="Style" c:type="const GtkSourceStyle*"/>
</instance-parameter>
<parameter name="tag" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="518">a #GtkTextTag to apply styles to.</doc>
<type name="Gtk.TextTag" c:type="GtkTextTag*"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="gtk_source_style_copy" version="2.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="480">Creates a copy of @style, that is a new #GtkSourceStyle instance which
has the same attributes set.</doc>
<source-position filename="../gtksourceview/gtksourcestyle.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="487">copy of @style, call g_object_unref()
when you are done with it.</doc>
<type name="Style" c:type="GtkSourceStyle*"/>
</return-value>
<parameters>
<instance-parameter name="style" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="482">a #GtkSourceStyle structure to copy.</doc>
<type name="Style" c:type="const GtkSourceStyle*"/>
</instance-parameter>
</parameters>
</method>
<property name="background"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="background-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="bold"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="bold-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="foreground"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="foreground-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="italic"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="italic-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="line-background"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="line-background-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="pango-underline"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Pango.Underline"/>
</property>
<property name="scale"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="scale-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="strikethrough"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="strikethrough-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="underline-color"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="underline-color-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="underline-set"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
</class>
<record name="StyleClass"
c:type="GtkSourceStyleClass"
glib:is-gtype-struct-for="Style">
<source-position filename="../gtksourceview/gtksourcestyle.h" line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="StyleScheme"
c:symbol-prefix="style_scheme"
c:type="GtkSourceStyleScheme"
parent="GObject.Object"
glib:type-name="GtkSourceStyleScheme"
glib:get-type="gtk_source_style_scheme_get_type"
glib:type-struct="StyleSchemeClass">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="35"/>
<method name="get_authors"
c:identifier="gtk_source_style_scheme_get_authors"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="44"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="348">a
%NULL-terminated array containing the @scheme authors or %NULL if
no author is specified by the style scheme.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="346">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_description"
c:identifier="gtk_source_style_scheme_get_description"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="42"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="332">@scheme description (if defined), or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="330">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_filename"
c:identifier="gtk_source_style_scheme_get_filename"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="46"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="371">@scheme file name if the scheme was created
parsing a style scheme file or %NULL in the other cases.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="369">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_id"
c:identifier="gtk_source_style_scheme_get_id"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="38"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="298">@scheme id.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="296">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="gtk_source_style_scheme_get_name"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="315">@scheme name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="313">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_style"
c:identifier="gtk_source_style_scheme_get_style"
version="2.0">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="48"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="544">style which corresponds to @style_id in
the @scheme, or %NULL when no style with this name found. It is owned by
@scheme and may not be unref'ed.</doc>
<type name="Style" c:type="GtkSourceStyle*"/>
</return-value>
<parameters>
<instance-parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="541">a #GtkSourceStyleScheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</instance-parameter>
<parameter name="style_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="542">id of the style to retrieve.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<property name="description" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="241">Style scheme description, a translatable string to present to the user.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="filename" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="254">Style scheme filename or %NULL.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="id"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="214">Style scheme id, a unique string used to identify the style scheme
in #GtkSourceStyleSchemeManager.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="name" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="228">Style scheme name, a translatable string to present to the user.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
</class>
<interface name="StyleSchemeChooser"
c:symbol-prefix="style_scheme_chooser"
c:type="GtkSourceStyleSchemeChooser"
glib:type-name="GtkSourceStyleSchemeChooser"
glib:get-type="gtk_source_style_scheme_chooser_get_type"
glib:type-struct="StyleSchemeChooserInterface">
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="49"/>
<virtual-method name="get_style_scheme"
invoker="get_style_scheme"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="62">Gets the currently-selected scheme.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="68">the currently-selected scheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</return-value>
<parameters>
<instance-parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="64">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="set_style_scheme"
invoker="set_style_scheme"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="80">Sets the scheme.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="82">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</instance-parameter>
<parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="83">a #GtkSourceStyleScheme</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_style_scheme"
c:identifier="gtk_source_style_scheme_chooser_get_style_scheme"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="62">Gets the currently-selected scheme.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="52"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="68">the currently-selected scheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</return-value>
<parameters>
<instance-parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="64">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_style_scheme"
c:identifier="gtk_source_style_scheme_chooser_set_style_scheme"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="80">Sets the scheme.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="54"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="82">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</instance-parameter>
<parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="83">a #GtkSourceStyleScheme</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</parameter>
</parameters>
</method>
<property name="style-scheme"
version="3.16"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="45">The :style-scheme property contains the currently selected style
scheme. The property can be set to change
the current selection programmatically.</doc>
<type name="StyleScheme"/>
</property>
</interface>
<class name="StyleSchemeChooserButton"
c:symbol-prefix="style_scheme_chooser_button"
c:type="GtkSourceStyleSchemeChooserButton"
parent="Gtk.Button"
glib:type-name="GtkSourceStyleSchemeChooserButton"
glib:get-type="gtk_source_style_scheme_chooser_button_get_type"
glib:type-struct="StyleSchemeChooserButtonClass">
<source-position filename="../gtksourceview/gtksourcestyleschemechooserbutton.h"
line="41"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Actionable"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<implements name="StyleSchemeChooser"/>
<constructor name="new"
c:identifier="gtk_source_style_scheme_chooser_button_new"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserbutton.c"
line="298">Creates a new #GtkSourceStyleSchemeChooserButton.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooserbutton.h"
line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserbutton.c"
line="303">a new #GtkSourceStyleSchemeChooserButton.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
</constructor>
<field name="parent_instance">
<type name="Gtk.Button" c:type="GtkButton"/>
</field>
</class>
<record name="StyleSchemeChooserButtonClass"
c:type="GtkSourceStyleSchemeChooserButtonClass"
glib:is-gtype-struct-for="StyleSchemeChooserButton">
<source-position filename="../gtksourceview/gtksourcestyleschemechooserbutton.h"
line="41"/>
<field name="parent">
<type name="Gtk.ButtonClass" c:type="GtkButtonClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="StyleSchemeChooserInterface"
c:type="GtkSourceStyleSchemeChooserInterface"
glib:is-gtype-struct-for="StyleSchemeChooser">
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="49"/>
<field name="base_interface">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_style_scheme">
<callback name="get_style_scheme">
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="42"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="68">the currently-selected scheme.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</return-value>
<parameters>
<parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="64">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="set_style_scheme">
<callback name="set_style_scheme">
<source-position filename="../gtksourceview/gtksourcestyleschemechooser.h"
line="44"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="chooser" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="82">a #GtkSourceStyleSchemeChooser</doc>
<type name="StyleSchemeChooser"
c:type="GtkSourceStyleSchemeChooser*"/>
</parameter>
<parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="83">a #GtkSourceStyleScheme</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="12">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="StyleSchemeChooserWidget"
c:symbol-prefix="style_scheme_chooser_widget"
c:type="GtkSourceStyleSchemeChooserWidget"
parent="Gtk.Widget"
glib:type-name="GtkSourceStyleSchemeChooserWidget"
glib:get-type="gtk_source_style_scheme_chooser_widget_get_type"
glib:type-struct="StyleSchemeChooserWidgetClass">
<source-position filename="../gtksourceview/gtksourcestyleschemechooserwidget.h"
line="40"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<implements name="StyleSchemeChooser"/>
<constructor name="new"
c:identifier="gtk_source_style_scheme_chooser_widget_new"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserwidget.c"
line="346">Creates a new #GtkSourceStyleSchemeChooserWidget.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschemechooserwidget.h"
line="46"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserwidget.c"
line="351">a new #GtkSourceStyleSchemeChooserWidget.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
</constructor>
<field name="parent_instance">
<type name="Gtk.Widget" c:type="GtkWidget"/>
</field>
</class>
<record name="StyleSchemeChooserWidgetClass"
c:type="GtkSourceStyleSchemeChooserWidgetClass"
glib:is-gtype-struct-for="StyleSchemeChooserWidget">
<source-position filename="../gtksourceview/gtksourcestyleschemechooserwidget.h"
line="40"/>
<field name="parent">
<type name="Gtk.WidgetClass" c:type="GtkWidgetClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<record name="StyleSchemeClass"
c:type="GtkSourceStyleSchemeClass"
glib:is-gtype-struct-for="StyleScheme">
<source-position filename="../gtksourceview/gtksourcestylescheme.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="StyleSchemeManager"
c:symbol-prefix="style_scheme_manager"
c:type="GtkSourceStyleSchemeManager"
parent="GObject.Object"
glib:type-name="GtkSourceStyleSchemeManager"
glib:get-type="gtk_source_style_scheme_manager_get_type"
glib:type-struct="StyleSchemeManagerClass">
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="35"/>
<constructor name="new"
c:identifier="gtk_source_style_scheme_manager_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="177">Creates a new style manager. If you do not need more than one style
manager then use gtk_source_style_scheme_manager_get_default() instead.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="38"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="183">a new #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</return-value>
</constructor>
<function name="get_default"
c:identifier="gtk_source_style_scheme_manager_get_default">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="191">Returns the default #GtkSourceStyleSchemeManager instance.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="40"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="196">a #GtkSourceStyleSchemeManager. Return value
is owned by GtkSourceView library and must not be unref'ed.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</return-value>
</function>
<method name="append_search_path"
c:identifier="gtk_source_style_scheme_manager_append_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="435">Appends @path to the list of directories where the @manager looks for
style scheme files.
See gtk_source_style_scheme_manager_set_search_path() for details.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="45"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="437">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="438">a directory or a filename.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="force_rescan"
c:identifier="gtk_source_style_scheme_manager_force_rescan">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="528">Mark any currently cached information about the available style scehems
as invalid. All the available style schemes will be reloaded next time
the @manager is accessed.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="53"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="530">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scheme"
c:identifier="gtk_source_style_scheme_manager_get_scheme">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="568">Looks up style scheme by id.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="57"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="575">a #GtkSourceStyleScheme object.
The returned value is owned by @manager and must not be unref'ed.</doc>
<type name="StyleScheme" c:type="GtkSourceStyleScheme*"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="570">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
<parameter name="scheme_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="571">style scheme id to find.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_scheme_ids"
c:identifier="gtk_source_style_scheme_manager_get_scheme_ids">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="546">Returns the ids of the available style schemes.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="55"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="552">
a %NULL-terminated array of strings containing the ids of the available
style schemes or %NULL if no style scheme is available.
The array is sorted alphabetically according to the scheme name.
The array is owned by the @manager and must not be modified.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="548">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_search_path"
c:identifier="gtk_source_style_scheme_manager_get_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="506">Returns the current search path for the @manager.
See gtk_source_style_scheme_manager_set_search_path() for details.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="51"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="513">a %NULL-terminated array
of string containing the search path.
The array is owned by the @manager and must not be modified.</doc>
<array c:type="const gchar* const*">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="508">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
</parameters>
</method>
<method name="prepend_search_path"
c:identifier="gtk_source_style_scheme_manager_prepend_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="470">Prepends @path to the list of directories where the @manager looks
for style scheme files.
See gtk_source_style_scheme_manager_set_search_path() for details.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="48"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="472">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="473">a directory or a filename.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_search_path"
c:identifier="gtk_source_style_scheme_manager_set_search_path">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="404">Sets the list of directories where the @manager looks for
style scheme files.
If @path is %NULL, the search path is reset to default.</doc>
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="42"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="406">a #GtkSourceStyleSchemeManager.</doc>
<type name="StyleSchemeManager"
c:type="GtkSourceStyleSchemeManager*"/>
</instance-parameter>
<parameter name="path"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="407">a %NULL-terminated array of
strings or %NULL.</doc>
<array c:type="const gchar* const*">
<type name="utf8" c:type="gchar*"/>
</array>
</parameter>
</parameters>
</method>
<property name="scheme-ids" transfer-ownership="none">
<array>
<type name="utf8"/>
</array>
</property>
<property name="search-path" writable="1" transfer-ownership="none">
<array>
<type name="utf8"/>
</array>
</property>
</class>
<record name="StyleSchemeManagerClass"
c:type="GtkSourceStyleSchemeManagerClass"
glib:is-gtype-struct-for="StyleSchemeManager">
<source-position filename="../gtksourceview/gtksourcestyleschememanager.h"
line="35"/>
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<class name="Tag"
c:symbol-prefix="tag"
c:type="GtkSourceTag"
parent="Gtk.TextTag"
glib:type-name="GtkSourceTag"
glib:get-type="gtk_source_tag_get_type"
glib:type-struct="TagClass">
<source-position filename="../gtksourceview/gtksourcetag.h" line="45"/>
<constructor name="new" c:identifier="gtk_source_tag_new" version="3.20">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="171">Creates a #GtkSourceTag. Configure the tag using object arguments,
i.e. using g_object_set().
For usual cases, gtk_source_buffer_create_source_tag() is more convenient to
use.</doc>
<source-position filename="../gtksourceview/gtksourcetag.h" line="48"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="181">a new #GtkSourceTag.</doc>
<type name="Gtk.TextTag" c:type="GtkTextTag*"/>
</return-value>
<parameters>
<parameter name="name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="173">tag name, or %NULL.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<property name="draw-spaces"
version="3.20"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="125">Whether to draw white spaces. This property takes precedence over the value
defined by the GtkSourceSpaceDrawer's #GtkSourceSpaceDrawer:matrix property
(only where the tag is applied).
Setting this property also changes #GtkSourceTag:draw-spaces-set to
%TRUE.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="draw-spaces-set"
version="3.20"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="146">Whether the #GtkSourceTag:draw-spaces property is set and must be
taken into account.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent_instance">
<type name="Gtk.TextTag" c:type="GtkTextTag"/>
</field>
</class>
<record name="TagClass"
c:type="GtkSourceTagClass"
glib:is-gtype-struct-for="Tag">
<source-position filename="../gtksourceview/gtksourcetag.h" line="45"/>
<field name="parent_class">
<type name="Gtk.TextTagClass" c:type="GtkTextTagClass"/>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="10">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<class name="View"
c:symbol-prefix="view"
c:type="GtkSourceView"
parent="Gtk.TextView"
glib:type-name="GtkSourceView"
glib:get-type="gtk_source_view_get_type"
glib:type-struct="ViewClass">
<source-position filename="../gtksourceview/gtksourceview.h" line="105"/>
<implements name="Gtk.Accessible"/>
<implements name="Gtk.Buildable"/>
<implements name="Gtk.ConstraintTarget"/>
<implements name="Gtk.Scrollable"/>
<constructor name="new" c:identifier="gtk_source_view_new">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2816">Creates a new #GtkSourceView.
By default, an empty #GtkSourceBuffer will be lazily created and can be
retrieved with gtk_text_view_get_buffer().
If you want to specify your own buffer, either override the
#GtkTextViewClass create_buffer factory method, or use
gtk_source_view_new_with_buffer().</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="108"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2828">a new #GtkSourceView.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
</constructor>
<constructor name="new_with_buffer"
c:identifier="gtk_source_view_new_with_buffer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2836">Creates a new #GtkSourceView widget displaying the buffer
@buffer. One buffer can be shared among many widgets.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="110"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2843">a new #GtkSourceView.</doc>
<type name="Gtk.Widget" c:type="GtkWidget*"/>
</return-value>
<parameters>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2838">a #GtkSourceBuffer.</doc>
<type name="Buffer" c:type="GtkSourceBuffer*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="line_mark_activated">
<source-position filename="../gtksourceview/gtksourceview.h"
line="89"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="move_lines">
<source-position filename="../gtksourceview/gtksourceview.h"
line="95"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="down" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="move_words">
<source-position filename="../gtksourceview/gtksourceview.h"
line="97"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="step" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="push_snippet" invoker="push_snippet" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5268">Inserts a new snippet at @location
If another snippet was already active, it will be paused and the new
snippet will become active. Once the focus positions of @snippet have
been exhausted, editing will return to the previous snippet.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="99"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5270">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5271">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</parameter>
<parameter name="location"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5272">a #GtkTextIter or %NULL for the cursor position</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="show_completion">
<source-position filename="../gtksourceview/gtksourceview.h"
line="94"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="get_auto_indent"
c:identifier="gtk_source_view_get_auto_indent">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4143">Returns whether auto-indentation of text is enabled.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="130"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4149">%TRUE if auto indentation is enabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4145">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_background_pattern"
c:identifier="gtk_source_view_get_background_pattern"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5131">Returns the #GtkSourceBackgroundPatternType specifying if and how
the background pattern should be displayed for this @view.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="212"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5138">the #GtkSourceBackgroundPatternType.</doc>
<type name="BackgroundPatternType"
c:type="GtkSourceBackgroundPatternType"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5133">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_completion"
c:identifier="gtk_source_view_get_completion">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4924">Gets the #GtkSourceCompletion associated with @view. The returned object is
guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
object has a different #GtkSourceCompletion.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="197"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4932">the #GtkSourceCompletion associated with @view.</doc>
<type name="Completion" c:type="GtkSourceCompletion*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4926">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_enable_snippets"
c:identifier="gtk_source_view_get_enable_snippets"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5324">Gets the #GtkSourceView:enable-snippets property.
If %TRUE, matching snippets found in the #GtkSourceSnippetManager
may be expanded when the user presses Tab after a word in the
#GtkSourceView.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="192"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5334">%TRUE if enabled</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5326">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_gutter"
c:identifier="gtk_source_view_get_gutter"
version="2.8">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4974">Returns the #GtkSourceGutter object associated with @window_type for @view.
Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported,
respectively corresponding to the left and right gutter. The line numbers
and mark category icons are rendered in the left gutter.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="206"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4986">the #GtkSourceGutter.</doc>
<type name="Gutter" c:type="GtkSourceGutter*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4976">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="window_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4977">the gutter window type.</doc>
<type name="Gtk.TextWindowType" c:type="GtkTextWindowType"/>
</parameter>
</parameters>
</method>
<method name="get_highlight_current_line"
c:identifier="gtk_source_view_get_highlight_current_line">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4342">Returns whether the current line is highlighted.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="153"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4348">%TRUE if the current line is highlighted.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4344">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hover" c:identifier="gtk_source_view_get_hover">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4949">Gets the #GtkSourceHover associated with @view. The returned object is
guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
object has a different #GtkSourceHover.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="199"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4957">a #GtkSourceHover associated with @view.</doc>
<type name="Hover" c:type="GtkSourceHover*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4951">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_indent_on_tab"
c:identifier="gtk_source_view_get_indent_on_tab">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4237">Returns whether when the tab key is pressed the current selection
should get indented instead of replaced with the \t character.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="140"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4244">%TRUE if the selection is indented when tab is pressed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4239">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_indent_width"
c:identifier="gtk_source_view_get_indent_width">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3128">Returns the number of spaces to use for each step of indent.
See gtk_source_view_set_indent_width() for details.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="125"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3135">indent width.</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3130">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_indenter"
c:identifier="gtk_source_view_get_indenter"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5380">Gets the #GtkSourceView:indenter property.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="201"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5386">a #GtkSourceIndenter or %NULL</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5382">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_insert_spaces_instead_of_tabs"
c:identifier="gtk_source_view_get_insert_spaces_instead_of_tabs">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4191">Returns whether when inserting a tabulator character it should
be replaced by a group of space characters.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="135"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4198">%TRUE if spaces are inserted instead of tabs.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4193">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_mark_attributes"
c:identifier="gtk_source_view_get_mark_attributes">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5065">Gets attributes and priority for the @category.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="175"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5073">#GtkSourceMarkAttributes for the @category.
The object belongs to @view, so it must not be unreffed.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5067">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5068">the category.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5069">place where priority of the category will be stored.</doc>
<type name="gint" c:type="gint*"/>
</parameter>
</parameters>
</method>
<method name="get_right_margin_position"
c:identifier="gtk_source_view_get_right_margin_position">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4434">Gets the position of the right margin in the given @view.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="163"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4440">the position of the right margin.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4436">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_show_line_marks"
c:identifier="gtk_source_view_get_show_line_marks"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2921">Returns whether line marks are displayed beside the text.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="168"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2927">%TRUE if the line marks are displayed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2923">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_show_line_numbers"
c:identifier="gtk_source_view_get_show_line_numbers">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2855">Returns whether line numbers are displayed beside the text.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="115"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2861">%TRUE if the line numbers are displayed.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2857">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_show_right_margin"
c:identifier="gtk_source_view_get_show_right_margin">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4388">Returns whether a right margin is displayed.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="158"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4394">%TRUE if the right margin is shown.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4390">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_smart_backspace"
c:identifier="gtk_source_view_get_smart_backspace"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4508">Returns %TRUE if pressing the Backspace key will try to delete spaces
up to the previous tab stop.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="182"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4515">%TRUE if smart Backspace handling is enabled.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4510">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_smart_home_end"
c:identifier="gtk_source_view_get_smart_home_end">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4553">Returns a #GtkSourceSmartHomeEndType end value specifying
how the cursor will move when HOME and END keys are pressed.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="187"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4560">a #GtkSourceSmartHomeEndType value.</doc>
<type name="SmartHomeEndType" c:type="GtkSourceSmartHomeEndType"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4555">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_space_drawer"
c:identifier="gtk_source_view_get_space_drawer"
version="3.24">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5151">Gets the #GtkSourceSpaceDrawer associated with @view. The returned object is
guaranteed to be the same for the lifetime of @view. Each #GtkSourceView
object has a different #GtkSourceSpaceDrawer.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="214"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5159">the #GtkSourceSpaceDrawer associated with @view.</doc>
<type name="SpaceDrawer" c:type="GtkSourceSpaceDrawer*"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5153">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_tab_width"
c:identifier="gtk_source_view_get_tab_width">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3067">Returns the width of tabulation in characters.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="120"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3073">width of tab.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3069">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_visual_column"
c:identifier="gtk_source_view_get_visual_column">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4572">Determines the visual column at @iter taking into consideration the
#GtkSourceView:tab-width of @view.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="194"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4580">the visual column at @iter.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4574">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4575">a position in @view.</doc>
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="indent_lines"
c:identifier="gtk_source_view_indent_lines"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3180">Inserts one indentation level at the beginning of the specified lines. The
empty lines are not indented.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="142"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3182">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3183">#GtkTextIter of the first line to indent</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3184">#GtkTextIter of the last line to indent</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="push_snippet"
c:identifier="gtk_source_view_push_snippet"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5268">Inserts a new snippet at @location
If another snippet was already active, it will be paused and the new
snippet will become active. Once the focus positions of @snippet have
been exhausted, editing will return to the previous snippet.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="216"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5270">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5271">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</parameter>
<parameter name="location"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5272">a #GtkTextIter or %NULL for the cursor position</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<method name="set_auto_indent"
c:identifier="gtk_source_view_set_auto_indent">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4161">If %TRUE auto-indentation of text is enabled.
When Enter is pressed to create a new line, the auto-indentation inserts the
same indentation as the previous line. This is &lt;emphasis&gt;not&lt;/emphasis&gt; a
"smart indentation" where an indentation level is added or removed depending
on the context.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="127"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4163">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4164">whether to enable auto indentation.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_background_pattern"
c:identifier="gtk_source_view_set_background_pattern"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5103">Set if and how the background pattern should be displayed.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="209"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5105">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="background_pattern" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5106">the #GtkSourceBackgroundPatternType.</doc>
<type name="BackgroundPatternType"
c:type="GtkSourceBackgroundPatternType"/>
</parameter>
</parameters>
</method>
<method name="set_enable_snippets"
c:identifier="gtk_source_view_set_enable_snippets"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5348">Sets the #GtkSourceView:enable-snippets property.
If @enable_snippets is %TRUE, matching snippets found in the
#GtkSourceSnippetManager may be expanded when the user presses
Tab after a word in the #GtkSourceView.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="189"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5350">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="enable_snippets" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5351">if snippets should be enabled</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_highlight_current_line"
c:identifier="gtk_source_view_set_highlight_current_line">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4360">If @highlight is %TRUE the current line will be highlighted.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="150"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4362">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="highlight" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4363">whether to highlight the current line.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_indent_on_tab"
c:identifier="gtk_source_view_set_indent_on_tab">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4256">If %TRUE, when the tab key is pressed when several lines are selected, the
selected lines are indented of one level instead of being replaced with a \t
character. Shift+Tab unindents the selection.
If the first or last line is not selected completely, it is also indented or
unindented.
When the selection doesn't span several lines, the tab key always replaces
the selection with a normal \t character.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="137"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4258">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4259">whether to indent a block when tab is pressed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_indent_width"
c:identifier="gtk_source_view_set_indent_width">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3085">Sets the number of spaces to use for each step of indent when the tab key is
pressed. If @width is -1, the value of the #GtkSourceView:tab-width property
will be used.
The #GtkSourceView:indent-width interacts with the
#GtkSourceView:insert-spaces-instead-of-tabs property and
#GtkSourceView:tab-width. An example will be clearer: if the
#GtkSourceView:indent-width is 4 and
#GtkSourceView:tab-width is 8 and
#GtkSourceView:insert-spaces-instead-of-tabs is %FALSE, then pressing the tab
key at the beginning of a line will insert 4 spaces. So far so good. Pressing
the tab key a second time will remove the 4 spaces and insert a \t character
instead (since #GtkSourceView:tab-width is 8). On the other hand, if
#GtkSourceView:insert-spaces-instead-of-tabs is %TRUE, the second tab key
pressed will insert 4 more spaces for a total of 8 spaces in the
#GtkTextBuffer.
The test-widget program (available in the GtkSourceView repository) may be
useful to better understand the indentation settings (enable the space
drawing!).</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="122"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3087">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3088">indent width in characters.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_indenter"
c:identifier="gtk_source_view_set_indenter"
version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5400">Sets the indenter for @view to @indenter.
Note that the indenter will not be used unless #GtkSourceView:auto-indent
has been set to %TRUE.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="203"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5402">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="indenter"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5403">a #GtkSourceIndenter or %NULL</doc>
<type name="Indenter" c:type="GtkSourceIndenter*"/>
</parameter>
</parameters>
</method>
<method name="set_insert_spaces_instead_of_tabs"
c:identifier="gtk_source_view_set_insert_spaces_instead_of_tabs">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4210">If %TRUE a tab key pressed is replaced by a group of space characters. Of
course it is still possible to insert a real \t programmatically with the
#GtkTextBuffer API.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="132"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4212">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="enable" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4213">whether to insert spaces instead of tabs.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_mark_attributes"
c:identifier="gtk_source_view_set_mark_attributes">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5036">Sets attributes and priority for the @category.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="170"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5038">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="category" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5039">the category.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="attributes" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5040">mark attributes.</doc>
<type name="MarkAttributes" c:type="GtkSourceMarkAttributes*"/>
</parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5041">priority of the category.</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="set_right_margin_position"
c:identifier="gtk_source_view_set_right_margin_position">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4452">Sets the position of the right margin in the given @view.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="160"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4454">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="pos" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4455">the width in characters where to position the right margin.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_show_line_marks"
c:identifier="gtk_source_view_set_show_line_marks"
version="2.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2954">If %TRUE line marks will be displayed beside the text.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="165"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2956">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="show" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2957">whether line marks should be displayed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_show_line_numbers"
c:identifier="gtk_source_view_set_show_line_numbers">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2873">If %TRUE line numbers will be displayed beside the text.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="112"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2875">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="show" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="2876">whether line numbers should be displayed.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_show_right_margin"
c:identifier="gtk_source_view_set_show_right_margin">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4406">If %TRUE a right margin is displayed.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="155"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4408">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="show" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4409">whether to show a right margin.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_smart_backspace"
c:identifier="gtk_source_view_set_smart_backspace"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4480">When set to %TRUE, pressing the Backspace key will try to delete spaces
up to the previous tab stop.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="179"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4482">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="smart_backspace" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4483">whether to enable smart Backspace handling.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_smart_home_end"
c:identifier="gtk_source_view_set_smart_home_end">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4529">Set the desired movement of the cursor when HOME and END keys
are pressed.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="184"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4531">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="smart_home_end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="4532">the desired behavior among #GtkSourceSmartHomeEndType.</doc>
<type name="SmartHomeEndType" c:type="GtkSourceSmartHomeEndType"/>
</parameter>
</parameters>
</method>
<method name="set_tab_width"
c:identifier="gtk_source_view_set_tab_width">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3029">Sets the width of tabulation in characters. The #GtkTextBuffer still contains
\t characters, but they can take a different visual width in a #GtkSourceView
widget.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="117"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3031">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="width" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3032">width of tab in characters.</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="unindent_lines"
c:identifier="gtk_source_view_unindent_lines"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3335">Removes one indentation level at the beginning of the
specified lines.</doc>
<source-position filename="../gtksourceview/gtksourceview.h"
line="146"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3337">a #GtkSourceView.</doc>
<type name="View" c:type="GtkSourceView*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3338">#GtkTextIter of the first line to indent</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="3339">#GtkTextIter of the last line to indent</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</method>
<property name="auto-indent" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="background-pattern"
version="3.16"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="743">Draw a specific background pattern on the view.</doc>
<type name="BackgroundPatternType"/>
</property>
<property name="completion" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="546">The completion object associated with the view</doc>
<type name="Completion"/>
</property>
<property name="enable-snippets"
version="5.0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="559">The "enable-snippets" property denotes if snippets should be
expanded when the user presses Tab after having typed a word
matching the snippets found in #GtkSourceSnippetManager.
The user may tab through focus-positions of the snippet if any
are available by pressing Tab repeatedly until the desired focus
position is selected.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="highlight-current-line"
writable="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="indent-on-tab" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="indent-width" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="642">Width of an indentation step expressed in number of spaces.</doc>
<type name="gint" c:type="gint"/>
</property>
<property name="indenter"
version="5.0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="625">The "indenter" property is a #GtkSourceIndenter to use to indent
as the user types into the #GtkSourceView.</doc>
<type name="Indenter"/>
</property>
<property name="insert-spaces-instead-of-tabs"
writable="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="right-margin-position"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="690">Position of the right margin.</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="show-line-marks" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="595">Whether to display line mark pixbufs</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="show-line-numbers"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="581">Whether to display line numbers</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="show-right-margin"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="676">Whether to display the right margin.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="smart-backspace"
version="3.18"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="760">Whether smart Backspace should be used.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="smart-home-end"
version="2.0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="706">Set the behavior of the HOME and END keys.</doc>
<type name="SmartHomeEndType"/>
</property>
<property name="space-drawer" version="3.24" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="776">The #GtkSourceSpaceDrawer object associated with the view.</doc>
<type name="SpaceDrawer"/>
</property>
<property name="tab-width" writable="1" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="609">Width of a tab character expressed in number of spaces.</doc>
<type name="guint" c:type="guint"/>
</property>
<field name="parent_instance">
<type name="Gtk.TextView" c:type="GtkTextView"/>
</field>
<glib:signal name="change-case" when="last" action="1" version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="1002">Keybinding signal to change case of the text at the current cursor position.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="case_type" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="1005">the case to use</doc>
<type name="ChangeCaseType"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="change-number" when="last" action="1" version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="979">Keybinding signal to edit a number at the current cursor position.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="982">the number to add to the number at the current position</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="join-lines" when="last" action="1" version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="1025">Keybinding signal to join the lines currently selected.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="line-mark-activated" when="last">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="820">Emitted when a line mark has been activated (for instance when there
was a button press in the line marks gutter). You can use @iter to
determine on which line the activation took place.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="823">a #GtkTextIter</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="824">the button that was pressed</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="825">the modifier state, if any</doc>
<type name="Gdk.ModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="826">the number of presses</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="move-lines" when="last" action="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="849">The ::move-lines signal is a keybinding which gets emitted
when the user initiates moving a line. The default binding key
is Alt+Up/Down arrow. And moves the currently selected lines,
or the current line up or down by one line.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="down" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="852">%TRUE to move down, %FALSE to move up.</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="move-to-matching-bracket"
when="last"
action="1"
version="3.16">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="955">Keybinding signal to move the cursor to the matching bracket.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="extend_selection" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="958">%TRUE if the move should extend the selection</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="move-words" when="last" action="1" version="3.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="872">The ::move-words signal is a keybinding which gets emitted
when the user initiates moving a word. The default binding key
is Alt+Left/Right Arrow and moves the current selection, or the current
word by one word.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="875">the number of words to move over</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="push-snippet" when="last" version="5.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="897">The ::push-snippet signal is emitted to insert a new snippet into
the view. If another snippet was active, it will be paused until all
focus positions of @snippet have been exhausted.
@location will be updated to point at the end of the snippet.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="900">a #GtkSourceSnippet</doc>
<type name="Snippet"/>
</parameter>
<parameter name="location"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="901">a #GtkTextIter</doc>
<type name="Gtk.TextIter"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="show-completion" when="last" action="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="793">The ::show-completion signal is a key binding signal which gets
emitted when the user requests a completion, by pressing
&lt;keycombo&gt;&lt;keycap&gt;Control&lt;/keycap&gt;&lt;keycap&gt;space&lt;/keycap&gt;&lt;/keycombo&gt;.
This will create a #GtkSourceCompletionContext with the activation
type as %GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name() if they need to activate the completion by
another means, for example with another key binding or a menu entry.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="smart-home-end" when="last" version="3.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="926">Emitted when a the cursor was moved according to the smart home
end setting. The signal is emitted after the cursor is moved, but
during the GtkTextView::move-cursor action. This can be used to find
out whether the cursor was moved by a normal home/end or by a smart
home/end.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="929">a #GtkTextIter</doc>
<type name="Gtk.TextIter"/>
</parameter>
<parameter name="count" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="930">the count</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ViewClass"
c:type="GtkSourceViewClass"
glib:is-gtype-struct-for="View">
<source-position filename="../gtksourceview/gtksourceview.h" line="105"/>
<field name="parent_class">
<type name="Gtk.TextViewClass" c:type="GtkTextViewClass"/>
</field>
<field name="line_mark_activated">
<callback name="line_mark_activated">
<source-position filename="../gtksourceview/gtksourceview.h"
line="89"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="iter" transfer-ownership="none">
<type name="Gtk.TextIter" c:type="const GtkTextIter*"/>
</parameter>
<parameter name="button" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="state" transfer-ownership="none">
<type name="Gdk.ModifierType" c:type="GdkModifierType"/>
</parameter>
<parameter name="n_presses" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="show_completion">
<callback name="show_completion">
<source-position filename="../gtksourceview/gtksourceview.h"
line="94"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="move_lines">
<callback name="move_lines">
<source-position filename="../gtksourceview/gtksourceview.h"
line="95"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="down" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="move_words">
<callback name="move_words">
<source-position filename="../gtksourceview/gtksourceview.h"
line="97"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="step" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="push_snippet">
<callback name="push_snippet">
<source-position filename="../gtksourceview/gtksourceview.h"
line="99"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="view" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5270">a #GtkSourceView</doc>
<type name="View" c:type="GtkSourceView*"/>
</parameter>
<parameter name="snippet" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5271">a #GtkSourceSnippet</doc>
<type name="Snippet" c:type="GtkSourceSnippet*"/>
</parameter>
<parameter name="location"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="5272">a #GtkTextIter or %NULL for the cursor position</doc>
<type name="Gtk.TextIter" c:type="GtkTextIter*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="_reserved" readable="0" private="1">
<array zero-terminated="0" fixed-size="20">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
</record>
<enumeration name="ViewGutterPosition"
glib:type-name="GtkSourceViewGutterPosition"
glib:get-type="gtk_source_view_gutter_position_get_type"
c:type="GtkSourceViewGutterPosition">
<member name="lines"
value="-30"
c:identifier="GTK_SOURCE_VIEW_GUTTER_POSITION_LINES"
glib:nick="lines">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="38">the gutter position of the lines
renderer</doc>
</member>
<member name="marks"
value="-20"
c:identifier="GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS"
glib:nick="marks">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.h"
line="40">the gutter position of the marks
renderer</doc>
</member>
</enumeration>
<docsection name="buffer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcebuffer.c"
line="46">A #GtkSourceBuffer object is the model for #GtkSourceView widgets.
It extends the #GtkTextBuffer class by adding features useful to display
and edit source code such as syntax highlighting and bracket matching.
To create a #GtkSourceBuffer use gtk_source_buffer_new() or
gtk_source_buffer_new_with_language(). The second form is just a convenience
function which allows you to initially set a #GtkSourceLanguage. You can also
directly create a #GtkSourceView and get its #GtkSourceBuffer with
gtk_text_view_get_buffer().
The highlighting is enabled by default, but you can disable it with
gtk_source_buffer_set_highlight_syntax().
# Context Classes # {#context-classes}
It is possible to retrieve some information from the syntax highlighting
engine. The default context classes that are applied to regions of a
#GtkSourceBuffer:
- &lt;emphasis&gt;comment&lt;/emphasis&gt;: the region delimits a comment;
- &lt;emphasis&gt;no-spell-check&lt;/emphasis&gt;: the region should not be spell checked;
- &lt;emphasis&gt;path&lt;/emphasis&gt;: the region delimits a path to a file;
- &lt;emphasis&gt;string&lt;/emphasis&gt;: the region delimits a string.
Custom language definition files can create their own context classes,
since the functions like gtk_source_buffer_iter_has_context_class() take
a string parameter as the context class.
#GtkSourceBuffer provides an API to access the context classes:
gtk_source_buffer_iter_has_context_class(),
gtk_source_buffer_get_context_classes_at_iter(),
gtk_source_buffer_iter_forward_to_context_class_toggle() and
gtk_source_buffer_iter_backward_to_context_class_toggle().
And the #GtkSourceBuffer::highlight-updated signal permits to be notified
when a context class region changes.
Each context class has also an associated #GtkTextTag with the name
&lt;emphasis&gt;gtksourceview:context-classes:&amp;lt;name&amp;gt;&lt;/emphasis&gt;. For example to
retrieve the #GtkTextTag for the string context class, one can write:
|[
GtkTextTagTable *tag_table;
GtkTextTag *tag;
tag_table = gtk_text_buffer_get_tag_table (buffer);
tag = gtk_text_tag_table_lookup (tag_table, "gtksourceview:context-classes:string");
]|
The tag must be used for read-only purposes.
Accessing a context class via the associated #GtkTextTag is less
convenient than the #GtkSourceBuffer API, because:
- The tag doesn't always exist, you need to listen to the
#GtkTextTagTable::tag-added and #GtkTextTagTable::tag-removed signals.
- Instead of the #GtkSourceBuffer::highlight-updated signal, you can listen
to the #GtkTextBuffer::apply-tag and #GtkTextBuffer::remove-tag signals.
A possible use-case for accessing a context class via the associated
#GtkTextTag is to read the region but without adding a hard dependency on the
GtkSourceView library (for example for a spell-checking library that wants to
read the no-spell-check region).</doc>
</docsection>
<docsection name="completion">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletion.c"
line="37">The completion system helps the user when he/she writes some text,
such as words, command names, functions, and suchlike. Proposals can
be shown, to complete the text the user is writing. Each proposal can
contain an additional piece of information (for example
documentation), that is displayed when the "Details" button is
clicked.
Proposals are created via a #GtkSourceCompletionProvider. There can
be for example a provider to complete words (see
#GtkSourceCompletionWords), another provider for the completion of
function names, etc. To add a provider, call
gtk_source_completion_add_provider().
When several providers match, they are all shown in the completion
window, but one can switch between providers: see the
#GtkSourceCompletion::move-page signal. It is also possible to
activate the first proposals with key bindings, see the
#GtkSourceCompletion:accelerators property.
The #GtkSourceCompletionProposal interface represents a proposal.
If a proposal contains extra information (see
%GTK_SOURCE_COMPLETION_COLUMN_DETAILS), it will be
displayed in a supplemental details window, which appears when
the "Details" button is clicked.
Each #GtkSourceView object is associated with a #GtkSourceCompletion
instance. This instance can be obtained with
gtk_source_view_get_completion(). The #GtkSourceView class contains also the
#GtkSourceView::show-completion signal.
A same #GtkSourceCompletionProvider object can be used for several
#GtkSourceCompletion's.</doc>
</docsection>
<docsection name="completioncontext">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletioncontext.c"
line="34">#GtkSourceCompletionContext contains information about an attept to display
completion proposals to the user based on typed text in the #GtkSourceView.
When typing, #GtkSourceCompletion may use registered
#GtkSourceCompletionProvider to determine if there may be results which
could be displayed. If so, a #GtkSourceCompletionContext is created with
information that is provided to the #GtkSourceCompletionProvider to populate
results which might be useful to the user.
#GtkSourceCompletionProvider are expected to provide #GListModel with
#GtkSourceCompletionProposal which may be joined together in a list of
results for the user. They are also responsible for how the contents are
displayed using #GtkSourceCompletionCell which allows for some level of
customization.</doc>
</docsection>
<docsection name="completionproposal">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionproposal.c"
line="26">This interface is used to denote that an object is capable of being
a completion proposal for #GtkSourceCompletion.
Currently, no method or functions are required but additional methods
may be added in the future. Proposals created by
#GtkSourceCompletionProvider can use %G_IMPLEMENT_INTERFACE to
implement this with %NULL for the interface init function.</doc>
</docsection>
<docsection name="completionprovider">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcecompletionprovider.c"
line="29">You must implement this interface to provide proposals to #GtkSourceCompletion
In most cases, implementations of this interface will want to use
#GtkSourceCompletion.populate_async to asynchronously populate the results
to avoid blocking the main loop.</doc>
</docsection>
<docsection name="completionsnippets">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/snippets/gtksourcecompletionsnippets.c"
line="38">The #GtkSourceCompletionSnippets is an example of an implementation of
the #GtkSourceCompletionProvider interface. The proposals are snippets
registered with the #GtkSourceSnippetManager.</doc>
</docsection>
<docsection name="completionwords">
<doc xml:space="preserve"
filename="../gtksourceview/completion-providers/words/gtksourcecompletionwords.c"
line="22">The #GtkSourceCompletionWords is an example of an implementation of
the #GtkSourceCompletionProvider interface. The proposals are words
appearing in the registered #GtkTextBuffer&lt;!-- --&gt;s.</doc>
</docsection>
<docsection name="encoding">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="27">The #GtkSourceEncoding boxed type represents a character encoding. It is used
for example by #GtkSourceFile. Note that the text in GTK+ widgets is always
encoded in UTF-8.</doc>
</docsection>
<function name="encoding_get_all"
c:identifier="gtk_source_encoding_get_all"
moved-to="Encoding.get_all"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="344">Gets all encodings.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="51"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="349">a list of
all #GtkSourceEncoding's. Free with g_slist_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Encoding"/>
</type>
</return-value>
</function>
<function name="encoding_get_current"
c:identifier="gtk_source_encoding_get_current"
moved-to="Encoding.get_current"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="381">Gets the #GtkSourceEncoding for the current locale. See also g_get_charset().</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="49"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="386">the current locale encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
</function>
<function name="encoding_get_default_candidates"
c:identifier="gtk_source_encoding_get_default_candidates"
moved-to="Encoding.get_default_candidates"
version="3.18">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="597">Gets the list of default candidate encodings to try when loading a file. See
gtk_source_file_loader_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.</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="53"/>
<return-value transfer-ownership="container">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="607">the list of
default candidate encodings. Free with g_slist_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Encoding"/>
</type>
</return-value>
</function>
<function name="encoding_get_from_charset"
c:identifier="gtk_source_encoding_get_from_charset"
moved-to="Encoding.get_from_charset"
version="3.14">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="302">Gets a #GtkSourceEncoding from a character set such as "UTF-8" or
"ISO-8859-1".</doc>
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="39"/>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="309">the corresponding #GtkSourceEncoding, or %NULL
if not found.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
<parameters>
<parameter name="charset" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="304">a character set.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="encoding_get_utf8"
c:identifier="gtk_source_encoding_get_utf8"
moved-to="Encoding.get_utf8"
version="3.14">
<source-position filename="../gtksourceview/gtksourceencoding.h"
line="47"/>
<return-value transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceencoding.c"
line="372">the UTF-8 encoding.</doc>
<type name="Encoding" c:type="const GtkSourceEncoding*"/>
</return-value>
</function>
<docsection name="file">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefile.c"
line="26">A #GtkSourceFile object is the on-disk representation of a #GtkSourceBuffer.
With a #GtkSourceFile, you can create and configure a #GtkSourceFileLoader
and #GtkSourceFileSaver which take by default the values of the
#GtkSourceFile properties (except for the file loader which auto-detect some
properties). On a successful load or save operation, the #GtkSourceFile
properties are updated. If an operation fails, the #GtkSourceFile properties
have still the previous valid values.</doc>
</docsection>
<function name="file_loader_error_quark"
c:identifier="gtk_source_file_loader_error_quark"
moved-to="FileLoaderError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="file_saver_error_quark"
c:identifier="gtk_source_file_saver_error_quark"
moved-to="FileSaverError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<docsection name="fileloader">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefileloader.c"
line="35">A #GtkSourceFileLoader object permits to load the contents of a #GFile or a
#GInputStream into a #GtkSourceBuffer.
A file loader should be used only for one load operation, including errors
handling. If an error occurs, you can reconfigure the loader and relaunch the
operation with gtk_source_file_loader_load_async().
Running a #GtkSourceFileLoader is an undoable action for the
#GtkSourceBuffer. That is, gtk_source_buffer_begin_not_undoable_action() and
gtk_source_buffer_end_not_undoable_action() are called, which delete the
undo/redo history.
After a file loading, the buffer is reset to the contents provided by the
#GFile or #GInputStream, so the buffer is set as “unmodified”, that is,
gtk_text_buffer_set_modified() is called with %FALSE. If the contents isn't
saved somewhere (for example if you load from stdin), then you should
probably call gtk_text_buffer_set_modified() with %TRUE after calling
gtk_source_file_loader_load_finish().</doc>
</docsection>
<docsection name="filesaver">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcefilesaver.c"
line="35">A #GtkSourceFileSaver object permits to save a #GtkSourceBuffer into a
#GFile.
A file saver should be used only for one save operation, including errors
handling. If an error occurs, you can reconfigure the saver and relaunch the
operation with gtk_source_file_saver_save_async().</doc>
</docsection>
<function name="finalize" c:identifier="gtk_source_finalize" version="4.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceinit.c"
line="230">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.</doc>
<source-position filename="../gtksourceview/gtksourceinit.h" line="35"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<docsection name="gutter">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutter.c"
line="33">The #GtkSourceGutter object represents the left or right gutter of the text
view. It is used by #GtkSourceView to draw the line numbers and
#GtkSourceMark&lt;!-- --&gt;s that might be present on a line. By packing
additional #GtkSourceGutterRenderer objects in the gutter, you can extend the
gutter with your own custom drawings.
To get a #GtkSourceGutter, use the gtk_source_view_get_gutter() function.
The gutter works very much the same way as cells rendered in a #GtkTreeView.
The concept is similar, with the exception that the gutter does not have an
underlying #GtkTreeModel. The builtin line number renderer is at position
#GTK_SOURCE_VIEW_GUTTER_POSITION_LINES (-30) and the marks renderer is at
#GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS (-20). The gutter sorts the renderers
in ascending order, from left to right. So the marks are displayed on the
right of the line numbers.</doc>
</docsection>
<docsection name="gutterlines">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterlines.c"
line="27">The #GtkSourceGutterLines object is used to collect information about
visible lines.
Use this from your #GtkSourceGutterRenderer::query-data to collect the
necessary information on visible lines. Doing so reduces the number of
passes through the text btree allowing GtkSourceView to reach more
frames-per-second while performing kinetic scrolling.</doc>
</docsection>
<docsection name="gutterrenderer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderer.c"
line="33">A #GtkSourceGutterRenderer represents a column in a #GtkSourceGutter. The
column contains one cell for each visible line of the #GtkTextBuffer. Due to
text wrapping, a cell can thus span multiple lines of the #GtkTextView. In
this case, #GtkSourceGutterRendererAlignmentMode controls the alignment of
the cell.
The gutter renderer is a #GtkWidget and is measured using the normal widget
measurement facilities. The width of the gutter will be determined by the
measurements of the gutter renderers.
The width of a gutter renderer generally takes into account the entire text
buffer. For instance, to display the line numbers, if the buffer contains 100
lines, the gutter renderer will always set its width such as three digits can
be printed, even if only the first 20 lines are shown. Another strategy is to
take into account only the visible lines. In this case, only two digits are
necessary to display the line numbers of the first 20 lines. To take another
example, the gutter renderer for #GtkSourceMark&lt;!-- --&gt;s doesn't need to take
into account the text buffer to announce its width. It only depends on the
icons size displayed in the gutter column.
When the available size to render a cell is greater than the required size to
render the cell contents, the cell contents can be aligned horizontally and
vertically with gtk_source_gutter_renderer_set_alignment().
The cells rendering occurs using gtk_widget_snapshot(). Implementations
should use gtk_source_gutter_renderer_get_lines() to retrieve information
about the lines to be rendered. To help with aligning content which takes
into account the padding and alignment of a cell, implementations may call
gtk_source_gutter_renderer_align_cell() for a given line number with the
width and height measurement of the content they width to render.</doc>
</docsection>
<docsection name="gutterrendererpixbuf">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrendererpixbuf.c"
line="25">A #GtkSourceGutterRendererPixbuf can be used to render an image in a cell of
#GtkSourceGutter.</doc>
</docsection>
<docsection name="gutterrenderertext">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcegutterrenderertext.c"
line="24">A #GtkSourceGutterRendererText can be used to render text in a cell of
#GtkSourceGutter.</doc>
</docsection>
<docsection name="hover">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehover.c"
line="35">#GtkSourceHover allows a #GtkSourceView to provide contextual information.
When enabled, if the user hovers over a word in the text editor, a series
of registered #GtkSourceHoverProvider can populate a #GtkSourceHoverDisplay
with useful information.
To enable call gtk_source_view_get_hover() and add #GtkSourceHoverProvider
using gtk_source_hover_add_provider(). To disable, remove all registered
providers with gtk_source_hover_remove_provider().
You can change how long to wait to display the interactive tooltip by
setting the #GtkSourceHover:hover-delay property in milliseconds.</doc>
</docsection>
<docsection name="hovercontext">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehovercontext.c"
line="30">#GtkSourceHoverContext contains information about the request to populate
contents for a #GtkSourceHoverDisplay.
It can be used to retrieve the #GtkSourceView, #GtkSourceBuffer, and
#GtkTextIter for the regions of text which are being displayed.
Use gtk_source_hover_context_get_bounds() to get the word that was
requested. gtk_source_hover_contents_get_iter() will get you the location
of the pointer when the request was made.</doc>
</docsection>
<docsection name="hoverdisplay">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehoverdisplay.c"
line="26">#GtkSourceHoverDisplay is a #GtkWidget that may be populated with widgets
to be displayed to the user in interactive tooltips. The children widgets
are packed vertically using a #GtkBox.
Implement the #GtkSourceHoverProvider interface to be notified of when
to populate a #GtkSourceHoverDisplay on behalf of the user.</doc>
</docsection>
<docsection name="hoverprovider">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcehoverprovider.c"
line="28">#GtkSourceHoverProvider is an interface that should be implemented to extend
the contents of a #GtkSourceHoverDisplay. This is typical in editors that
interact external tooling such as those utilizing Language Server Protocol.
If you can populate the #GtkSourceHoverDisplay synchronously, use
#GtkSourceHoverProvider.populate. Otherwise, interface implementations that
may take additional time should use #GtkSourceHoverProvider.populate_async
to avoid blocking the main loop.</doc>
</docsection>
<docsection name="indenter">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceindenter.c"
line="27">By default, #GtkSourceView can auto-indent as you type when
#GtkSourceView:auto-indent is enabled. The indentation simply copies the
previous lines indentation.
This can be changed by implementing #GtkSourceIndenter and setting the
#GtkSourceView:indenter property.
Implementors of this interface should implement both
#GtkSourceIndenterInterface.is_trigger and
#GtkSourceIndenterInterface.indent.
#GtkSourceIndenterInterface.is_trigger is called upon key-press to
determine of the key press should trigger an indentation. The default
implementation of the interface checks to see if the key was
%GDK_KEY_Return or %GDK_KEY_KP_Enter without %GDK_SHIFT_MASK set.
#GtkSourceIndenterInterface.indent is called after text has been
inserted into #GtkSourceBuffer when
#GtkSourceIndenterInterface.is_trigger returned %TRUE. The #GtkTextIter
is placed directly after the inserted character or characters.
It may be beneficial to move the insertion mark using
gtk_text_buffer_select_range() depending on how the indenter changes
the indentation.
All changes are encapsulated within a single user action so that the
user may undo them using standard undo/redo accelerators.</doc>
</docsection>
<function name="init" c:identifier="gtk_source_init" version="4.0">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceinit.c"
line="154">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.</doc>
<source-position filename="../gtksourceview/gtksourceinit.h" line="33"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</function>
<docsection name="language">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguage.c"
line="40">A #GtkSourceLanguage represents a programming or markup language, affecting
syntax highlighting and [context classes][context-classes].
Use #GtkSourceLanguageManager to obtain a #GtkSourceLanguage instance, and
gtk_source_buffer_set_language() to apply it to a #GtkSourceBuffer.</doc>
</docsection>
<docsection name="languagemanager">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcelanguagemanager.c"
line="30">#GtkSourceLanguageManager is an object which processes language description
files and creates and stores #GtkSourceLanguage objects, and provides API to
access them.
Use gtk_source_language_manager_get_default() to retrieve the default
instance of #GtkSourceLanguageManager, and
gtk_source_language_manager_guess_language() to get a #GtkSourceLanguage for
given file name and content type.</doc>
</docsection>
<docsection name="map">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemap.c"
line="41">#GtkSourceMap is a widget that maps the content of a #GtkSourceView into
a smaller view so the user can have a quick overview of the whole document.
This works by connecting a #GtkSourceView to to the #GtkSourceMap using
the #GtkSourceMap:view property or gtk_source_map_set_view().
#GtkSourceMap is a #GtkSourceView object. This means that you can add a
#GtkSourceGutterRenderer to a gutter in the same way you would for a
#GtkSourceView. One example might be a #GtkSourceGutterRenderer that shows
which lines have changed in the document.
Additionally, it is desirable to match the font of the #GtkSourceMap and
the #GtkSourceView used for editing. Therefore, #GtkSourceMap:font-desc
should be used to set the target font. You will need to adjust this to the
desired font size for the map. A 1pt font generally seems to be an
appropriate font size. "Monospace 1" is the default. See
pango_font_description_set_size() for how to alter the size of an existing
#PangoFontDescription.
When FontConfig is available, #GtkSourceMap will try to use a bundled
"block" font to make the map more legible.</doc>
</docsection>
<docsection name="mark">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemark.c"
line="26">A #GtkSourceMark marks a position in the text where you want to display
additional info. It is based on #GtkTextMark and thus is still valid after
the text has changed though its position may change.
#GtkSourceMark&lt;!-- --&gt;s are organised in categories which you have to set
when you create the mark. Each category can have a priority, a pixbuf and
other associated attributes. See gtk_source_view_set_mark_attributes().
The pixbuf will be displayed in the margin at the line where the mark
residents if the #GtkSourceView:show-line-marks property is set to %TRUE. If
there are multiple marks in the same line, the pixbufs will be drawn on top
of each other. The mark with the highest priority will be drawn on top.</doc>
</docsection>
<docsection name="markattributes">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcemarkattributes.c"
line="28">#GtkSourceMarkAttributes is an object specifying attributes used by
a #GtkSourceView to visually show lines marked with #GtkSourceMark&lt;!-- --&gt;s
of a specific category. It allows you to define a background color of a line,
an icon shown in gutter and tooltips.
The background color is used as a background of a line where a mark is placed
and it can be set with gtk_source_mark_attributes_set_background(). To check
if any custom background color was defined and what color it is, use
gtk_source_mark_attributes_get_background().
An icon is a graphic element which is shown in the gutter of a view. An
example use is showing a red filled circle in a debugger to show that a
breakpoint was set in certain line. To get an icon that will be placed in
a gutter, first a base for it must be specified and then
gtk_source_mark_attributes_render_icon() must be called.
There are several ways to specify a base for an icon:
&lt;itemizedlist&gt;
&lt;listitem&gt;
&lt;para&gt;
gtk_source_mark_attributes_set_icon_name()
&lt;/para&gt;
&lt;/listitem&gt;
&lt;listitem&gt;
&lt;para&gt;
gtk_source_mark_attributes_set_gicon()
&lt;/para&gt;
&lt;/listitem&gt;
&lt;listitem&gt;
&lt;para&gt;
gtk_source_mark_attributes_set_pixbuf()
&lt;/para&gt;
&lt;/listitem&gt;
&lt;/itemizedlist&gt;
Using any of the above functions overrides the one used earlier. But note
that a getter counterpart of earlier used function can still return some
value, but it is just not used when rendering the proper icon.
To provide meaningful tooltips for a given mark of a category, you should
connect to #GtkSourceMarkAttributes::query-tooltip-text or
#GtkSourceMarkAttributes::query-tooltip-markup where the latter
takes precedence.</doc>
</docsection>
<docsection name="printcompositor">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceprintcompositor.c"
line="35">The #GtkSourcePrintCompositor object is used to compose a #GtkSourceBuffer
for printing. You can set various configuration options to customize the
printed output. #GtkSourcePrintCompositor is designed to be used with the
high-level printing API of gtk+, i.e. #GtkPrintOperation.
The margins specified in this object are the layout margins: they define the
blank space bordering the printed area of the pages. They must not be
confused with the "print margins", i.e. the parts of the page that the
printer cannot print on, defined in the #GtkPageSetup objects. If the
specified layout margins are smaller than the "print margins", the latter
ones are used as a fallback by the #GtkSourcePrintCompositor object, so that
the printed area is not clipped.</doc>
</docsection>
<docsection name="region">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceregion.c"
line="25">A #GtkSourceRegion permits to store a group of subregions of a
#GtkTextBuffer. #GtkSourceRegion stores the subregions with pairs of
#GtkTextMark's, so the region is still valid after insertions and deletions
in the #GtkTextBuffer.
The #GtkTextMark for the start of a subregion has a left gravity, while the
#GtkTextMark for the end of a subregion has a right gravity.
The typical use-case of #GtkSourceRegion is to scan a #GtkTextBuffer chunk by
chunk, not the whole buffer at once to not block the user interface. The
#GtkSourceRegion represents in that case the remaining region to scan. You
can listen to the #GtkTextBuffer::insert-text and
#GtkTextBuffer::delete-range signals to update the #GtkSourceRegion
accordingly.
To iterate through the subregions, you need to use a #GtkSourceRegionIter,
for example:
|[
GtkSourceRegion *region;
GtkSourceRegionIter region_iter;
gtk_source_region_get_start_region_iter (region, &amp;region_iter);
while (!gtk_source_region_iter_is_end (&amp;region_iter))
{
GtkTextIter subregion_start;
GtkTextIter subregion_end;
if (!gtk_source_region_iter_get_subregion (&amp;region_iter,
&amp;subregion_start,
&amp;subregion_end))
{
break;
}
// Do something useful with the subregion.
gtk_source_region_iter_next (&amp;region_iter);
}
]|</doc>
</docsection>
<function name="scheduler_add"
c:identifier="gtk_source_scheduler_add"
version="5.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="230">Simplified version of gtk_source_scheduler_add_full().</doc>
<source-position filename="../gtksourceview/gtksourcescheduler.h"
line="55"/>
<return-value transfer-ownership="none">
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="232">the callback to execute</doc>
<type name="SchedulerCallback" c:type="GtkSourceSchedulerCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="233">user data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="scheduler_add_full"
c:identifier="gtk_source_scheduler_add_full"
version="5.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="246">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 g_get_monotonic_time() for comparison.
Use gtk_source_scheduler_remove() to remove the handler.</doc>
<source-position filename="../gtksourceview/gtksourcescheduler.h"
line="58"/>
<return-value transfer-ownership="none">
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="248">the callback to execute</doc>
<type name="SchedulerCallback" c:type="GtkSourceSchedulerCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="249">user data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="notify" transfer-ownership="none" scope="async">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="250">closure notify for @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</function>
<function name="scheduler_remove"
c:identifier="gtk_source_scheduler_remove"
version="5.2">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="285">Removes a scheduler callback previously registered with
gtk_source_scheduler_add() or gtk_source_scheduler_add_full().</doc>
<source-position filename="../gtksourceview/gtksourcescheduler.h"
line="62"/>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="handler_id" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcescheduler.c"
line="287">the handler id</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</function>
<docsection name="searchcontext">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchcontext.c"
line="38">A #GtkSourceSearchContext is used for the search and replace in a
#GtkSourceBuffer. The search settings are represented by a
#GtkSourceSearchSettings object. There can be a many-to-many relationship
between buffers and search settings, with the search contexts in-between: a
search settings object can be shared between several search contexts; and a
buffer can contain several search contexts at the same time.
The total number of search occurrences can be retrieved with
gtk_source_search_context_get_occurrences_count(). To know the position of a
certain match, use gtk_source_search_context_get_occurrence_position().
The buffer is scanned asynchronously, so it doesn't block the user interface.
For each search, the buffer is scanned at most once. After that, navigating
through the occurrences doesn't require to re-scan the buffer entirely.
To search forward, use gtk_source_search_context_forward() or
gtk_source_search_context_forward_async() for the asynchronous version.
The backward search is done similarly. To replace a search match, or all
matches, use gtk_source_search_context_replace() and
gtk_source_search_context_replace_all().
The search occurrences are highlighted by default. To disable it, use
gtk_source_search_context_set_highlight(). You can enable the search
highlighting for several #GtkSourceSearchContext&lt;!-- --&gt;s attached to the
same buffer. Moreover, each of those #GtkSourceSearchContext&lt;!-- --&gt;s can
have a different text style associated. Use
gtk_source_search_context_set_match_style() to specify the #GtkSourceStyle
to apply on search matches.
Note that the #GtkSourceSearchContext:highlight and
#GtkSourceSearchContext:match-style properties are in the
#GtkSourceSearchContext class, not #GtkSourceSearchSettings. Appearance
settings should be tied to one, and only one buffer, as different buffers can
have different style scheme associated (a #GtkSourceSearchSettings object
can be bound indirectly to several buffers).
The concept of "current match" doesn't exist yet. A way to highlight
differently the current match is to select it.
A search occurrence's position doesn't depend on the cursor position or other
parameters. Take for instance the buffer "aaaa" with the search text "aa".
The two occurrences are at positions [0:2] and [2:4]. If you begin to search
at position 1, you will get the occurrence [2:4], not [1:3]. This is a
prerequisite for regular expression searches. The pattern ".*" matches the
entire line. If the cursor is at the middle of the line, you don't want the
rest of the line as the occurrence, you want an entire line. (As a side note,
regular expression searches can also match multiple lines.)
In the GtkSourceView source code, there is an example of how to use the
search and replace API: see the tests/test-search.c file. It is a mini
application for the search and replace, with a basic user interface.</doc>
</docsection>
<docsection name="searchsettings">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesearchsettings.c"
line="24">A #GtkSourceSearchSettings object represents the settings of a search. The
search settings can be associated with one or several
#GtkSourceSearchContext&lt;!-- --&gt;s.</doc>
</docsection>
<docsection name="snippet">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippet.c"
line="30">The #GtkSourceSnippet represents a series of chunks that can quickly be
inserted into the #GtkSourceView.
Snippets are defined in XML files which are loaded by the
#GtkSourceSnippetManager. Alternatively, applications can create snippets
on demand and insert them into the #GtkSourceView using
gtk_source_view_push_snippet().
Snippet chunks can reference other snippet chunks as well as post-process
the values from other chunks such as capitalization.</doc>
</docsection>
<docsection name="snippetchunk">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetchunk.c"
line="25">The #GtkSourceSnippetChunk represents a single chunk of text that
may or may not be an edit point within the snippet. Chunks that are
an edit point (also called a tab stop) have the
#GtkSourceSnippetChunk:focus-position property set.</doc>
</docsection>
<docsection name="snippetcontext">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetcontext.c"
line="28">This class is currently used primary as a hashtable. However, the longer
term goal is to have it hold onto a GjsContext as well as other languages
so that #GtkSourceSnippetChunk can expand themselves by executing
script within the context.
The #GtkSourceSnippet will build the context and then expand each of the
chunks during the insertion/edit phase.</doc>
</docsection>
<docsection name="snippetmanager">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcesnippetmanager.c"
line="27">#GtkSourceSnippetManager is an object which processes snippet description
files and creates #GtkSourceSnippet objects.
Use gtk_source_snippet_manager_get_default() to retrieve the default
instance of #GtkSourceSnippetManager.
Use gtk_source_snippet_manager_get_snippets() to retrieve snippets for
a given snippets.</doc>
</docsection>
<docsection name="spacedrawer">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcespacedrawer.c"
line="38">#GtkSourceSpaceDrawer provides a way to visualize white spaces, by drawing
symbols.
Call gtk_source_view_get_space_drawer() to get the #GtkSourceSpaceDrawer
instance of a certain #GtkSourceView.
By default, no white spaces are drawn because the
#GtkSourceSpaceDrawer:enable-matrix is %FALSE.
To draw white spaces, gtk_source_space_drawer_set_types_for_locations() can
be called to set the #GtkSourceSpaceDrawer:matrix property (by default all
space types are enabled at all locations). Then call
gtk_source_space_drawer_set_enable_matrix().
For a finer-grained method, there is also the GtkSourceTag's
#GtkSourceTag:draw-spaces property.
# Example
To draw non-breaking spaces everywhere and draw all types of trailing spaces
except newlines:
|[
gtk_source_space_drawer_set_types_for_locations (space_drawer,
GTK_SOURCE_SPACE_LOCATION_ALL,
GTK_SOURCE_SPACE_TYPE_NBSP);
gtk_source_space_drawer_set_types_for_locations (space_drawer,
GTK_SOURCE_SPACE_LOCATION_TRAILING,
GTK_SOURCE_SPACE_TYPE_ALL &amp;
~GTK_SOURCE_SPACE_TYPE_NEWLINE);
gtk_source_space_drawer_set_enable_matrix (space_drawer, TRUE);
]|
# Use-case: draw unwanted white spaces
A possible use-case is to draw only unwanted white spaces. Examples:
- Draw all trailing spaces.
- If the indentation and alignment must be done with spaces, draw tabs.
And non-breaking spaces can always be drawn, everywhere, to distinguish them
from normal spaces.</doc>
</docsection>
<docsection name="style">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyle.c"
line="25">The #GtkSourceStyle structure is used to describe text attributes
which are set when given style is used.</doc>
</docsection>
<docsection name="stylescheme">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestylescheme.c"
line="34">#GtkSourceStyleScheme contains all the text styles to be used in
#GtkSourceView and #GtkSourceBuffer. For instance, it contains text styles
for syntax highlighting, it may contain foreground and background color for
non-highlighted text, color for the line numbers, current line highlighting,
bracket matching, etc.
Style schemes are stored in XML files. The format of a scheme file is
documented in the [style scheme reference][style-reference].
The two style schemes with IDs "classic" and "tango" follow more closely the
GTK+ theme (for example for the background color).</doc>
</docsection>
<docsection name="styleschemechooser">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooser.c"
line="25">#GtkSourceStyleSchemeChooser is an interface that is implemented by widgets
for choosing style schemes.
In GtkSourceView, the main widgets that implement this interface are
#GtkSourceStyleSchemeChooserWidget and #GtkSourceStyleSchemeChooserButton.</doc>
</docsection>
<docsection name="styleschemechooserbutton">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserbutton.c"
line="30">The #GtkSourceStyleSchemeChooserButton is a button which displays
the currently selected style scheme and allows to open a style scheme
selection dialog to change the style scheme.
It is suitable widget for selecting a style scheme in a preference dialog.
In #GtkSourceStyleSchemeChooserButton, a #GtkSourceStyleSchemeChooserWidget
is used to provide a dialog for selecting style schemes.</doc>
</docsection>
<docsection name="styleschemechooserwidget">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschemechooserwidget.c"
line="32">The #GtkSourceStyleSchemeChooserWidget widget lets the user select a
style scheme. By default, the chooser presents a predefined list
of style schemes.
To change the initially selected style scheme,
use gtk_source_style_scheme_chooser_set_style_scheme().
To get the selected style scheme
use gtk_source_style_scheme_chooser_get_style_scheme().</doc>
</docsection>
<docsection name="styleschememanager">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcestyleschememanager.c"
line="28">Object which provides access to #GtkSourceStyleScheme&lt;!-- --&gt;s.</doc>
</docsection>
<docsection name="tag">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourcetag.c"
line="26">#GtkSourceTag is a subclass of #GtkTextTag that adds properties useful for
the GtkSourceView library.
If, for a certain tag, #GtkTextTag is sufficient, it's better that you create
a #GtkTextTag, not a #GtkSourceTag.</doc>
</docsection>
<docsection name="utils">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="23">Utility functions.</doc>
</docsection>
<function name="utils_escape_search_text"
c:identifier="gtk_source_utils_escape_search_text"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="132">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: gtk_source_utils_unescape_search_text().
&lt;warning&gt;
Warning: the escape and unescape functions are not reciprocal! For example,
escape (unescape (\)) = \\. So avoid cycles such as: search entry -&gt; unescape
-&gt; search settings -&gt; escape -&gt; search entry. The original search entry text
may be modified.
&lt;/warning&gt;</doc>
<source-position filename="../gtksourceview/gtksourceutils.h" line="35"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="153">the escaped @text.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="134">the text to escape.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<function name="utils_unescape_search_text"
c:identifier="gtk_source_utils_unescape_search_text"
version="3.10">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="40">Use this function before gtk_source_search_settings_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: gtk_source_utils_escape_search_text().</doc>
<source-position filename="../gtksourceview/gtksourceutils.h" line="33"/>
<return-value transfer-ownership="full">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="53">the unescaped @text.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceutils.c"
line="42">the text to unescape.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
<docsection name="view">
<doc xml:space="preserve"
filename="../gtksourceview/gtksourceview.c"
line="59">#GtkSourceView is the main class of the GtkSourceView library.
Use a #GtkSourceBuffer to display text with a #GtkSourceView.
This class provides:
- Show the line numbers;
- Show a right margin;
- Highlight the current line;
- Indentation settings;
- Configuration for the Home and End keyboard keys;
- Configure and show line marks;
- And a few other things.
An easy way to test all these features is to use the test-widget mini-program
provided in the GtkSourceView repository, in the tests/ directory.
# GtkSourceView as GtkBuildable
The GtkSourceView implementation of the #GtkBuildable interface exposes the
#GtkSourceView:completion object with the internal-child "completion".
An example of a UI definition fragment with GtkSourceView:
|[
&lt;object class="GtkSourceView" id="source_view"&gt;
&lt;property name="tab_width"&gt;4&lt;/property&gt;
&lt;property name="auto_indent"&gt;True&lt;/property&gt;
&lt;child internal-child="completion"&gt;
&lt;object class="GtkSourceCompletion"&gt;
&lt;property name="select_on_show"&gt;False&lt;/property&gt;
&lt;/object&gt;
&lt;/child&gt;
&lt;/object&gt;
]|
# Changing the Font
Gtk CSS provides the best way to change the font for a #GtkSourceView in a
manner that allows for components like #GtkSourceMap to scale the desired
font.
|[
GtkCssProvider *provider = gtk_css_provider_new ();
gtk_css_provider_load_from_data (provider,
"textview { font-family: Monospace; font-size: 8pt; }",
-1,
NULL);
gtk_style_context_add_provider (gtk_widget_get_style_context (view),
GTK_STYLE_PROVIDER (provider),
GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
g_object_unref (provider);
]|
If you need to adjust the font or size of font within a portion of the
document only, you should use a #GtkTextTag with the #GtkTextTag:family or
#GtkTextTag:scale set so that the font size may be scaled relative to
the default font set in CSS.</doc>
</docsection>
</namespace>
</repository>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment