8
8
<link rel="up" href="rn01.html" title="API reference">
9
9
<link rel="prev" href="GtkSourceBuffer.html" title="GtkSourceBuffer">
10
10
<link rel="next" href="gtksourceview-2.0-completioncontext.html" title="GtkSourceCompletionContext">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
47
47
#include <gtksourceview/gtksourcecompletion.h>
49
49
<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-struct" title="GtkSourceCompletion">GtkSourceCompletion</a>;
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-add-provider" title="gtk_source_completion_add_provider ()">gtk_source_completion_add_provider</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
50
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-add-provider" title="gtk_source_completion_add_provider ()">gtk_source_completion_add_provider</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
51
51
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
52
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
53
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-remove-provider" title="gtk_source_completion_remove_provider ()">gtk_source_completion_remove_provider</a>
52
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
53
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-remove-provider" title="gtk_source_completion_remove_provider ()">gtk_source_completion_remove_provider</a>
54
54
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
55
55
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-providers" title="gtk_source_completion_get_providers ()">gtk_source_completion_get_providers</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
58
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-show" title="gtk_source_completion_show ()">gtk_source_completion_show</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
59
<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> *providers</code></em>,
56
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
57
<span class="returnvalue">GList</span> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-providers" title="gtk_source_completion_get_providers ()">gtk_source_completion_get_providers</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
58
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-show" title="gtk_source_completion_show ()">gtk_source_completion_show</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
59
<em class="parameter"><code><span class="type">GList</span> *providers</code></em>,
60
60
<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);
61
61
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-hide" title="gtk_source_completion_hide ()">gtk_source_completion_hide</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
62
62
<a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-info-window" title="gtk_source_completion_get_info_window ()">gtk_source_completion_get_info_window</a>
64
64
struct <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="returnvalue">_GtkSourceView</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-view" title="gtk_source_completion_get_view ()">gtk_source_completion_get_view</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
65
65
<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="returnvalue">GtkSourceCompletionContext</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-create-context" title="gtk_source_completion_create_context ()">gtk_source_completion_create_context</a>
66
66
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
67
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *position</code></em>);
67
<em class="parameter"><code><span class="type">GtkTextIter</span> *position</code></em>);
68
68
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-move-window" title="gtk_source_completion_move_window ()">gtk_source_completion_move_window</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
69
<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>);
69
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>);
70
70
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-block-interactive" title="gtk_source_completion_block_interactive ()">gtk_source_completion_block_interactive</a>
71
71
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
72
72
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-unblock-interactive" title="gtk_source_completion_unblock_interactive ()">gtk_source_completion_unblock_interactive</a>
76
76
<div class="refsect1" title="Object Hierarchy">
77
77
<a name="GtkSourceCompletion.object-hierarchy"></a><h2>Object Hierarchy</h2>
78
78
<pre class="synopsis">
79
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
80
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
81
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
80
+----GInitiallyUnowned
82
82
+----GtkSourceCompletion
85
85
<div class="refsect1" title="Properties">
86
86
<a name="GtkSourceCompletion.properties"></a><h2>Properties</h2>
87
87
<pre class="synopsis">
88
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--accelerators" title='The "accelerators" property'>accelerators</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
89
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--auto-complete-delay" title='The "auto-complete-delay" property'>auto-complete-delay</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
90
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--proposal-page-size" title='The "proposal-page-size" property'>proposal-page-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
91
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--provider-page-size" title='The "provider-page-size" property'>provider-page-size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct
92
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--remember-info-visibility" title='The "remember-info-visibility" property'>remember-info-visibility</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
93
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--select-on-show" title='The "select-on-show" property'>select-on-show</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
94
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-headers" title='The "show-headers" property'>show-headers</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
95
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-icons" title='The "show-icons" property'>show-icons</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
88
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--accelerators" title='The "accelerators" property'>accelerators</a>" <span class="type">guint</span> : Read / Write / Construct
89
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--auto-complete-delay" title='The "auto-complete-delay" property'>auto-complete-delay</a>" <span class="type">guint</span> : Read / Write / Construct
90
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--proposal-page-size" title='The "proposal-page-size" property'>proposal-page-size</a>" <span class="type">guint</span> : Read / Write / Construct
91
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--provider-page-size" title='The "provider-page-size" property'>provider-page-size</a>" <span class="type">guint</span> : Read / Write / Construct
92
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--remember-info-visibility" title='The "remember-info-visibility" property'>remember-info-visibility</a>" <span class="type">gboolean</span> : Read / Write / Construct
93
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--select-on-show" title='The "select-on-show" property'>select-on-show</a>" <span class="type">gboolean</span> : Read / Write / Construct
94
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-headers" title='The "show-headers" property'>show-headers</a>" <span class="type">gboolean</span> : Read / Write / Construct
95
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-icons" title='The "show-icons" property'>show-icons</a>" <span class="type">gboolean</span> : Read / Write / Construct
96
96
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--view" title='The "view" property'>view</a>" <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>* : Read / Write / Construct Only
115
115
<div class="refsect2" title="GtkSourceCompletion">
116
116
<a name="GtkSourceCompletion-struct"></a><h3>GtkSourceCompletion</h3>
117
117
<pre class="programlisting">typedef struct _GtkSourceCompletion GtkSourceCompletion;</pre>
120
122
<div class="refsect2" title="gtk_source_completion_add_provider ()">
121
123
<a name="gtk-source-completion-add-provider"></a><h3>gtk_source_completion_add_provider ()</h3>
122
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_source_completion_add_provider (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
124
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_add_provider (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
123
125
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
124
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
126
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
126
128
Add a new <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> to the completion object. This will
127
129
add a reference <em class="parameter"><code>provider</code></em>, so make sure to unref your own copy when you
144
146
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
145
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
147
<td>A <span class="type">GError</span>
149
151
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
150
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>provider</code></em> was successfully added, otherwise if <em class="parameter"><code>error</code></em>
151
is provided, it will be set with the error and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.
152
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>provider</code></em> was successfully added, otherwise if <em class="parameter"><code>error</code></em>
153
is provided, it will be set with the error and <code class="literal">FALSE</code> is returned.
158
160
<div class="refsect2" title="gtk_source_completion_remove_provider ()">
159
161
<a name="gtk-source-completion-remove-provider"></a><h3>gtk_source_completion_remove_provider ()</h3>
160
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_source_completion_remove_provider
162
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_remove_provider
161
163
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
162
164
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
163
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
165
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
165
167
Remove <em class="parameter"><code>provider</code></em> from the completion.
181
183
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
182
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
184
<td>A <span class="type">GError</span>
186
188
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
187
<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>provider</code></em> was successfully removed, otherwise if <em class="parameter"><code>error</code></em>
188
is provided, it will be set with the error and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.
189
<td> <code class="literal">TRUE</code> if <em class="parameter"><code>provider</code></em> was successfully removed, otherwise if <em class="parameter"><code>error</code></em>
190
is provided, it will be set with the error and <code class="literal">FALSE</code> is returned.
195
197
<div class="refsect2" title="gtk_source_completion_get_providers ()">
196
198
<a name="gtk-source-completion-get-providers"></a><h3>gtk_source_completion_get_providers ()</h3>
197
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * gtk_source_completion_get_providers (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
199
<pre class="programlisting"><span class="returnvalue">GList</span> * gtk_source_completion_get_providers (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
199
201
Get list of providers registered on <em class="parameter"><code>completion</code></em>. The returned list is owned
200
202
by the completion and should not be freed.
219
221
<div class="refsect2" title="gtk_source_completion_show ()">
220
222
<a name="gtk-source-completion-show"></a><h3>gtk_source_completion_show ()</h3>
221
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_source_completion_show (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
222
<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> *providers</code></em>,
223
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_show (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
224
<em class="parameter"><code><span class="type">GList</span> *providers</code></em>,
223
225
<em class="parameter"><code><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
225
227
Starts a new completion with the specified <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> and
237
239
<td><p><span class="term"><em class="parameter"><code>providers</code></em> :</span></p></td>
238
<td>A list of <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
240
<td>A list of <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
320
322
<a name="gtk-source-completion-create-context"></a><h3>gtk_source_completion_create_context ()</h3>
321
323
<pre class="programlisting"><a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="returnvalue">GtkSourceCompletionContext</span></a> * gtk_source_completion_create_context
322
324
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
323
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk-GtkTextIter.html#GtkTextIter"><span class="type">GtkTextIter</span></a> *position</code></em>);</pre>
325
<em class="parameter"><code><span class="type">GtkTextIter</span> *position</code></em>);</pre>
325
327
Create a new <a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> for <em class="parameter"><code>completion</code></em>. The position at
326
328
which the completion using the new context will consider completion can
327
be provider by <em class="parameter"><code>position</code></em>. If <em class="parameter"><code>position</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the current cursor
329
be provider by <em class="parameter"><code>position</code></em>. If <em class="parameter"><code>position</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the current cursor
328
330
position will be used.
330
332
<div class="variablelist"><table border="0">
355
357
<div class="refsect2" title="gtk_source_completion_move_window ()">
356
358
<a name="gtk-source-completion-move-window"></a><h3>gtk_source_completion_move_window ()</h3>
357
359
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_move_window (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
358
<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>
360
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>);</pre>
360
362
Move the completion window to a specific iter.
380
382
<a name="gtk-source-completion-block-interactive"></a><h3>gtk_source_completion_block_interactive ()</h3>
381
383
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_block_interactive
382
384
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
384
Block interactive completion. This can be used to disable interactive
385
completion when inserting or deleting text from the buffer associated with
386
the completion. Use <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-unblock-interactive" title="gtk_source_completion_unblock_interactive ()"><span class="type">gtk_source_completion_unblock_interactive</span></a> to enable
387
interactive completion again.
389
<div class="variablelist"><table border="0">
390
<col align="left" valign="top">
392
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
393
<td>A # GtkSourceCompletion
399
387
<div class="refsect2" title="gtk_source_completion_unblock_interactive ()">
400
388
<a name="gtk-source-completion-unblock-interactive"></a><h3>gtk_source_completion_unblock_interactive ()</h3>
401
389
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_unblock_interactive
402
390
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
404
Unblock interactive completion. This can be used after using
405
<a class="link" href="GtkSourceCompletion.html#gtk-source-completion-block-interactive" title="gtk_source_completion_block_interactive ()"><span class="type">gtk_source_completion_block_interactive</span></a> to enable interactive completion
408
<div class="variablelist"><table border="0">
409
<col align="left" valign="top">
411
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
412
<td>A # GtkSourceCompletion
418
393
<div class="refsect1" title="Property Details">
419
394
<a name="GtkSourceCompletion.property-details"></a><h2>Property Details</h2>
420
395
<div class="refsect2" title='The "accelerators" property'>
421
396
<a name="GtkSourceCompletion--accelerators"></a><h3>The <code class="literal">"accelerators"</code> property</h3>
422
<pre class="programlisting"> "accelerators" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
397
<pre class="programlisting"> "accelerators" <span class="type">guint</span> : Read / Write / Construct</pre>
424
399
Number of accelerators to show for the first proposals.
430
405
<div class="refsect2" title='The "auto-complete-delay" property'>
431
406
<a name="GtkSourceCompletion--auto-complete-delay"></a><h3>The <code class="literal">"auto-complete-delay"</code> property</h3>
432
<pre class="programlisting"> "auto-complete-delay" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
407
<pre class="programlisting"> "auto-complete-delay" <span class="type">guint</span> : Read / Write / Construct</pre>
434
409
Determines the popup delay (in milliseconds) at which the completion
435
410
will be shown for interactive completion.
440
415
<div class="refsect2" title='The "proposal-page-size" property'>
441
416
<a name="GtkSourceCompletion--proposal-page-size"></a><h3>The <code class="literal">"proposal-page-size"</code> property</h3>
442
<pre class="programlisting"> "proposal-page-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
417
<pre class="programlisting"> "proposal-page-size" <span class="type">guint</span> : Read / Write / Construct</pre>
444
419
The scroll page size of the proposals in the completion window.
450
425
<div class="refsect2" title='The "provider-page-size" property'>
451
426
<a name="GtkSourceCompletion--provider-page-size"></a><h3>The <code class="literal">"provider-page-size"</code> property</h3>
452
<pre class="programlisting"> "provider-page-size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre>
427
<pre class="programlisting"> "provider-page-size" <span class="type">guint</span> : Read / Write / Construct</pre>
454
429
The scroll page size of the provider pages in the completion window.
460
435
<div class="refsect2" title='The "remember-info-visibility" property'>
461
436
<a name="GtkSourceCompletion--remember-info-visibility"></a><h3>The <code class="literal">"remember-info-visibility"</code> property</h3>
462
<pre class="programlisting"> "remember-info-visibility" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
437
<pre class="programlisting"> "remember-info-visibility" <span class="type">gboolean</span> : Read / Write / Construct</pre>
464
439
Determines whether the visibility of the info window should be
465
440
saved when the completion is hidden, and restored when the completion
471
446
<div class="refsect2" title='The "select-on-show" property'>
472
447
<a name="GtkSourceCompletion--select-on-show"></a><h3>The <code class="literal">"select-on-show"</code> property</h3>
473
<pre class="programlisting"> "select-on-show" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
448
<pre class="programlisting"> "select-on-show" <span class="type">gboolean</span> : Read / Write / Construct</pre>
475
450
Determines whether the first proposal should be selected when the
476
451
completion is first shown.
481
456
<div class="refsect2" title='The "show-headers" property'>
482
457
<a name="GtkSourceCompletion--show-headers"></a><h3>The <code class="literal">"show-headers"</code> property</h3>
483
<pre class="programlisting"> "show-headers" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
458
<pre class="programlisting"> "show-headers" <span class="type">gboolean</span> : Read / Write / Construct</pre>
485
460
Determines whether provider headers should be shown in the proposal
486
461
list if there is more than one provider with proposals.
491
466
<div class="refsect2" title='The "show-icons" property'>
492
467
<a name="GtkSourceCompletion--show-icons"></a><h3>The <code class="literal">"show-icons"</code> property</h3>
493
<pre class="programlisting"> "show-icons" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
495
Determines whether provider and proposal icons should be shown in
496
the completion popup.
468
<pre class="programlisting"> "show-icons" <span class="type">gboolean</span> : Read / Write / Construct</pre>
469
<p>Show provider and proposal icons in the completion popup.</p>
498
470
<p>Default value: TRUE</p>
511
483
<div class="refsect2" title='The "activate-proposal" signal'>
512
484
<a name="GtkSourceCompletion-activate-proposal"></a><h3>The <code class="literal">"activate-proposal"</code> signal</h3>
513
485
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
514
<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>
486
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
516
488
The ::activate-proposal signal is a keybinding signal which gets
517
489
emitted when the user initiates a proposal activation.
520
492
Applications should not connect to it, but may emit it with
521
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><span class="type">g_signal_emit_by_name</span></a> if they need to control the proposal activation
493
<span class="type">g_signal_emit_by_name</span> if they need to control the proposal activation
522
494
programmatically.
524
496
<div class="variablelist"><table border="0">
540
512
<div class="refsect2" title='The "hide" signal'>
541
513
<a name="GtkSourceCompletion-hide"></a><h3>The <code class="literal">"hide"</code> signal</h3>
542
514
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
543
<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>
515
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
545
517
Emitted when the completion window is hidden. The default handler
546
518
will actually hide the window.
564
536
<div class="refsect2" title='The "move-cursor" signal'>
565
537
<a name="GtkSourceCompletion-move-cursor"></a><h3>The <code class="literal">"move-cursor"</code> signal</h3>
566
538
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
567
<a href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> step,
568
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> num,
569
<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>
539
<span class="type">GtkScrollStep</span> step,
540
<span class="type">gint</span> num,
541
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
571
543
The ::move-cursor signal is a keybinding signal which gets emitted when
572
544
the user initiates a cursor movement.
575
547
Applications should not connect to it, but may emit it with
576
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><span class="type">g_signal_emit_by_name</span></a> if they need to control the cursor
548
<span class="type">g_signal_emit_by_name</span> if they need to control the cursor
577
549
programmatically.
579
551
<div class="variablelist"><table border="0">
605
577
<div class="refsect2" title='The "move-page" signal'>
606
578
<a name="GtkSourceCompletion-move-page"></a><h3>The <code class="literal">"move-page"</code> signal</h3>
607
579
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
608
<a href="http://library.gnome.org/devel/gtk/unstable/gtk-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> step,
609
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> num,
610
<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>
580
<span class="type">GtkScrollStep</span> step,
581
<span class="type">gint</span> num,
582
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
612
584
The ::move-page signal is a keybinding signal which gets emitted when
613
585
the user initiates a page movement (i.e. switches between provider
617
589
Applications should not connect to it, but may emit it with
618
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><span class="type">g_signal_emit_by_name</span></a> if they need to control the page selection
590
<span class="type">g_signal_emit_by_name</span> if they need to control the page selection
619
591
programmatically.
621
593
<div class="variablelist"><table border="0">
648
620
<a name="GtkSourceCompletion-populate-context"></a><h3>The <code class="literal">"populate-context"</code> signal</h3>
649
621
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
650
622
<a class="link" href="gtksourceview-2.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context,
651
<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>
623
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
653
625
Emitted just before starting to populate the completion with providers.
654
626
You can use this signal to add additional attributes in the context.
677
649
<div class="refsect2" title='The "show" signal'>
678
650
<a name="GtkSourceCompletion-show"></a><h3>The <code class="literal">"show"</code> signal</h3>
679
651
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion,
680
<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>
652
<span class="type">gpointer</span> user_data) : Run Last / Action</pre>
682
654
Emitted when the completion window is shown. The default handler
683
655
will actually show the window.