/usr/share/gtk-doc/html/gtksourceview-2.0/gtksourceview-2.0-completioncontext.html is in libgtksourceview2.0-doc 2.10.5-2ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GtkSourceView 2 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="GtkSourceCompletion.html" title="GtkSourceCompletion">
<link rel="next" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo">
<meta name="generator" content="GTK-Doc V1.15 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceCompletion.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 2 Reference Manual</th>
<td><a accesskey="n" href="GtkSourceCompletionInfo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gtksourceview-2.0-completioncontext.synopsis" class="shortcut">Top</a>
|
<a href="#gtksourceview-2.0-completioncontext.description" class="shortcut">Description</a>
|
<a href="#gtksourceview-2.0-completioncontext.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#gtksourceview-2.0-completioncontext.properties" class="shortcut">Properties</a>
|
<a href="#gtksourceview-2.0-completioncontext.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GtkSourceCompletionContext">
<a name="gtksourceview-2.0-completioncontext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gtksourceview-2.0-completioncontext.top_of_page"></a>GtkSourceCompletionContext</span></h2>
<p>GtkSourceCompletionContext</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="gtksourceview-2.0-completioncontext.synopsis"></a><h2>Synopsis</h2>
<a name="GtkSourceCompletionContext"></a><pre class="synopsis">
#include <gtksourceview/gtksourcecompletioncontext.h>
enum <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation">GtkSourceCompletionActivation</a>;
<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext-struct" title="GtkSourceCompletionContext">GtkSourceCompletionContext</a>;
<span class="returnvalue">void</span> <a class="link" href="gtksourceview-2.0-completioncontext.html#gtk-source-completion-context-add-proposals" title="gtk_source_completion_context_add_proposals ()">gtk_source_completion_context_add_proposals</a>
(<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
<em class="parameter"><code><span class="type">struct _GtkSourceCompletionProvider</span> *provider</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *proposals</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> finished</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gtksourceview-2.0-completioncontext.html#gtk-source-completion-context-get-iter" title="gtk_source_completion_context_get_iter ()">gtk_source_completion_context_get_iter</a>
(<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *iter</code></em>);
<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a> <a class="link" href="gtksourceview-2.0-completioncontext.html#gtk-source-completion-context-get-activation" title="gtk_source_completion_context_get_activation ()">gtk_source_completion_context_get_activation</a>
(<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="gtksourceview-2.0-completioncontext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----GtkSourceCompletionContext
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="gtksourceview-2.0-completioncontext.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext--activation" title='The "activation" property'>activation</a>" <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a> : Read / Write
"<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext--completion" title='The "completion" property'>completion</a>" <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>* : Read / Write / Construct Only
"<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext--iter" title='The "iter" property'>iter</a>" <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="gtksourceview-2.0-completioncontext.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext-cancelled" title='The "cancelled" signal'>cancelled</a>" : Run Last / Action
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gtksourceview-2.0-completioncontext.description"></a><h2>Description</h2>
</div>
<div class="refsect1" title="Details">
<a name="gtksourceview-2.0-completioncontext.details"></a><h2>Details</h2>
<div class="refsect2" title="enum GtkSourceCompletionActivation">
<a name="GtkSourceCompletionActivation"></a><h3>enum GtkSourceCompletionActivation</h3>
<pre class="programlisting">typedef enum
{
GTK_SOURCE_COMPLETION_ACTIVATION_NONE = 0,
GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE = 1 << 0,
GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED = 1 << 1
} GtkSourceCompletionActivation;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-NONE:CAPS"></a><span class="term"><code class="literal">GTK_SOURCE_COMPLETION_ACTIVATION_NONE</code></span></p></td>
<td>none.
</td>
</tr>
<tr>
<td><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-INTERACTIVE:CAPS"></a><span class="term"><code class="literal">GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE</code></span></p></td>
<td>interactive activation
</td>
</tr>
<tr>
<td><p><a name="GTK-SOURCE-COMPLETION-ACTIVATION-USER-REQUESTED:CAPS"></a><span class="term"><code class="literal">GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED</code></span></p></td>
<td>user requested activation
(e.g. through a keyboard accelerator from the view)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GtkSourceCompletionContext">
<a name="GtkSourceCompletionContext-struct"></a><h3>GtkSourceCompletionContext</h3>
<pre class="programlisting">typedef struct _GtkSourceCompletionContext GtkSourceCompletionContext;</pre>
</div>
<hr>
<div class="refsect2" title="gtk_source_completion_context_add_proposals ()">
<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="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
<em class="parameter"><code><span class="type">struct _GtkSourceCompletionProvider</span> *provider</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *proposals</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
once each population (even if no proposals need to be added).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>A <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposals</code></em> :</span></p></td>
<td>The list of proposals to add
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>finished</code></em> :</span></p></td>
<td>Whether the provider is finished adding proposals
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_source_completion_context_get_iter ()">
<a name="gtk-source-completion-context-get-iter"></a><h3>gtk_source_completion_context_get_iter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_context_get_iter
(<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gtk_source_completion_context_get_activation ()">
<a name="gtk-source-completion-context-get-activation"></a><h3>gtk_source_completion_context_get_activation ()</h3>
<pre class="programlisting"><a class="link" href="gtksourceview-2.0-completioncontext.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="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
<p>
Get the context activation
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The context activation
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="gtksourceview-2.0-completioncontext.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "activation" property'>
<a name="GtkSourceCompletionContext--activation"></a><h3>The <code class="literal">"activation"</code> property</h3>
<pre class="programlisting"> "activation" <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a> : Read / Write</pre>
<p>
The completion activation
</p>
</div>
<hr>
<div class="refsect2" title='The "completion" property'>
<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>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> associated with the context.
</p>
</div>
<hr>
<div class="refsect2" title='The "iter" property'>
<a name="GtkSourceCompletionContext--iter"></a><h3>The <code class="literal">"iter"</code> property</h3>
<pre class="programlisting"> "iter" <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a>* : Read / Write</pre>
<p>
The <a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> at which the completion is invoked.
</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="gtksourceview-2.0-completioncontext.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "cancelled" signal'>
<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="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *arg0,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last / Action</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|