~noskcaj/ubuntu/vivid/gtksourceview3/3.14.3
» Revision
50
: docs/reference/html/GtkSourceCompletionProvider.html
« back to all changes in this revision
Viewing changes to docs/reference/html/GtkSourceCompletionProvider.html
- browse files at revision 50
- compare with another revision
- download diff
- download tarball
- view history from revision 50
- Committer: Package Import Robot
- Author(s): Robert Ancell
- Date: 2014-07-07 11:31:02 UTC
- mfrom: (13.1.16 sid)
- Revision ID: package-import@ubuntu.com-20140707113102-wui3gezgwd0uer9t
Tags: 3.12.2-1ubuntu1
* Merge with Debian, remaining Ubuntu changes:
* debian/control:
- Let the common C/R the old soname binary for upgrades (lp: #1185092)
- Correct GTK+ version dependency for -dev package
- Build-depend on dh-autoreconf
* debian/rules:
- Build using dh-autoreconf.
* debian/control:
- Let the common C/R the old soname binary for upgrades (lp: #1185092)
- Correct GTK+ version dependency for -dev package
- Build-depend on dh-autoreconf
* debian/rules:
- Build using dh-autoreconf.
- files added:
- data/language-specs/ansforth94.lang
- files removed:
- .pc/ini.lang-Support-hash-as-line-comment.patch
- .pc/ini.lang-Support-hash-as-line-comment.patch/data
- .pc/ini.lang-Support-hash-as-line-comment.patch/data/language-specs
- files modified:
- .pc/applied-patches
added
removed
docs/reference/html/GtkSourceCompletionProvider.html
8
8
<link rel="up" href="ch01.html" title="API reference">
9
9
<link rel="prev" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal">
10
10
<link rel="next" href="GtkSourceCompletionWords.html" title="GtkSourceCompletionWords">
11
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left">
17
<a href="#" class="shortcut">Top</a>
18
|
19
<a href="#GtkSourceCompletionProvider.description" class="shortcut">Description</a>
20
|
21
<a href="#GtkSourceCompletionProvider.object-hierarchy" class="shortcut">Object Hierarchy</a>
22
|
23
<a href="#GtkSourceCompletionProvider.prerequisites" class="shortcut">Prerequisites</a>
24
|
25
<a href="#GtkSourceCompletionProvider.implementations" class="shortcut">Known Implementations</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#GtkSourceCompletionProvider.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#GtkSourceCompletionProvider.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
20
<a href="#GtkSourceCompletionProvider.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
21
<a href="#GtkSourceCompletionProvider.implementations" class="shortcut">Known Implementations</a></span>
26
22
</td>
27
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
28
24
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
36
32
<h2><span class="refentrytitle"><a name="GtkSourceCompletionProvider.top_of_page"></a>GtkSourceCompletionProvider</span></h2>
37
33
<p>GtkSourceCompletionProvider — Completion provider interface</p>
38
34
</td>
39
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
40
36
</tr></table></div>
41
<div class="refsynopsisdiv">
42
<a name="GtkSourceCompletionProvider.synopsis"></a><h2>Synopsis</h2>
43
<pre class="synopsis">
44
#include <gtksourceview/gtksource.h>
45
46
<a class="link" href="GtkSourceCompletionProvider.html#GtkSourceCompletionProvider-struct" title="GtkSourceCompletionProvider">GtkSourceCompletionProvider</a>;
47
struct <a class="link" href="GtkSourceCompletionProvider.html#GtkSourceCompletionProviderIface" title="struct GtkSourceCompletionProviderIface">GtkSourceCompletionProviderIface</a>;
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-name" title="gtk_source_completion_provider_get_name ()">gtk_source_completion_provider_get_name</a>
49
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);
50
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-icon" title="gtk_source_completion_provider_get_icon ()">gtk_source_completion_provider_get_icon</a>
51
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);
52
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-populate" title="gtk_source_completion_provider_populate ()">gtk_source_completion_provider_populate</a>
53
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
54
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);
55
<a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-activation" title="gtk_source_completion_provider_get_activation ()">gtk_source_completion_provider_get_activation</a>
56
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-match" title="gtk_source_completion_provider_match ()">gtk_source_completion_provider_match</a>
58
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
59
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);
60
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()">gtk_source_completion_provider_get_info_widget</a>
61
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
62
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
63
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()">gtk_source_completion_provider_update_info</a>
64
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
65
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
66
<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>);
67
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()">gtk_source_completion_provider_get_start_iter</a>
68
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
69
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
70
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
71
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()">gtk_source_completion_provider_activate_proposal</a>
73
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
74
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
75
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);
76
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-interactive-delay" title="gtk_source_completion_provider_get_interactive_delay ()">gtk_source_completion_provider_get_interactive_delay</a>
77
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-priority" title="gtk_source_completion_provider_get_priority ()">gtk_source_completion_provider_get_priority</a>
79
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);
80
</pre>
37
<div class="refsect1">
38
<a name="GtkSourceCompletionProvider.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
40
<colgroup>
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
43
</colgroup>
44
<tbody>
45
<tr>
46
<td class="function_type">
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
48
</td>
49
<td class="function_name">
50
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-name" title="gtk_source_completion_provider_get_name ()">gtk_source_completion_provider_get_name</a> <span class="c_punctuation">()</span>
51
</td>
52
</tr>
53
<tr>
54
<td class="function_type">
55
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *
56
</td>
57
<td class="function_name">
58
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-icon" title="gtk_source_completion_provider_get_icon ()">gtk_source_completion_provider_get_icon</a> <span class="c_punctuation">()</span>
59
</td>
60
</tr>
61
<tr>
62
<td class="function_type">
63
<span class="returnvalue">void</span>
64
</td>
65
<td class="function_name">
66
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-populate" title="gtk_source_completion_provider_populate ()">gtk_source_completion_provider_populate</a> <span class="c_punctuation">()</span>
67
</td>
68
</tr>
69
<tr>
70
<td class="function_type">
71
<a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a>
72
</td>
73
<td class="function_name">
74
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-activation" title="gtk_source_completion_provider_get_activation ()">gtk_source_completion_provider_get_activation</a> <span class="c_punctuation">()</span>
75
</td>
76
</tr>
77
<tr>
78
<td class="function_type">
79
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
80
</td>
81
<td class="function_name">
82
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-match" title="gtk_source_completion_provider_match ()">gtk_source_completion_provider_match</a> <span class="c_punctuation">()</span>
83
</td>
84
</tr>
85
<tr>
86
<td class="function_type">
87
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
88
</td>
89
<td class="function_name">
90
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()">gtk_source_completion_provider_get_info_widget</a> <span class="c_punctuation">()</span>
91
</td>
92
</tr>
93
<tr>
94
<td class="function_type">
95
<span class="returnvalue">void</span>
96
</td>
97
<td class="function_name">
98
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()">gtk_source_completion_provider_update_info</a> <span class="c_punctuation">()</span>
99
</td>
100
</tr>
101
<tr>
102
<td class="function_type">
103
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
104
</td>
105
<td class="function_name">
106
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()">gtk_source_completion_provider_get_start_iter</a> <span class="c_punctuation">()</span>
107
</td>
108
</tr>
109
<tr>
110
<td class="function_type">
111
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
112
</td>
113
<td class="function_name">
114
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()">gtk_source_completion_provider_activate_proposal</a> <span class="c_punctuation">()</span>
115
</td>
116
</tr>
117
<tr>
118
<td class="function_type">
119
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
120
</td>
121
<td class="function_name">
122
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-interactive-delay" title="gtk_source_completion_provider_get_interactive_delay ()">gtk_source_completion_provider_get_interactive_delay</a> <span class="c_punctuation">()</span>
123
</td>
124
</tr>
125
<tr>
126
<td class="function_type">
127
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
128
</td>
129
<td class="function_name">
130
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-priority" title="gtk_source_completion_provider_get_priority ()">gtk_source_completion_provider_get_priority</a> <span class="c_punctuation">()</span>
131
</td>
132
</tr>
133
</tbody>
134
</table></div>
135
</div>
136
<div class="refsect1">
137
<a name="GtkSourceCompletionProvider.other"></a><h2>Types and Values</h2>
138
<div class="informaltable"><table width="100%" border="0">
139
<colgroup>
140
<col width="150px" class="name">
141
<col class="description">
142
</colgroup>
143
<tbody>
144
<tr>
145
<td class="datatype_keyword"> </td>
146
<td class="function_name"><a class="link" href="GtkSourceCompletionProvider.html#GtkSourceCompletionProvider-struct" title="GtkSourceCompletionProvider">GtkSourceCompletionProvider</a></td>
147
</tr>
148
<tr>
149
<td class="datatype_keyword">struct</td>
150
<td class="function_name"><a class="link" href="GtkSourceCompletionProvider.html#GtkSourceCompletionProviderIface" title="struct GtkSourceCompletionProviderIface">GtkSourceCompletionProviderIface</a></td>
151
</tr>
152
</tbody>
153
</table></div>
81
154
</div>
82
155
<div class="refsect1">
83
156
<a name="GtkSourceCompletionProvider.object-hierarchy"></a><h2>Object Hierarchy</h2>
84
<pre class="synopsis">
85
GInterface
86
+----GtkSourceCompletionProvider
157
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GInterface</a>
158
<span class="lineart">╰──</span> GtkSourceCompletionProvider
87
159
</pre>
88
160
</div>
89
161
<div class="refsect1">
99
171
<a class="link" href="GtkSourceCompletionWords.html" title="GtkSourceCompletionWords">GtkSourceCompletionWords</a>.</p>
100
172
</div>
101
173
<div class="refsect1">
174
<a name="GtkSourceCompletionProvider.includes"></a><h2>Includes</h2>
175
<pre class="synopsis">#include <gtksourceview/gtksource.h>
176
</pre>
177
</div>
178
<div class="refsect1">
102
179
<a name="GtkSourceCompletionProvider.description"></a><h2>Description</h2>
103
<p>
104
You must implement this interface to provide proposals to <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>
105
</p>
106
</div>
107
<div class="refsect1">
108
<a name="GtkSourceCompletionProvider.details"></a><h2>Details</h2>
180
<p>You must implement this interface to provide proposals to <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a></p>
181
</div>
182
<div class="refsect1">
183
<a name="GtkSourceCompletionProvider.functions_details"></a><h2>Functions</h2>
184
<div class="refsect2">
185
<a name="gtk-source-completion-provider-get-name"></a><h3>gtk_source_completion_provider_get_name ()</h3>
186
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
187
gtk_source_completion_provider_get_name
188
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
189
<p>Get the name of the provider. This should be a translatable name for
190
display to the user. For example: _("Document word completion provider"). The
191
returned string must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
192
<div class="refsect3">
193
<a name="id-1.2.8.10.2.5"></a><h4>Parameters</h4>
194
<div class="informaltable"><table width="100%" border="0">
195
<colgroup>
196
<col width="150px" class="parameters_name">
197
<col class="parameters_description">
198
<col width="200px" class="parameters_annotations">
199
</colgroup>
200
<tbody><tr>
201
<td class="parameter_name"><p>provider</p></td>
202
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
203
<td class="parameter_annotations"> </td>
204
</tr></tbody>
205
</table></div>
206
</div>
207
<div class="refsect3">
208
<a name="id-1.2.8.10.2.6"></a><h4>Returns</h4>
209
<p> a new string containing the name of the provider.</p>
210
<p></p>
211
</div>
212
</div>
213
<hr>
214
<div class="refsect2">
215
<a name="gtk-source-completion-provider-get-icon"></a><h3>gtk_source_completion_provider_get_icon ()</h3>
216
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *
217
gtk_source_completion_provider_get_icon
218
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
219
<p>Get the icon of the provider.</p>
220
<div class="refsect3">
221
<a name="id-1.2.8.10.3.5"></a><h4>Parameters</h4>
222
<div class="informaltable"><table width="100%" border="0">
223
<colgroup>
224
<col width="150px" class="parameters_name">
225
<col class="parameters_description">
226
<col width="200px" class="parameters_annotations">
227
</colgroup>
228
<tbody><tr>
229
<td class="parameter_name"><p>provider</p></td>
230
<td class="parameter_description"><p>The <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a></p></td>
231
<td class="parameter_annotations"> </td>
232
</tr></tbody>
233
</table></div>
234
</div>
235
<div class="refsect3">
236
<a name="id-1.2.8.10.3.6"></a><h4>Returns</h4>
237
<p> The icon to be used for the provider,
238
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the provider does not have a special icon. </p>
239
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
240
</div>
241
</div>
242
<hr>
243
<div class="refsect2">
244
<a name="gtk-source-completion-provider-populate"></a><h3>gtk_source_completion_provider_populate ()</h3>
245
<pre class="programlisting"><span class="returnvalue">void</span>
246
gtk_source_completion_provider_populate
247
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
248
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
249
<p>Populate <em class="parameter"><code>context</code></em>
250
with proposals from <em class="parameter"><code>provider</code></em>
251
added with the
252
<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> function.</p>
253
<div class="refsect3">
254
<a name="id-1.2.8.10.4.5"></a><h4>Parameters</h4>
255
<div class="informaltable"><table width="100%" border="0">
256
<colgroup>
257
<col width="150px" class="parameters_name">
258
<col class="parameters_description">
259
<col width="200px" class="parameters_annotations">
260
</colgroup>
261
<tbody>
262
<tr>
263
<td class="parameter_name"><p>provider</p></td>
264
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
265
<td class="parameter_annotations"> </td>
266
</tr>
267
<tr>
268
<td class="parameter_name"><p>context</p></td>
269
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
270
<td class="parameter_annotations"> </td>
271
</tr>
272
</tbody>
273
</table></div>
274
</div>
275
</div>
276
<hr>
277
<div class="refsect2">
278
<a name="gtk-source-completion-provider-get-activation"></a><h3>gtk_source_completion_provider_get_activation ()</h3>
279
<pre class="programlisting"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a>
280
gtk_source_completion_provider_get_activation
281
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
282
<p>Get with what kind of activation the provider should be activated.</p>
283
<div class="refsect3">
284
<a name="id-1.2.8.10.5.5"></a><h4>Parameters</h4>
285
<div class="informaltable"><table width="100%" border="0">
286
<colgroup>
287
<col width="150px" class="parameters_name">
288
<col class="parameters_description">
289
<col width="200px" class="parameters_annotations">
290
</colgroup>
291
<tbody><tr>
292
<td class="parameter_name"><p>provider</p></td>
293
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
294
<td class="parameter_annotations"> </td>
295
</tr></tbody>
296
</table></div>
297
</div>
298
<div class="refsect3">
299
<a name="id-1.2.8.10.5.6"></a><h4>Returns</h4>
300
<p> a combination of <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a>.</p>
301
<p></p>
302
</div>
303
</div>
304
<hr>
305
<div class="refsect2">
306
<a name="gtk-source-completion-provider-match"></a><h3>gtk_source_completion_provider_match ()</h3>
307
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
308
gtk_source_completion_provider_match (<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
309
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
310
<p>Get whether the provider match the context of completion detailed in
311
<em class="parameter"><code>context</code></em>
312
.</p>
313
<div class="refsect3">
314
<a name="id-1.2.8.10.6.5"></a><h4>Parameters</h4>
315
<div class="informaltable"><table width="100%" border="0">
316
<colgroup>
317
<col width="150px" class="parameters_name">
318
<col class="parameters_description">
319
<col width="200px" class="parameters_annotations">
320
</colgroup>
321
<tbody>
322
<tr>
323
<td class="parameter_name"><p>provider</p></td>
324
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
325
<td class="parameter_annotations"> </td>
326
</tr>
327
<tr>
328
<td class="parameter_name"><p>context</p></td>
329
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
330
<td class="parameter_annotations"> </td>
331
</tr>
332
</tbody>
333
</table></div>
334
</div>
335
<div class="refsect3">
336
<a name="id-1.2.8.10.6.6"></a><h4>Returns</h4>
337
<p> <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>
338
matches the completion context, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
339
<p></p>
340
</div>
341
</div>
342
<hr>
343
<div class="refsect2">
344
<a name="gtk-source-completion-provider-get-info-widget"></a><h3>gtk_source_completion_provider_get_info_widget ()</h3>
345
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
346
gtk_source_completion_provider_get_info_widget
347
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
348
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
349
<p>Get a customized info widget to show extra information of a proposal.
350
This allows for customized widgets on a proposal basis, although in general
351
providers will have the same custom widget for all their proposals and
352
<em class="parameter"><code>proposal</code></em>
353
can be ignored. The implementation of this function is optional.</p>
354
<p>If this function is not implemented, the default widget is a <a href="http://developer.gnome.org/gtk2/GtkLabel.html"><span class="type">GtkLabel</span></a>. The
355
return value of <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-info" title="gtk_source_completion_proposal_get_info ()"><code class="function">gtk_source_completion_proposal_get_info()</code></a> is used as the
356
content of the <a href="http://developer.gnome.org/gtk2/GtkLabel.html"><span class="type">GtkLabel</span></a>.</p>
357
<div class="note"><p>
358
If implemented, <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()"><code class="function">gtk_source_completion_provider_update_info()</code></a>
359
<span class="emphasis"><em>must</em></span> also be implemented.
360
</p></div>
361
<div class="refsect3">
362
<a name="id-1.2.8.10.7.7"></a><h4>Parameters</h4>
363
<div class="informaltable"><table width="100%" border="0">
364
<colgroup>
365
<col width="150px" class="parameters_name">
366
<col class="parameters_description">
367
<col width="200px" class="parameters_annotations">
368
</colgroup>
369
<tbody>
370
<tr>
371
<td class="parameter_name"><p>provider</p></td>
372
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
373
<td class="parameter_annotations"> </td>
374
</tr>
375
<tr>
376
<td class="parameter_name"><p>proposal</p></td>
377
<td class="parameter_description"><p>a currently selected <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</p></td>
378
<td class="parameter_annotations"> </td>
379
</tr>
380
</tbody>
381
</table></div>
382
</div>
383
<div class="refsect3">
384
<a name="id-1.2.8.10.7.8"></a><h4>Returns</h4>
385
<p> a custom <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> to show extra
386
information about <em class="parameter"><code>proposal</code></em>
387
. </p>
388
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
389
</div>
390
</div>
391
<hr>
392
<div class="refsect2">
393
<a name="gtk-source-completion-provider-update-info"></a><h3>gtk_source_completion_provider_update_info ()</h3>
394
<pre class="programlisting"><span class="returnvalue">void</span>
395
gtk_source_completion_provider_update_info
396
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
397
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
398
<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>);</pre>
399
<p>Update extra information shown in <em class="parameter"><code>info</code></em>
400
for <em class="parameter"><code>proposal</code></em>
401
.</p>
402
<div class="note"><p>
403
This function <span class="emphasis"><em>must</em></span> be implemented when
404
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()"><code class="function">gtk_source_completion_provider_get_info_widget()</code></a> is implemented.
405
</p></div>
406
<div class="refsect3">
407
<a name="id-1.2.8.10.8.6"></a><h4>Parameters</h4>
408
<div class="informaltable"><table width="100%" border="0">
409
<colgroup>
410
<col width="150px" class="parameters_name">
411
<col class="parameters_description">
412
<col width="200px" class="parameters_annotations">
413
</colgroup>
414
<tbody>
415
<tr>
416
<td class="parameter_name"><p>provider</p></td>
417
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
418
<td class="parameter_annotations"> </td>
419
</tr>
420
<tr>
421
<td class="parameter_name"><p>proposal</p></td>
422
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</p></td>
423
<td class="parameter_annotations"> </td>
424
</tr>
425
<tr>
426
<td class="parameter_name"><p>info</p></td>
427
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</p></td>
428
<td class="parameter_annotations"> </td>
429
</tr>
430
</tbody>
431
</table></div>
432
</div>
433
</div>
434
<hr>
435
<div class="refsect2">
436
<a name="gtk-source-completion-provider-get-start-iter"></a><h3>gtk_source_completion_provider_get_start_iter ()</h3>
437
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
438
gtk_source_completion_provider_get_start_iter
439
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
440
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
441
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
442
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
443
<p>Get the <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> at which the completion for <em class="parameter"><code>proposal</code></em>
444
starts. When
445
implemented, this information is used to position the completion window
446
accordingly when a proposal is selected in the completion window. The
447
<em class="parameter"><code>proposal</code></em>
448
text inside the completion window is aligned on <em class="parameter"><code>iter</code></em>
449
.</p>
450
<p>If this function is not implemented, the word boundary is taken to position
451
the completion window. See <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a>
452
for an explanation on the word boundaries.</p>
453
<p>When the <em class="parameter"><code>proposal</code></em>
454
is activated, the default handler uses <em class="parameter"><code>iter</code></em>
455
as the start
456
of the word to replace. See
457
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a> for more information.</p>
458
<div class="refsect3">
459
<a name="id-1.2.8.10.9.7"></a><h4>Parameters</h4>
460
<div class="informaltable"><table width="100%" border="0">
461
<colgroup>
462
<col width="150px" class="parameters_name">
463
<col class="parameters_description">
464
<col width="200px" class="parameters_annotations">
465
</colgroup>
466
<tbody>
467
<tr>
468
<td class="parameter_name"><p>provider</p></td>
469
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
470
<td class="parameter_annotations"> </td>
471
</tr>
472
<tr>
473
<td class="parameter_name"><p>proposal</p></td>
474
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</p></td>
475
<td class="parameter_annotations"> </td>
476
</tr>
477
<tr>
478
<td class="parameter_name"><p>context</p></td>
479
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</p></td>
480
<td class="parameter_annotations"> </td>
481
</tr>
482
<tr>
483
<td class="parameter_name"><p>iter</p></td>
484
<td class="parameter_description"><p>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>.</p></td>
485
<td class="parameter_annotations"> </td>
486
</tr>
487
</tbody>
488
</table></div>
489
</div>
490
<div class="refsect3">
491
<a name="id-1.2.8.10.9.8"></a><h4>Returns</h4>
492
<p> <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>iter</code></em>
493
was set for <em class="parameter"><code>proposal</code></em>
494
, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
495
<p></p>
496
</div>
497
</div>
498
<hr>
499
<div class="refsect2">
500
<a name="gtk-source-completion-provider-activate-proposal"></a><h3>gtk_source_completion_provider_activate_proposal ()</h3>
501
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
502
gtk_source_completion_provider_activate_proposal
503
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
504
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
505
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
506
<p>Activate <em class="parameter"><code>proposal</code></em>
507
at <em class="parameter"><code>iter</code></em>
508
. When this functions returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the default
509
activation of <em class="parameter"><code>proposal</code></em>
510
will take place which replaces the word at <em class="parameter"><code>iter</code></em>
511
512
with the text of <em class="parameter"><code>proposal</code></em>
513
(see <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-text" title="gtk_source_completion_proposal_get_text ()"><code class="function">gtk_source_completion_proposal_get_text()</code></a>).</p>
514
<p>Here is how the default activation selects the boundaries of the word to
515
replace. The end of the word is <em class="parameter"><code>iter</code></em>
516
. For the start of the word, it depends
517
on whether a start iter is defined for <em class="parameter"><code>proposal</code></em>
518
(see
519
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()"><code class="function">gtk_source_completion_provider_get_start_iter()</code></a>). If a start iter is defined,
520
the start of the word is the start iter. Else, the word (as long as possible)
521
will contain only alphanumerical and the "_" characters.</p>
522
<div class="refsect3">
523
<a name="id-1.2.8.10.10.6"></a><h4>Parameters</h4>
524
<div class="informaltable"><table width="100%" border="0">
525
<colgroup>
526
<col width="150px" class="parameters_name">
527
<col class="parameters_description">
528
<col width="200px" class="parameters_annotations">
529
</colgroup>
530
<tbody>
531
<tr>
532
<td class="parameter_name"><p>provider</p></td>
533
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
534
<td class="parameter_annotations"> </td>
535
</tr>
536
<tr>
537
<td class="parameter_name"><p>proposal</p></td>
538
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</p></td>
539
<td class="parameter_annotations"> </td>
540
</tr>
541
<tr>
542
<td class="parameter_name"><p>iter</p></td>
543
<td class="parameter_description"><p>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>.</p></td>
544
<td class="parameter_annotations"> </td>
545
</tr>
546
</tbody>
547
</table></div>
548
</div>
549
<div class="refsect3">
550
<a name="id-1.2.8.10.10.7"></a><h4>Returns</h4>
551
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to indicate that the proposal activation has been handled,
552
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
553
<p></p>
554
</div>
555
</div>
556
<hr>
557
<div class="refsect2">
558
<a name="gtk-source-completion-provider-get-interactive-delay"></a><h3>gtk_source_completion_provider_get_interactive_delay ()</h3>
559
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
560
gtk_source_completion_provider_get_interactive_delay
561
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
562
<p>Get the delay in milliseconds before starting interactive completion for
563
this provider. A value of -1 indicates to use the default value as set
564
by the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--auto-complete-delay" title="The “auto-complete-delay” property"><span class="type">“auto-complete-delay”</span></a> property.</p>
565
<div class="refsect3">
566
<a name="id-1.2.8.10.11.5"></a><h4>Parameters</h4>
567
<div class="informaltable"><table width="100%" border="0">
568
<colgroup>
569
<col width="150px" class="parameters_name">
570
<col class="parameters_description">
571
<col width="200px" class="parameters_annotations">
572
</colgroup>
573
<tbody><tr>
574
<td class="parameter_name"><p>provider</p></td>
575
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
576
<td class="parameter_annotations"> </td>
577
</tr></tbody>
578
</table></div>
579
</div>
580
<div class="refsect3">
581
<a name="id-1.2.8.10.11.6"></a><h4>Returns</h4>
582
<p> the interactive delay in milliseconds.</p>
583
<p></p>
584
</div>
585
</div>
586
<hr>
587
<div class="refsect2">
588
<a name="gtk-source-completion-provider-get-priority"></a><h3>gtk_source_completion_provider_get_priority ()</h3>
589
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
590
gtk_source_completion_provider_get_priority
591
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
592
<p>Get the provider priority. The priority determines the order in which
593
proposals appear in the completion popup. Higher priorities are sorted
594
before lower priorities. The default priority is 0.</p>
595
<div class="refsect3">
596
<a name="id-1.2.8.10.12.5"></a><h4>Parameters</h4>
597
<div class="informaltable"><table width="100%" border="0">
598
<colgroup>
599
<col width="150px" class="parameters_name">
600
<col class="parameters_description">
601
<col width="200px" class="parameters_annotations">
602
</colgroup>
603
<tbody><tr>
604
<td class="parameter_name"><p>provider</p></td>
605
<td class="parameter_description"><p>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p></td>
606
<td class="parameter_annotations"> </td>
607
</tr></tbody>
608
</table></div>
609
</div>
610
<div class="refsect3">
611
<a name="id-1.2.8.10.12.6"></a><h4>Returns</h4>
612
<p> the provider priority.</p>
613
<p></p>
614
</div>
615
</div>
616
</div>
617
<div class="refsect1">
618
<a name="GtkSourceCompletionProvider.other_details"></a><h2>Types and Values</h2>
109
619
<div class="refsect2">
110
620
<a name="GtkSourceCompletionProvider-struct"></a><h3>GtkSourceCompletionProvider</h3>
111
621
<pre class="programlisting">typedef struct _GtkSourceCompletionProvider GtkSourceCompletionProvider;</pre>
145
655
gint (*get_priority) (GtkSourceCompletionProvider *provider);
146
656
};
147
657
</pre>
148
<p>
149
The virtual function table for <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.
150
</p>
151
<div class="variablelist"><table border="0" class="variablelist">
152
<colgroup>
153
<col align="left" valign="top">
154
<col>
155
</colgroup>
156
<tbody>
157
<tr>
158
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GtkSourceCompletionProviderIface.g-iface"></a>g_iface</code></em>;</span></p></td>
159
<td>The parent interface.</td>
160
</tr>
161
<tr>
162
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-name"></a>get_name</code></em> ()</span></p></td>
163
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-name" title="gtk_source_completion_provider_get_name ()"><code class="function">gtk_source_completion_provider_get_name()</code></a>.
164
Must be implemented.</td>
165
</tr>
166
<tr>
167
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-icon"></a>get_icon</code></em> ()</span></p></td>
168
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-icon" title="gtk_source_completion_provider_get_icon ()"><code class="function">gtk_source_completion_provider_get_icon()</code></a>.
169
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</td>
170
</tr>
171
<tr>
172
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.populate"></a>populate</code></em> ()</span></p></td>
173
<td>The virtual function pointer for <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>.
174
Add no proposals by default.</td>
175
</tr>
176
<tr>
177
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.match"></a>match</code></em> ()</span></p></td>
178
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-match" title="gtk_source_completion_provider_match ()"><code class="function">gtk_source_completion_provider_match()</code></a>.
179
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.</td>
180
</tr>
181
<tr>
182
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-activation"></a>get_activation</code></em> ()</span></p></td>
183
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-activation" title="gtk_source_completion_provider_get_activation ()"><code class="function">gtk_source_completion_provider_get_activation()</code></a>.
184
The combination of all <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a> is returned by default.</td>
185
</tr>
186
<tr>
187
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-info-widget"></a>get_info_widget</code></em> ()</span></p></td>
188
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()"><code class="function">gtk_source_completion_provider_get_info_widget()</code></a>.
189
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</td>
190
</tr>
191
<tr>
192
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.update-info"></a>update_info</code></em> ()</span></p></td>
193
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()"><code class="function">gtk_source_completion_provider_update_info()</code></a>.
194
Does nothing by default.</td>
195
</tr>
196
<tr>
197
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-start-iter"></a>get_start_iter</code></em> ()</span></p></td>
198
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()"><code class="function">gtk_source_completion_provider_get_start_iter()</code></a>.
199
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</td>
200
</tr>
201
<tr>
202
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.activate-proposal"></a>activate_proposal</code></em> ()</span></p></td>
203
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a>.
204
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</td>
205
</tr>
206
<tr>
207
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-interactive-delay"></a>get_interactive_delay</code></em> ()</span></p></td>
208
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-interactive-delay" title="gtk_source_completion_provider_get_interactive_delay ()"><code class="function">gtk_source_completion_provider_get_interactive_delay()</code></a>.
209
By default, -1 is returned.</td>
210
</tr>
211
<tr>
212
<td><p><span class="term"><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-priority"></a>get_priority</code></em> ()</span></p></td>
213
<td>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-priority" title="gtk_source_completion_provider_get_priority ()"><code class="function">gtk_source_completion_provider_get_priority()</code></a>.
214
By default, 0 is returned.</td>
215
</tr>
216
</tbody>
217
</table></div>
218
</div>
219
<hr>
220
<div class="refsect2">
221
<a name="gtk-source-completion-provider-get-name"></a><h3>gtk_source_completion_provider_get_name ()</h3>
222
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gtk_source_completion_provider_get_name
223
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
224
<p>
225
Get the name of the provider. This should be a translatable name for
226
display to the user. For example: _("Document word completion provider"). The
227
returned string must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
228
</p>
229
<div class="variablelist"><table border="0" class="variablelist">
230
<colgroup>
231
<col align="left" valign="top">
232
<col>
233
</colgroup>
234
<tbody>
235
<tr>
236
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
237
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
238
</tr>
239
<tr>
240
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
241
<td>a new string containing the name of the provider.</td>
242
</tr>
243
</tbody>
244
</table></div>
245
</div>
246
<hr>
247
<div class="refsect2">
248
<a name="gtk-source-completion-provider-get-icon"></a><h3>gtk_source_completion_provider_get_icon ()</h3>
249
<pre class="programlisting"><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> * gtk_source_completion_provider_get_icon
250
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
251
<p>
252
Get the icon of the provider.
253
</p>
254
<div class="variablelist"><table border="0" class="variablelist">
255
<colgroup>
256
<col align="left" valign="top">
257
<col>
258
</colgroup>
259
<tbody>
260
<tr>
261
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
262
<td>The <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>
263
</td>
264
</tr>
265
<tr>
266
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
267
<td>The icon to be used for the provider,
268
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the provider does not have a special icon. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
269
</td>
270
</tr>
271
</tbody>
272
</table></div>
273
</div>
274
<hr>
275
<div class="refsect2">
276
<a name="gtk-source-completion-provider-populate"></a><h3>gtk_source_completion_provider_populate ()</h3>
277
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_provider_populate
278
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
279
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
280
<p>
281
Populate <em class="parameter"><code>context</code></em> with proposals from <em class="parameter"><code>provider</code></em> added with the
282
<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> function.
283
</p>
284
<div class="variablelist"><table border="0" class="variablelist">
285
<colgroup>
286
<col align="left" valign="top">
287
<col>
288
</colgroup>
289
<tbody>
290
<tr>
291
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
292
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
293
</tr>
294
<tr>
295
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
296
<td>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</td>
297
</tr>
298
</tbody>
299
</table></div>
300
</div>
301
<hr>
302
<div class="refsect2">
303
<a name="gtk-source-completion-provider-get-activation"></a><h3>gtk_source_completion_provider_get_activation ()</h3>
304
<pre class="programlisting"><a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="returnvalue">GtkSourceCompletionActivation</span></a> gtk_source_completion_provider_get_activation
305
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
306
<p>
307
Get with what kind of activation the provider should be activated.
308
</p>
309
<div class="variablelist"><table border="0" class="variablelist">
310
<colgroup>
311
<col align="left" valign="top">
312
<col>
313
</colgroup>
314
<tbody>
315
<tr>
316
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
317
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
318
</tr>
319
<tr>
320
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
321
<td>a combination of <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a>.</td>
322
</tr>
323
</tbody>
324
</table></div>
325
</div>
326
<hr>
327
<div class="refsect2">
328
<a name="gtk-source-completion-provider-match"></a><h3>gtk_source_completion_provider_match ()</h3>
329
<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_provider_match
330
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
331
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
332
<p>
333
Get whether the provider match the context of completion detailed in
334
<em class="parameter"><code>context</code></em>.
335
</p>
336
<div class="variablelist"><table border="0" class="variablelist">
337
<colgroup>
338
<col align="left" valign="top">
339
<col>
340
</colgroup>
341
<tbody>
342
<tr>
343
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
344
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
345
</tr>
346
<tr>
347
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
348
<td>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</td>
349
</tr>
350
<tr>
351
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
352
<td>
353
<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> matches the completion context, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
354
</tr>
355
</tbody>
356
</table></div>
357
</div>
358
<hr>
359
<div class="refsect2">
360
<a name="gtk-source-completion-provider-get-info-widget"></a><h3>gtk_source_completion_provider_get_info_widget ()</h3>
361
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gtk_source_completion_provider_get_info_widget
362
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
363
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
364
<p>
365
Get a customized info widget to show extra information of a proposal.
366
This allows for customized widgets on a proposal basis, although in general
367
providers will have the same custom widget for all their proposals and
368
<em class="parameter"><code>proposal</code></em> can be ignored. The implementation of this function is optional.
369
</p>
370
<p>
371
If this function is not implemented, the default widget is a <a href="http://developer.gnome.org/gtk2/GtkLabel.html"><span class="type">GtkLabel</span></a>. The
372
return value of <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-info" title="gtk_source_completion_proposal_get_info ()"><code class="function">gtk_source_completion_proposal_get_info()</code></a> is used as the
373
content of the <a href="http://developer.gnome.org/gtk2/GtkLabel.html"><span class="type">GtkLabel</span></a>.
374
</p>
375
<p>
376
</p>
377
<div class="note">
378
<h3 class="title">Note</h3>
379
<p>
380
If implemented, <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()"><code class="function">gtk_source_completion_provider_update_info()</code></a>
381
<span class="emphasis"><em>must</em></span> also be implemented.
382
</p>
383
</div>
384
<p>
385
</p>
386
<div class="variablelist"><table border="0" class="variablelist">
387
<colgroup>
388
<col align="left" valign="top">
389
<col>
390
</colgroup>
391
<tbody>
392
<tr>
393
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
394
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
395
</tr>
396
<tr>
397
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
398
<td>a currently selected <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
399
</tr>
400
<tr>
401
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
402
<td>a custom <a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="type">GtkWidget</span></a> to show extra
403
information about <em class="parameter"><code>proposal</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
404
</td>
405
</tr>
406
</tbody>
407
</table></div>
408
</div>
409
<hr>
410
<div class="refsect2">
411
<a name="gtk-source-completion-provider-update-info"></a><h3>gtk_source_completion_provider_update_info ()</h3>
412
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_provider_update_info
413
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
414
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
415
<em class="parameter"><code><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> *info</code></em>);</pre>
416
<p>
417
Update extra information shown in <em class="parameter"><code>info</code></em> for <em class="parameter"><code>proposal</code></em>.
418
</p>
419
<p>
420
</p>
421
<div class="note">
422
<h3 class="title">Note</h3>
423
<p>
424
This function <span class="emphasis"><em>must</em></span> be implemented when
425
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()"><code class="function">gtk_source_completion_provider_get_info_widget()</code></a> is implemented.
426
</p>
427
</div>
428
<p>
429
</p>
430
<div class="variablelist"><table border="0" class="variablelist">
431
<colgroup>
432
<col align="left" valign="top">
433
<col>
434
</colgroup>
435
<tbody>
436
<tr>
437
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
438
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
439
</tr>
440
<tr>
441
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
442
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
443
</tr>
444
<tr>
445
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
446
<td>a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a>.</td>
447
</tr>
448
</tbody>
449
</table></div>
450
</div>
451
<hr>
452
<div class="refsect2">
453
<a name="gtk-source-completion-provider-get-start-iter"></a><h3>gtk_source_completion_provider_get_start_iter ()</h3>
454
<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_provider_get_start_iter
455
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
456
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>,
457
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
458
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
459
<p>
460
Get the <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> at which the completion for <em class="parameter"><code>proposal</code></em> starts. When
461
implemented, this information is used to position the completion window
462
accordingly when a proposal is selected in the completion window. The
463
<em class="parameter"><code>proposal</code></em> text inside the completion window is aligned on <em class="parameter"><code>iter</code></em>.
464
</p>
465
<p>
466
If this function is not implemented, the word boundary is taken to position
467
the completion window. See <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a>
468
for an explanation on the word boundaries.
469
</p>
470
<p>
471
When the <em class="parameter"><code>proposal</code></em> is activated, the default handler uses <em class="parameter"><code>iter</code></em> as the start
472
of the word to replace. See
473
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a> for more information.
474
</p>
475
<div class="variablelist"><table border="0" class="variablelist">
476
<colgroup>
477
<col align="left" valign="top">
478
<col>
479
</colgroup>
480
<tbody>
481
<tr>
482
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
483
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
484
</tr>
485
<tr>
486
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
487
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
488
</tr>
489
<tr>
490
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
491
<td>a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.</td>
492
</tr>
493
<tr>
494
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
495
<td>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>.</td>
496
</tr>
497
<tr>
498
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
499
<td>
500
<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>iter</code></em> was set for <em class="parameter"><code>proposal</code></em>, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
501
</tr>
502
</tbody>
503
</table></div>
504
</div>
505
<hr>
506
<div class="refsect2">
507
<a name="gtk-source-completion-provider-activate-proposal"></a><h3>gtk_source_completion_provider_activate_proposal ()</h3>
508
<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_provider_activate_proposal
509
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
510
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
511
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre>
512
<p>
513
Activate <em class="parameter"><code>proposal</code></em> at <em class="parameter"><code>iter</code></em>. When this functions returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the default
514
activation of <em class="parameter"><code>proposal</code></em> will take place which replaces the word at <em class="parameter"><code>iter</code></em>
515
with the text of <em class="parameter"><code>proposal</code></em> (see <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-text" title="gtk_source_completion_proposal_get_text ()"><code class="function">gtk_source_completion_proposal_get_text()</code></a>).
516
</p>
517
<p>
518
Here is how the default activation selects the boundaries of the word to
519
replace. The end of the word is <em class="parameter"><code>iter</code></em>. For the start of the word, it depends
520
on whether a start iter is defined for <em class="parameter"><code>proposal</code></em> (see
521
<a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()"><code class="function">gtk_source_completion_provider_get_start_iter()</code></a>). If a start iter is defined,
522
the start of the word is the start iter. Else, the word (as long as possible)
523
will contain only alphanumerical and the "_" characters.
524
</p>
525
<div class="variablelist"><table border="0" class="variablelist">
526
<colgroup>
527
<col align="left" valign="top">
528
<col>
529
</colgroup>
530
<tbody>
531
<tr>
532
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
533
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
534
</tr>
535
<tr>
536
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
537
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
538
</tr>
539
<tr>
540
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
541
<td>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>.</td>
542
</tr>
543
<tr>
544
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
545
<td>
546
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to indicate that the proposal activation has been handled,
547
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
548
</tr>
549
</tbody>
550
</table></div>
551
</div>
552
<hr>
553
<div class="refsect2">
554
<a name="gtk-source-completion-provider-get-interactive-delay"></a><h3>gtk_source_completion_provider_get_interactive_delay ()</h3>
555
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gtk_source_completion_provider_get_interactive_delay
556
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
557
<p>
558
Get the delay in milliseconds before starting interactive completion for
559
this provider. A value of -1 indicates to use the default value as set
560
by the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--auto-complete-delay" title='The "auto-complete-delay" property'><span class="type">"auto-complete-delay"</span></a> property.
561
</p>
562
<div class="variablelist"><table border="0" class="variablelist">
563
<colgroup>
564
<col align="left" valign="top">
565
<col>
566
</colgroup>
567
<tbody>
568
<tr>
569
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
570
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
571
</tr>
572
<tr>
573
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
574
<td>the interactive delay in milliseconds.</td>
575
</tr>
576
</tbody>
577
</table></div>
578
</div>
579
<hr>
580
<div class="refsect2">
581
<a name="gtk-source-completion-provider-get-priority"></a><h3>gtk_source_completion_provider_get_priority ()</h3>
582
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gtk_source_completion_provider_get_priority
583
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>);</pre>
584
<p>
585
Get the provider priority. The priority determines the order in which
586
proposals appear in the completion popup. Higher priorities are sorted
587
before lower priorities. The default priority is 0.
588
</p>
589
<div class="variablelist"><table border="0" class="variablelist">
590
<colgroup>
591
<col align="left" valign="top">
592
<col>
593
</colgroup>
594
<tbody>
595
<tr>
596
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
597
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
598
</tr>
599
<tr>
600
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
601
<td>the provider priority.</td>
602
</tr>
603
</tbody>
604
</table></div>
658
<p>The virtual function table for <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</p>
659
<div class="refsect3">
660
<a name="id-1.2.8.11.3.5"></a><h4>Members</h4>
661
<div class="informaltable"><table width="100%" border="0">
662
<colgroup>
663
<col width="300px" class="struct_members_name">
664
<col class="struct_members_description">
665
<col width="200px" class="struct_members_annotations">
666
</colgroup>
667
<tbody>
668
<tr>
669
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GtkSourceCompletionProviderIface.g-iface"></a>g_iface</code></em>;</p></td>
670
<td class="struct_member_description"><p>The parent interface.</p></td>
671
<td class="struct_member_annotations"> </td>
672
</tr>
673
<tr>
674
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-name"></a>get_name</code></em> ()</p></td>
675
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-name" title="gtk_source_completion_provider_get_name ()"><code class="function">gtk_source_completion_provider_get_name()</code></a>.
676
Must be implemented.</p></td>
677
<td class="struct_member_annotations"> </td>
678
</tr>
679
<tr>
680
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-icon"></a>get_icon</code></em> ()</p></td>
681
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-icon" title="gtk_source_completion_provider_get_icon ()"><code class="function">gtk_source_completion_provider_get_icon()</code></a>.
682
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</p></td>
683
<td class="struct_member_annotations"> </td>
684
</tr>
685
<tr>
686
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.populate"></a>populate</code></em> ()</p></td>
687
<td class="struct_member_description"><p>The virtual function pointer for <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>.
688
Add no proposals by default.</p></td>
689
<td class="struct_member_annotations"> </td>
690
</tr>
691
<tr>
692
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.match"></a>match</code></em> ()</p></td>
693
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-match" title="gtk_source_completion_provider_match ()"><code class="function">gtk_source_completion_provider_match()</code></a>.
694
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.</p></td>
695
<td class="struct_member_annotations"> </td>
696
</tr>
697
<tr>
698
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-activation"></a>get_activation</code></em> ()</p></td>
699
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-activation" title="gtk_source_completion_provider_get_activation ()"><code class="function">gtk_source_completion_provider_get_activation()</code></a>.
700
The combination of all <a class="link" href="GtkSourceCompletionContext.html#GtkSourceCompletionActivation" title="enum GtkSourceCompletionActivation"><span class="type">GtkSourceCompletionActivation</span></a> is returned by default.</p></td>
701
<td class="struct_member_annotations"> </td>
702
</tr>
703
<tr>
704
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-info-widget"></a>get_info_widget</code></em> ()</p></td>
705
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-info-widget" title="gtk_source_completion_provider_get_info_widget ()"><code class="function">gtk_source_completion_provider_get_info_widget()</code></a>.
706
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.</p></td>
707
<td class="struct_member_annotations"> </td>
708
</tr>
709
<tr>
710
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.update-info"></a>update_info</code></em> ()</p></td>
711
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-update-info" title="gtk_source_completion_provider_update_info ()"><code class="function">gtk_source_completion_provider_update_info()</code></a>.
712
Does nothing by default.</p></td>
713
<td class="struct_member_annotations"> </td>
714
</tr>
715
<tr>
716
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-start-iter"></a>get_start_iter</code></em> ()</p></td>
717
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-start-iter" title="gtk_source_completion_provider_get_start_iter ()"><code class="function">gtk_source_completion_provider_get_start_iter()</code></a>.
718
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</p></td>
719
<td class="struct_member_annotations"> </td>
720
</tr>
721
<tr>
722
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.activate-proposal"></a>activate_proposal</code></em> ()</p></td>
723
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-activate-proposal" title="gtk_source_completion_provider_activate_proposal ()"><code class="function">gtk_source_completion_provider_activate_proposal()</code></a>.
724
By default, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned.</p></td>
725
<td class="struct_member_annotations"> </td>
726
</tr>
727
<tr>
728
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-interactive-delay"></a>get_interactive_delay</code></em> ()</p></td>
729
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-interactive-delay" title="gtk_source_completion_provider_get_interactive_delay ()"><code class="function">gtk_source_completion_provider_get_interactive_delay()</code></a>.
730
By default, -1 is returned.</p></td>
731
<td class="struct_member_annotations"> </td>
732
</tr>
733
<tr>
734
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkSourceCompletionProviderIface.get-priority"></a>get_priority</code></em> ()</p></td>
735
<td class="struct_member_description"><p>The virtual function pointer for <a class="link" href="GtkSourceCompletionProvider.html#gtk-source-completion-provider-get-priority" title="gtk_source_completion_provider_get_priority ()"><code class="function">gtk_source_completion_provider_get_priority()</code></a>.
736
By default, 0 is returned.</p></td>
737
<td class="struct_member_annotations"> </td>
738
</tr>
739
</tbody>
740
</table></div>
741
</div>
605
742
</div>
606
743
</div>
607
744
</div>
608
745
<div class="footer">
609
746
<hr>
610
Generated by GTK-Doc V1.19.1</div>
747
Generated by GTK-Doc V1.20.1</div>
611
748
</body>
612
749
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1