RubyGems - gtksourceview4 - Versions diffs - 3.2.9-x64-mingw32 - Mend

gtksourceview4 3.2.9-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (379) hide show

data/vendor/local/share/gtk-doc/html/gtksourceview-4.0/GtkSourceCompletionContext.html ADDED

@@ -0,0 +1,402 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GtkSourceCompletionContext: GtkSourceView 4 Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
+<link rel="home" href="index.html" title="GtkSourceView 4 Reference Manual">
+<link rel="up" href="completion.html" title="Completion">
+<link rel="prev" href="GtkSourceCompletion.html" title="GtkSourceCompletion">
+<link rel="next" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo">
+<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionContext.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionContext.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionContext.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionContext.signals" class="shortcut">Signals</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="completion.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="GtkSourceCompletion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="GtkSourceCompletionInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="GtkSourceCompletionContext"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GtkSourceCompletionContext.top_of_page"></a>GtkSourceCompletionContext</span></h2>
+<p>GtkSourceCompletionContext — The context of a completion</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="GtkSourceCompletionContext.html#gtk-source-completion-context-add-proposals" title="gtk_source_completion_context_add_proposals ()">gtk_source_completion_context_add_proposals</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="GtkSourceCompletionContext.html#gtk-source-completion-context-get-iter" title="gtk_source_completion_context_get_iter ()">gtk_source_completion_context_get_iter</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="GtkSourceCompletionContext.html#gtk-source-completion-context-get-activation" title="gtk_source_completion_context_get_activation ()">gtk_source_completion_context_get_activation</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table class="informaltable" border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a></td>
+<td class="property_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext--activation" title="The “activation” property">activation</a></td>
+<td class="property_flags">Read / Write / Construct</td>
+</tr>
+<tr>
+<td class="property_type">
+<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *</td>
+<td class="property_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext--completion" title="The “completion” property">completion</a></td>
+<td class="property_flags">Read / Write / Construct Only</td>
+</tr>
+<tr>
+<td class="property_type">
+<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *</td>
+<td class="property_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext--iter" title="The “iter” property">iter</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.signals"></a><h2>Signals</h2>
+<div class="informaltable"><table class="informaltable" border="0">
+<colgroup>
+<col width="150px" class="signals_return">
+<col width="300px" class="signals_name">
+<col width="200px" class="signals_flags">
+</colgroup>
+<tbody><tr>
+<td class="signal_type"><span class="returnvalue">void</span></td>
+<td class="signal_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext-cancelled" title="The “cancelled” signal">cancelled</a></td>
+<td class="signal_flags"><a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation">GtkSourceCompletionActivation</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext-struct" title="GtkSourceCompletionContext">GtkSourceCompletionContext</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
+    <span class="lineart">╰──</span> GtkSourceCompletionActivation
+    <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
+    <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+        <span class="lineart">╰──</span> GtkSourceCompletionContext
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.includes"></a><h2>Includes</h2>
+<pre class="synopsis">#include &lt;gtksourceview/gtksource.h&gt;
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.description"></a><h2>Description</h2>
+<p>Initially, the completion window is hidden. For a completion to occur, it has
+to be activated. The different possible activations are listed in
+<a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a>. When an activation occurs, a
+<a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> object is created, and the eligible providers are
+asked to add proposals with <a class="link" href="GtkSourceCompletionContext.html#gtk-source-completion-context-add-proposals" title="gtk_source_completion_context_add_proposals ()"><code class="function">gtk_source_completion_context_add_proposals()</code></a>.</p>
+<p>If no proposals are added, the completion window remains hidden, and the
+context is destroyed.</p>
+<p>On the other hand, if proposals are added, the completion window becomes
+visible, and the user can choose a proposal. If the user is not happy with
+the shown proposals, he or she can insert or delete characters, to modify the
+completion context and therefore hoping to see the proposal he or she wants.
+This means that when an insertion or deletion occurs in the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextBuffer.html#GtkTextBuffer-struct"><span class="type">GtkTextBuffer</span></a>
+when the completion window is visible, the eligible providers are again asked
+to add proposals. The <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionContext--activation" title="The “activation” property"><span class="type">“activation”</span></a> remains the
+same in this case.</p>
+<p>When the completion window is hidden, the interactive completion is triggered
+only on insertion in the buffer, not on deletion. Once the completion window
+is visible, then on each insertion or deletion, there is a new population and
+the providers are asked to add proposals. If there are no more proposals, the
+completion window disappears. So if you want to keep the completion window
+visible, but there are no proposals, you can insert a dummy proposal named
+"No proposals". For example, the user types progressively the name of
+a function, and some proposals appear. The user types a bad character and
+there are no proposals anymore. What the user wants is to delete the last
+character, and see the previous proposals. If the completion window
+disappears, the previous proposals will not reappear on the character
+deletion.</p>
+<p>A <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> is associated with the context, this is where the completion
+takes place. With this <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a>, you can get the associated
+<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextBuffer.html#GtkTextBuffer-struct"><span class="type">GtkTextBuffer</span></a> with <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#gtk-text-iter-get-buffer"><code class="function">gtk_text_iter_get_buffer()</code></a>.</p>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gtk-source-completion-context-add-proposals"></a><h3>gtk_source_completion_context_add_proposals ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+gtk_source_completion_context_add_proposals
+                               (<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
+                                <em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
+                                <em class="parameter"><code><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *proposals</code></em>,
+                                <em class="parameter"><code><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> finished</code></em>);</pre>
+<p>Providers can use this function to add proposals to the completion. They
+can do so asynchronously by means of the <em class="parameter"><code>finished</code></em>
+ argument. Providers must
+ensure that they always call this function with <em class="parameter"><code>finished</code></em>
+ set to <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
+once each population (even if no proposals need to be added).
+Population occurs when the <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-populate" title="gtk_source_completion_provider_populate ()"><code class="function">gtk_source_completion_provider_populate()</code></a>
+function is called.</p>
+<div class="refsect3">
+<a name="gtk-source-completion-context-add-proposals.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>context</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>provider</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>proposals</p></td>
+<td class="parameter_description"><p>The list of proposals to add. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkSource.CompletionProposal]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>finished</p></td>
+<td class="parameter_description"><p>Whether the provider is finished adding proposals.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-source-completion-context-get-iter"></a><h3>gtk_source_completion_context_get_iter ()</h3>
+<pre class="programlisting"><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+gtk_source_completion_context_get_iter
+                               (<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
+                                <em class="parameter"><code><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
+<p>Get the iter at which the completion was invoked. Providers can use this
+to determine how and if to match proposals.</p>
+<div class="refsect3">
+<a name="gtk-source-completion-context-get-iter.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>context</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gtk-source-completion-context-get-iter.returns"></a><h4>Returns</h4>
+<p> <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>iter</code></em>
+is correctly set, <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-source-completion-context-get-activation"></a><h3>gtk_source_completion_context_get_activation ()</h3>
+<pre class="programlisting"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a>
+gtk_source_completion_context_get_activation
+                               (<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
+<p>Get the context activation.</p>
+<div class="refsect3">
+<a name="gtk-source-completion-context-get-activation.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>context</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gtk-source-completion-context-get-activation.returns"></a><h4>Returns</h4>
+<p> The context activation.</p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GtkSourceCompletionActivation"></a><h3>enum GtkSourceCompletionActivation</h3>
+<div class="refsect3">
+<a name="GtkSourceCompletionActivation.members"></a><h4>Members</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="300px" class="enum_members_name">
+<col class="enum_members_description">
+<col width="200px" class="enum_members_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="enum_member_name"><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-NONE:CAPS"></a>GTK_SOURCE_COMPLETION_ACTIVATION_NONE</p></td>
+<td class="enum_member_description">
+<p>None.</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-INTERACTIVE:CAPS"></a>GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE</p></td>
+<td class="enum_member_description">
+<p>Interactive activation. By
+default, it occurs on each insertion in the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextBuffer.html#GtkTextBuffer-struct"><span class="type">GtkTextBuffer</span></a>. This can be
+blocked temporarily with <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-block-interactive" title="gtk_source_completion_block_interactive ()"><code class="function">gtk_source_completion_block_interactive()</code></a>.</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-USER-REQUESTED:CAPS"></a>GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED</p></td>
+<td class="enum_member_description">
+<p>User requested activation.
+By default, it occurs when the user presses</p>
+<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>space</strong></span>.
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkSourceCompletionContext-struct"></a><h3>GtkSourceCompletionContext</h3>
+<pre class="programlisting">typedef struct _GtkSourceCompletionContext GtkSourceCompletionContext;</pre>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GtkSourceCompletionContext--activation"></a><h3>The <code class="literal">“activation”</code> property</h3>
+<pre class="programlisting">  “activation”               <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a></pre>
+<p>The completion activation</p>
+<p>Flags: Read / Write / Construct</p>
+<p>Default value: GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkSourceCompletionContext--completion"></a><h3>The <code class="literal">“completion”</code> property</h3>
+<pre class="programlisting">  “completion”               <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *</pre>
+<p>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> associated with the context.</p>
+<p>Flags: Read / Write / Construct Only</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GtkSourceCompletionContext--iter"></a><h3>The <code class="literal">“iter”</code> property</h3>
+<pre class="programlisting">  “iter”                     <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *</pre>
+<p>The <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> at which the completion is invoked.</p>
+<p>Flags: Read / Write</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionContext.signal-details"></a><h2>Signal Details</h2>
+<div class="refsect2">
+<a name="GtkSourceCompletionContext-cancelled"></a><h3>The <code class="literal">“cancelled”</code> signal</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+user_function (<a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *sourcecompletioncontext,
+               <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                    user_data)</pre>
+<p>Emitted when the current population of proposals has been cancelled.
+Providers adding proposals asynchronously should connect to this signal
+to know when to cancel running proposal queries.</p>
+<div class="refsect3">
+<a name="GtkSourceCompletionContext-cancelled.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>user_data</p></td>
+<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p>Flags: <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-ACTION:CAPS">Action</a></p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.28.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/gtksourceview-4.0/GtkSourceCompletionInfo.html ADDED

@@ -0,0 +1,207 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GtkSourceCompletionInfo: GtkSourceView 4 Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
+<link rel="home" href="index.html" title="GtkSourceView 4 Reference Manual">
+<link rel="up" href="completion.html" title="Completion">
+<link rel="prev" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext">
+<link rel="next" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem">
+<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionInfo.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionInfo.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
+                  <a href="#GtkSourceCompletionInfo.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="completion.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="GtkSourceCompletionContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="GtkSourceCompletionItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="GtkSourceCompletionInfo"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GtkSourceCompletionInfo.top_of_page"></a>GtkSourceCompletionInfo</span></h2>
+<p>GtkSourceCompletionInfo — Calltips object</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-new" title="gtk_source_completion_info_new ()">gtk_source_completion_info_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="GtkSourceCompletionInfo.html#gtk-source-completion-info-move-to-iter" title="gtk_source_completion_info_move_to_iter ()">gtk_source_completion_info_move_to_iter</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody><tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="GtkSourceCompletionInfo.html#GtkSourceCompletionInfo-struct" title="GtkSourceCompletionInfo">GtkSourceCompletionInfo</a></td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
+    <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+        <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-struct">GtkWidget</a>
+            <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkContainer.html#GtkContainer-struct">GtkContainer</a>
+                <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkBin.html#GtkBin-struct">GtkBin</a>
+                    <span class="lineart">╰──</span> <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWindow.html#GtkWindow-struct">GtkWindow</a>
+                        <span class="lineart">╰──</span> GtkSourceCompletionInfo
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+GtkSourceCompletionInfo implements
+ AtkImplementorIface and  <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>.</p>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.includes"></a><h2>Includes</h2>
+<pre class="synopsis">#include &lt;gtksourceview/gtksource.h&gt;
+</pre>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.description"></a><h2>Description</h2>
+<p>This object can be used to show a calltip or help for the
+current completion proposal.</p>
+<p>The info window has always the same size as the natural size of its child
+widget, added with <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkContainer.html#gtk-container-add"><code class="function">gtk_container_add()</code></a>.  If you want a fixed size instead, a
+possibility is to use a scrolled window, as the following example
+demonstrates.</p>
+<div class="example">
+<a name="id-1.3.6.4.8.4"></a><p class="title"><b>Example 1. Fixed size with a scrolled window.</b></p>
+<div class="example-contents">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="usertype">GtkSourceCompletionInfo</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">info</span><span class="symbol">;</span>
+<span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">your_widget</span><span class="symbol">;</span>
+<span class="usertype">GtkWidget</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">scrolled_window </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkScrolledWindow.html#gtk-scrolled-window-new">gtk_scrolled_window_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span><span class="normal"> <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
+<span class="function"><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#gtk-widget-set-size-request">gtk_widget_set_size_request</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">scrolled_window</span><span class="symbol">,</span><span class="normal"> </span><span class="number">300</span><span class="symbol">,</span><span class="normal"> </span><span class="number">200</span><span class="symbol">);</span>
+<span class="function"><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">scrolled_window</span><span class="symbol">),</span><span class="normal"> your_widget</span><span class="symbol">);</span>
+<span class="function"><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkContainer.html#gtk-container-add">gtk_container_add</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_CONTAINER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">info</span><span class="symbol">),</span><span class="normal"> scrolled_window</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+</div>
+<br class="example-break"><p>If the calltip is displayed on top of a certain widget, say a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>,
+you should attach the calltip window to the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> with
+<a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWindow.html#gtk-window-set-attached-to"><code class="function">gtk_window_set_attached_to()</code></a>.  By doing this, the calltip will be hidden when
+the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkWidget.html#GtkWidget-focus-out-event"><span class="type">“focus-out-event”</span></a> signal is emitted by the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a>. You
+may also be interested by the <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextBuffer.html#GtkTextBuffer--cursor-position"><span class="type">“cursor-position”</span></a> property (when
+its value is modified). If you use the <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> through the
+<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> machinery, you don't need to worry about this.</p>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gtk-source-completion-info-new"></a><h3>gtk_source_completion_info_new ()</h3>
+<pre class="programlisting"><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> *
+gtk_source_completion_info_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="refsect3">
+<a name="gtk-source-completion-info-new.returns"></a><h4>Returns</h4>
+<p> a new GtkSourceCompletionInfo.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gtk-source-completion-info-move-to-iter"></a><h3>gtk_source_completion_info_move_to_iter ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+gtk_source_completion_info_move_to_iter
+                               (<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>,
+                                <em class="parameter"><code><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> *view</code></em>,
+                                <em class="parameter"><code><a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
+<p>Moves the <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> to <em class="parameter"><code>iter</code></em>
+. If <em class="parameter"><code>iter</code></em>
+ is <a href="/home/seb/jhbuild/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>info</code></em>
+ is
+moved to the cursor position. Moving will respect the <a href="/home/seb/jhbuild/share/gtk-doc/html/gdk3/gdk3-Windows.html#GdkGravity"><span class="type">GdkGravity</span></a> setting
+of the info window and will ensure the line at <em class="parameter"><code>iter</code></em>
+ is not occluded by
+the window.</p>
+<div class="refsect3">
+<a name="gtk-source-completion-info-move-to-iter.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>info</p></td>
+<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>view</p></td>
+<td class="parameter_description"><p>a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextView.html#GtkTextView-struct"><span class="type">GtkTextView</span></a> on which the info window should be positioned.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>iter</p></td>
+<td class="parameter_description"><p>a <a href="/home/seb/jhbuild/share/gtk-doc/html/gtk3/GtkTextIter.html#GtkTextIter-struct"><span class="type">GtkTextIter</span></a>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="GtkSourceCompletionInfo.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GtkSourceCompletionInfo-struct"></a><h3>GtkSourceCompletionInfo</h3>
+<pre class="programlisting">typedef struct _GtkSourceCompletionInfo GtkSourceCompletionInfo;</pre>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.28.1</div>
+</body>
+</html>