|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
2 |
<html> |
|
3 |
<head> |
|
4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
|
5 |
<title>GtkSourceCompletion</title> |
|
|
1.3.2
by Sebastien Bacher
Import upstream version 3.8.1 |
6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
7 |
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual"> |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
8 |
<link rel="up" href="ch01.html" title="API reference"> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
9 |
<link rel="prev" href="GtkSourceBuffer.html" title="GtkSourceBuffer"> |
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
10 |
<link rel="next" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"> |
|
1.1.35
by Sebastien Bacher
Import upstream version 3.8.2 |
11 |
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)"> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
13 |
</head> |
|
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="2"> |
|
16 |
<tr valign="middle"> |
|
17 |
<td><a accesskey="p" href="GtkSourceBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
18 |
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
19 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
20 |
<th width="100%" align="center">GtkSourceView 3 Reference Manual</th> |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
21 |
<td><a accesskey="n" href="GtkSourceCompletionContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
22 |
</tr> |
23 |
<tr><td colspan="5" class="shortcuts"> |
|
24 |
<a href="#GtkSourceCompletion.synopsis" class="shortcut">Top</a> |
|
25 |
| |
|
26 |
<a href="#GtkSourceCompletion.description" class="shortcut">Description</a> |
|
27 |
| |
|
28 |
<a href="#GtkSourceCompletion.object-hierarchy" class="shortcut">Object Hierarchy</a> |
|
29 |
| |
|
30 |
<a href="#GtkSourceCompletion.properties" class="shortcut">Properties</a> |
|
31 |
| |
|
32 |
<a href="#GtkSourceCompletion.signals" class="shortcut">Signals</a> |
|
33 |
</td></tr> |
|
34 |
</table> |
|
35 |
<div class="refentry"> |
|
36 |
<a name="GtkSourceCompletion"></a><div class="titlepage"></div> |
|
37 |
<div class="refnamediv"><table width="100%"><tr> |
|
38 |
<td valign="top"> |
|
39 |
<h2><span class="refentrytitle"><a name="GtkSourceCompletion.top_of_page"></a>GtkSourceCompletion</span></h2> |
|
40 |
<p>GtkSourceCompletion — Main Completion Object</p> |
|
41 |
</td> |
|
42 |
<td valign="top" align="right"></td> |
|
43 |
</tr></table></div> |
|
44 |
<div class="refsynopsisdiv"> |
|
45 |
<a name="GtkSourceCompletion.synopsis"></a><h2>Synopsis</h2> |
|
46 |
<pre class="synopsis"> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
47 |
#include <gtksourceview/gtksource.h> |
48 |
||
|
1.1.27
by Sebastien Bacher
Import upstream version 3.5.3 |
49 |
<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-struct" title="GtkSourceCompletion">GtkSourceCompletion</a>; |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
50 |
#define <a class="link" href="GtkSourceCompletion.html#GTK-SOURCE-COMPLETION-ERROR:CAPS" title="GTK_SOURCE_COMPLETION_ERROR">GTK_SOURCE_COMPLETION_ERROR</a> |
51 |
enum <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletionError" title="enum GtkSourceCompletionError">GtkSourceCompletionError</a>; |
|
52 |
||
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-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>, |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
54 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
55 |
<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>); |
56 |
<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> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
57 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>, |
58 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
59 |
<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>); |
60 |
<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>); |
|
61 |
<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>, |
|
62 |
<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>, |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
63 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>); |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
64 |
<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>); |
65 |
<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> |
|
66 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>); |
|
|
1.1.27
by Sebastien Bacher
Import upstream version 3.5.3 |
67 |
<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>); |
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
68 |
<a class="link" href="GtkSourceCompletionContext.html" title="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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
69 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
70 |
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *position</code></em>); |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
71 |
<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>, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
72 |
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>); |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
73 |
<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> |
74 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>); |
|
75 |
<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 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>); |
|
77 |
</pre> |
|
78 |
</div> |
|
79 |
<div class="refsect1"> |
|
80 |
<a name="GtkSourceCompletion.object-hierarchy"></a><h2>Object Hierarchy</h2> |
|
81 |
<pre class="synopsis"> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
82 |
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
83 |
+----GtkSourceCompletion |
84 |
</pre> |
|
85 |
</div> |
|
86 |
<div class="refsect1"> |
|
87 |
<a name="GtkSourceCompletion.properties"></a><h2>Properties</h2> |
|
88 |
<pre class="synopsis"> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
89 |
"<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 |
90 |
"<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 |
|
91 |
"<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 |
|
92 |
"<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 |
|
93 |
"<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 |
|
94 |
"<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 |
|
95 |
"<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 |
|
96 |
"<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 |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
97 |
"<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 |
98 |
</pre> |
|
99 |
</div> |
|
100 |
<div class="refsect1"> |
|
101 |
<a name="GtkSourceCompletion.signals"></a><h2>Signals</h2> |
|
102 |
<pre class="synopsis"> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
103 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-activate-proposal" title='The "activate-proposal" signal'>activate-proposal</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
104 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-hide" title='The "hide" signal'>hide</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
|
105 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-cursor" title='The "move-cursor" signal'>move-cursor</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
|
106 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-page" title='The "move-page" signal'>move-page</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
|
107 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-populate-context" title='The "populate-context" signal'>populate-context</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
|
108 |
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-show" title='The "show" signal'>show</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
109 |
</pre> |
110 |
</div> |
|
111 |
<div class="refsect1"> |
|
112 |
<a name="GtkSourceCompletion.description"></a><h2>Description</h2> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
113 |
<p> |
114 |
The completion system helps the user when he writes some text, such |
|
115 |
as words, command names, functions, and suchlike. Proposals can be |
|
116 |
shown, to complete the text the user is writing. Each proposal can |
|
117 |
contain an additional piece of information, that is displayed when |
|
118 |
the "Details" button is active. |
|
119 |
</p> |
|
120 |
<p> |
|
121 |
Proposals are created via a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>. There can |
|
122 |
be for example a provider to complete words (see |
|
123 |
<a class="link" href="GtkSourceCompletionWords.html" title="GtkSourceCompletionWords"><span class="type">GtkSourceCompletionWords</span></a>), another provider for the completion of |
|
124 |
function's names, etc. To add a provider, call |
|
125 |
<a class="link" href="GtkSourceCompletion.html#gtk-source-completion-add-provider" title="gtk_source_completion_add_provider ()"><code class="function">gtk_source_completion_add_provider()</code></a>. |
|
126 |
</p> |
|
127 |
<p> |
|
128 |
When the completion is activated, a <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> object is |
|
129 |
created. The providers are asked whether they match the context, with |
|
130 |
<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>. If a provider doesn't match the |
|
131 |
context, it will not be visible in the completion window. On the |
|
132 |
other hand, if the provider matches the context, its proposals will |
|
133 |
be displayed. |
|
134 |
</p> |
|
135 |
<p> |
|
136 |
When several providers match, they are all shown in the completion |
|
137 |
window, but one can switch between providers: see the |
|
138 |
<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-page" title='The "move-page" signal'><span class="type">"move-page"</span></a> signal. It is also possible to |
|
139 |
activate the first proposals with key bindings, see the |
|
140 |
<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--accelerators" title='The "accelerators" property'><span class="type">"accelerators"</span></a> property. |
|
141 |
</p> |
|
142 |
<p> |
|
143 |
The <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> interface represents a proposal. |
|
144 |
The <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a> class is a simple implementation of this |
|
145 |
interface. |
|
146 |
</p> |
|
147 |
<p> |
|
148 |
If a proposal contains extra information (see |
|
149 |
<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>), it will be |
|
150 |
displayed in a <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> window, which appears when |
|
151 |
the "Details" button is clicked. |
|
152 |
</p> |
|
153 |
<p> |
|
154 |
A <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> window can also be used to display |
|
155 |
calltips. When no proposals are available, it can be useful to |
|
156 |
display extra information like a function's prototype (number of |
|
157 |
parameters, types of parameters, etc). |
|
158 |
</p> |
|
159 |
<p> |
|
160 |
Each <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> object is associated with a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> |
|
161 |
instance. This instance can be obtained with |
|
162 |
<a class="link" href="GtkSourceView.html#gtk-source-view-get-completion" title="gtk_source_view_get_completion ()"><code class="function">gtk_source_view_get_completion()</code></a>. The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> class contains also the |
|
163 |
<a class="link" href="GtkSourceView.html#GtkSourceView-show-completion" title='The "show-completion" signal'><span class="type">"show-completion"</span></a> signal. |
|
164 |
</p> |
|
165 |
<p> |
|
166 |
A same <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> object can be used for several |
|
167 |
<a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>. |
|
168 |
</p> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
169 |
</div> |
170 |
<div class="refsect1"> |
|
171 |
<a name="GtkSourceCompletion.details"></a><h2>Details</h2> |
|
172 |
<div class="refsect2"> |
|
|
1.1.27
by Sebastien Bacher
Import upstream version 3.5.3 |
173 |
<a name="GtkSourceCompletion-struct"></a><h3>GtkSourceCompletion</h3> |
174 |
<pre class="programlisting">typedef struct _GtkSourceCompletion GtkSourceCompletion;</pre> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
175 |
</div> |
176 |
<hr> |
|
177 |
<div class="refsect2"> |
|
178 |
<a name="GTK-SOURCE-COMPLETION-ERROR:CAPS"></a><h3>GTK_SOURCE_COMPLETION_ERROR</h3> |
|
179 |
<pre class="programlisting">#define GTK_SOURCE_COMPLETION_ERROR (gtk_source_completion_error_quark ()) |
|
180 |
</pre> |
|
181 |
<p> |
|
182 |
Error domain for the completion. Errors in this domain will be from the |
|
183 |
<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletionError" title="enum GtkSourceCompletionError"><span class="type">GtkSourceCompletionError</span></a> enumeration. See <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> for more information on |
|
184 |
error domains. |
|
185 |
</p> |
|
186 |
</div> |
|
187 |
<hr> |
|
188 |
<div class="refsect2"> |
|
189 |
<a name="GtkSourceCompletionError"></a><h3>enum GtkSourceCompletionError</h3> |
|
190 |
<pre class="programlisting">typedef enum { |
|
191 |
GTK_SOURCE_COMPLETION_ERROR_ALREADY_BOUND = 0, |
|
192 |
GTK_SOURCE_COMPLETION_ERROR_NOT_BOUND |
|
193 |
} GtkSourceCompletionError; |
|
194 |
</pre> |
|
195 |
<p> |
|
196 |
An error code used with <a class="link" href="GtkSourceCompletion.html#GTK-SOURCE-COMPLETION-ERROR:CAPS" title="GTK_SOURCE_COMPLETION_ERROR"><code class="literal">GTK_SOURCE_COMPLETION_ERROR</code></a> in a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> returned |
|
197 |
from a completion-related function. |
|
198 |
</p> |
|
199 |
<div class="variablelist"><table border="0" class="variablelist"> |
|
200 |
<colgroup> |
|
201 |
<col align="left" valign="top"> |
|
202 |
<col> |
|
203 |
</colgroup> |
|
204 |
<tbody> |
|
205 |
<tr> |
|
206 |
<td><p><a name="GTK-SOURCE-COMPLETION-ERROR-ALREADY-BOUND:CAPS"></a><span class="term"><code class="literal">GTK_SOURCE_COMPLETION_ERROR_ALREADY_BOUND</code></span></p></td> |
|
207 |
<td>The <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> |
|
208 |
is already bound to the <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> object. |
|
209 |
</td> |
|
210 |
</tr> |
|
211 |
<tr> |
|
212 |
<td><p><a name="GTK-SOURCE-COMPLETION-ERROR-NOT-BOUND:CAPS"></a><span class="term"><code class="literal">GTK_SOURCE_COMPLETION_ERROR_NOT_BOUND</code></span></p></td> |
|
213 |
<td>The <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> is |
|
214 |
not bound to the <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> object. |
|
215 |
</td> |
|
216 |
</tr> |
|
217 |
</tbody> |
|
218 |
</table></div> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
219 |
</div> |
220 |
<hr> |
|
221 |
<div class="refsect2"> |
|
222 |
<a name="gtk-source-completion-add-provider"></a><h3>gtk_source_completion_add_provider ()</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
223 |
<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>, |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
224 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
225 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
226 |
<p> |
227 |
Add a new <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> to the completion object. This will |
|
228 |
add a reference <em class="parameter"><code>provider</code></em>, so make sure to unref your own copy when you |
|
229 |
no longer need it. |
|
230 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
231 |
<div class="variablelist"><table border="0" class="variablelist"> |
232 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
233 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
234 |
<col> |
235 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
236 |
<tbody> |
237 |
<tr> |
|
238 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
239 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
240 |
</tr> |
|
241 |
<tr> |
|
242 |
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> |
|
243 |
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td> |
|
244 |
</tr> |
|
245 |
<tr> |
|
246 |
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
247 |
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
248 |
</td> |
249 |
</tr> |
|
250 |
<tr> |
|
251 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
252 |
<td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
253 |
<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> |
254 |
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.</td> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
255 |
</tr> |
256 |
</tbody> |
|
257 |
</table></div> |
|
258 |
</div> |
|
259 |
<hr> |
|
260 |
<div class="refsect2"> |
|
261 |
<a name="gtk-source-completion-remove-provider"></a><h3>gtk_source_completion_remove_provider ()</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
262 |
<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 |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
263 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>, |
264 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
265 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
266 |
<p> |
267 |
Remove <em class="parameter"><code>provider</code></em> from the completion. |
|
268 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
269 |
<div class="variablelist"><table border="0" class="variablelist"> |
270 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
271 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
272 |
<col> |
273 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
274 |
<tbody> |
275 |
<tr> |
|
276 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
277 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
278 |
</tr> |
|
279 |
<tr> |
|
280 |
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> |
|
281 |
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td> |
|
282 |
</tr> |
|
283 |
<tr> |
|
284 |
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
285 |
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
286 |
</td> |
287 |
</tr> |
|
288 |
<tr> |
|
289 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
290 |
<td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
291 |
<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> |
292 |
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.</td> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
293 |
</tr> |
294 |
</tbody> |
|
295 |
</table></div> |
|
296 |
</div> |
|
297 |
<hr> |
|
298 |
<div class="refsect2"> |
|
299 |
<a name="gtk-source-completion-get-providers"></a><h3>gtk_source_completion_get_providers ()</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
300 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
301 |
<p> |
302 |
Get list of providers registered on <em class="parameter"><code>completion</code></em>. The returned list is owned |
|
303 |
by the completion and should not be freed. |
|
304 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
305 |
<div class="variablelist"><table border="0" class="variablelist"> |
306 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
307 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
308 |
<col> |
309 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
310 |
<tbody> |
311 |
<tr> |
|
312 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
313 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
314 |
</tr> |
|
315 |
<tr> |
|
316 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
317 |
<td>list of <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkSource.CompletionProvider][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> |
|
318 |
</td> |
|
319 |
</tr> |
|
320 |
</tbody> |
|
321 |
</table></div> |
|
322 |
</div> |
|
323 |
<hr> |
|
324 |
<div class="refsect2"> |
|
325 |
<a name="gtk-source-completion-show"></a><h3>gtk_source_completion_show ()</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
326 |
<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>, |
327 |
<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>, |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
328 |
<em class="parameter"><code><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
329 |
<p> |
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
330 |
Starts a new completion with the specified <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> and |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
331 |
a list of potential candidate providers for completion. |
332 |
</p> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
333 |
<p> |
334 |
It can be convenient for showing a completion on-the-fly, without the need to |
|
335 |
add or remove providers to the <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>. |
|
336 |
</p> |
|
337 |
<p> |
|
338 |
Another solution is to add providers with |
|
339 |
<a class="link" href="GtkSourceCompletion.html#gtk-source-completion-add-provider" title="gtk_source_completion_add_provider ()"><code class="function">gtk_source_completion_add_provider()</code></a>, and implement |
|
340 |
<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> for each provider. |
|
341 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
342 |
<div class="variablelist"><table border="0" class="variablelist"> |
343 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
344 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
345 |
<col> |
346 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
347 |
<tbody> |
348 |
<tr> |
|
349 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
350 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
351 |
</tr> |
|
352 |
<tr> |
|
353 |
<td><p><span class="term"><em class="parameter"><code>providers</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
354 |
<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>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkSource.CompletionProvider][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
355 |
</td> |
356 |
</tr> |
|
357 |
<tr> |
|
358 |
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
359 |
<td>The <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> |
|
1.1.31
by Sebastien Bacher
Import upstream version 3.6.2 |
360 |
with which to start the completion. <span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
361 |
</td> |
362 |
</tr> |
|
363 |
<tr> |
|
364 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
365 |
<td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
366 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if it was possible to the show completion window.</td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
367 |
</tr> |
368 |
</tbody> |
|
369 |
</table></div> |
|
370 |
</div> |
|
371 |
<hr> |
|
372 |
<div class="refsect2"> |
|
373 |
<a name="gtk-source-completion-hide"></a><h3>gtk_source_completion_hide ()</h3> |
|
374 |
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_hide (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre> |
|
375 |
<p> |
|
376 |
Hides the completion if it is active (visible). |
|
377 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
378 |
<div class="variablelist"><table border="0" class="variablelist"> |
379 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
380 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
381 |
<col> |
382 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
383 |
<tbody><tr> |
384 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
385 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
386 |
</tr></tbody> |
|
387 |
</table></div> |
|
388 |
</div> |
|
389 |
<hr> |
|
390 |
<div class="refsect2"> |
|
391 |
<a name="gtk-source-completion-get-info-window"></a><h3>gtk_source_completion_get_info_window ()</h3> |
|
392 |
<pre class="programlisting"><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> * gtk_source_completion_get_info_window |
|
393 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre> |
|
394 |
<p> |
|
395 |
The info widget is the window where the completion displays optional extra |
|
396 |
information of the proposal. |
|
397 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
398 |
<div class="variablelist"><table border="0" class="variablelist"> |
399 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
400 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
401 |
<col> |
402 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
403 |
<tbody> |
404 |
<tr> |
|
405 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
406 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
407 |
</tr> |
|
408 |
<tr> |
|
409 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
410 |
<td>The <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> window |
|
411 |
associated with <em class="parameter"><code>completion</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> |
|
412 |
</td> |
|
413 |
</tr> |
|
414 |
</tbody> |
|
415 |
</table></div> |
|
416 |
</div> |
|
417 |
<hr> |
|
418 |
<div class="refsect2"> |
|
419 |
<a name="gtk-source-completion-get-view"></a><h3>gtk_source_completion_get_view ()</h3> |
|
|
1.1.27
by Sebastien Bacher
Import upstream version 3.5.3 |
420 |
<pre class="programlisting"><a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="returnvalue">GtkSourceView</span></a> * gtk_source_completion_get_view (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
421 |
<p> |
422 |
The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> associated with <em class="parameter"><code>completion</code></em>. |
|
423 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
424 |
<div class="variablelist"><table border="0" class="variablelist"> |
425 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
426 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
427 |
<col> |
428 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
429 |
<tbody> |
430 |
<tr> |
|
431 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
432 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
433 |
</tr> |
|
434 |
<tr> |
|
435 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
|
1.1.23
by Sebastien Bacher
Import upstream version 3.4.0 |
436 |
<td>The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> associated with <em class="parameter"><code>completion</code></em>. <span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GtkSource.View][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
437 |
</td> |
438 |
</tr> |
|
439 |
</tbody> |
|
440 |
</table></div> |
|
441 |
</div> |
|
442 |
<hr> |
|
443 |
<div class="refsect2"> |
|
444 |
<a name="gtk-source-completion-create-context"></a><h3>gtk_source_completion_create_context ()</h3> |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
445 |
<pre class="programlisting"><a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="returnvalue">GtkSourceCompletionContext</span></a> * gtk_source_completion_create_context |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
446 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
447 |
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *position</code></em>);</pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
448 |
<p> |
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
449 |
Create a new <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> for <em class="parameter"><code>completion</code></em>. The position where |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
450 |
the completion occurs can be specified 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>, |
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
451 |
the current cursor position will be used. |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
452 |
</p> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
453 |
<div class="variablelist"><table border="0" class="variablelist"> |
454 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
455 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
456 |
<col> |
457 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
458 |
<tbody> |
459 |
<tr> |
|
460 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
461 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
462 |
</tr> |
|
463 |
<tr> |
|
464 |
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
465 |
<td>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
466 |
</td> |
467 |
</tr> |
|
468 |
<tr> |
|
469 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
470 |
<td>a new <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>. |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
471 |
The reference being returned is a 'floating' reference, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
472 |
so if you invoke <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-show" title="gtk_source_completion_show ()"><code class="function">gtk_source_completion_show()</code></a> with this context |
|
1.1.31
by Sebastien Bacher
Import upstream version 3.6.2 |
473 |
you don't need to unref it. <span class="annotation">[<acronym title="Alias for transfer none, used for objects with floating refs."><span class="acronym">transfer floating</span></acronym>]</span> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
474 |
</td> |
475 |
</tr> |
|
476 |
</tbody> |
|
477 |
</table></div> |
|
478 |
</div> |
|
479 |
<hr> |
|
480 |
<div class="refsect2"> |
|
481 |
<a name="gtk-source-completion-move-window"></a><h3>gtk_source_completion_move_window ()</h3> |
|
482 |
<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>, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
483 |
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a> *iter</code></em>);</pre> |
484 |
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> |
|
485 |
<h3 class="title">Warning</h3> |
|
486 |
<p><code class="literal">gtk_source_completion_move_window</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <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> instead.</p> |
|
487 |
</div> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
488 |
<p> |
489 |
Move the completion window to a specific iter. |
|
490 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
491 |
<div class="variablelist"><table border="0" class="variablelist"> |
492 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
493 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
494 |
<col> |
495 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
496 |
<tbody> |
497 |
<tr> |
|
498 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
499 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
500 |
</tr> |
|
501 |
<tr> |
|
502 |
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
503 |
<td>a <a href="http://developer.gnome.org/gtk2/GtkTextIter.html"><span class="type">GtkTextIter</span></a>.</td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
504 |
</tr> |
505 |
</tbody> |
|
506 |
</table></div> |
|
507 |
</div> |
|
508 |
<hr> |
|
509 |
<div class="refsect2"> |
|
510 |
<a name="gtk-source-completion-block-interactive"></a><h3>gtk_source_completion_block_interactive ()</h3> |
|
511 |
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_block_interactive |
|
512 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
513 |
<p> |
514 |
Block interactive completion. This can be used to disable interactive |
|
515 |
completion when inserting or deleting text from the buffer associated with |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
516 |
the completion. Use <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-unblock-interactive" title="gtk_source_completion_unblock_interactive ()"><code class="function">gtk_source_completion_unblock_interactive()</code></a> to enable |
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
517 |
interactive completion again. |
518 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
519 |
<div class="variablelist"><table border="0" class="variablelist"> |
520 |
<colgroup> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
521 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
522 |
<col> |
523 |
</colgroup> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
524 |
<tbody><tr> |
525 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
526 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
527 |
</tr></tbody> |
|
528 |
</table></div> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
529 |
</div> |
530 |
<hr> |
|
531 |
<div class="refsect2"> |
|
532 |
<a name="gtk-source-completion-unblock-interactive"></a><h3>gtk_source_completion_unblock_interactive ()</h3> |
|
533 |
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_unblock_interactive |
|
534 |
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
535 |
<p> |
536 |
Unblock interactive completion. This can be used after using |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
537 |
<a class="link" href="GtkSourceCompletion.html#gtk-source-completion-block-interactive" title="gtk_source_completion_block_interactive ()"><code class="function">gtk_source_completion_block_interactive()</code></a> to enable interactive completion |
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
538 |
again. |
539 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
540 |
<div class="variablelist"><table border="0" class="variablelist"> |
541 |
<colgroup> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
542 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
543 |
<col> |
544 |
</colgroup> |
|
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
545 |
<tbody><tr> |
546 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
547 |
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td> |
|
548 |
</tr></tbody> |
|
549 |
</table></div> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
550 |
</div> |
551 |
</div> |
|
552 |
<div class="refsect1"> |
|
553 |
<a name="GtkSourceCompletion.property-details"></a><h2>Property Details</h2> |
|
554 |
<div class="refsect2"> |
|
555 |
<a name="GtkSourceCompletion--accelerators"></a><h3>The <code class="literal">"accelerators"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
556 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
557 |
<p> |
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
558 |
Number of keyboard accelerators to show for the first proposals. For |
559 |
example, to activate the first proposal, the user can press |
|
560 |
<span class="keycap"><strong>Alt</strong></span>+<span class="keycap"><strong>1</strong></span>. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
561 |
</p> |
562 |
<p>Allowed values: <= 10</p> |
|
563 |
<p>Default value: 5</p> |
|
564 |
</div> |
|
565 |
<hr> |
|
566 |
<div class="refsect2"> |
|
567 |
<a name="GtkSourceCompletion--auto-complete-delay"></a><h3>The <code class="literal">"auto-complete-delay"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
568 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
569 |
<p> |
570 |
Determines the popup delay (in milliseconds) at which the completion |
|
571 |
will be shown for interactive completion. |
|
572 |
</p> |
|
573 |
<p>Default value: 250</p> |
|
574 |
</div> |
|
575 |
<hr> |
|
576 |
<div class="refsect2"> |
|
577 |
<a name="GtkSourceCompletion--proposal-page-size"></a><h3>The <code class="literal">"proposal-page-size"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
578 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
579 |
<p> |
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
580 |
The scroll page size of the proposals in the completion window. In |
581 |
other words, when <span class="keycap"><strong>PageDown</strong></span> or |
|
582 |
<span class="keycap"><strong>PageUp</strong></span> is pressed, the selected |
|
583 |
proposal becomes the one which is located one page size backward or |
|
584 |
forward. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
585 |
</p> |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
586 |
<p> |
587 |
See also the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-cursor" title='The "move-cursor" signal'><span class="type">"move-cursor"</span></a> signal. |
|
588 |
</p> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
589 |
<p>Allowed values: >= 1</p> |
590 |
<p>Default value: 5</p> |
|
591 |
</div> |
|
592 |
<hr> |
|
593 |
<div class="refsect2"> |
|
594 |
<a name="GtkSourceCompletion--provider-page-size"></a><h3>The <code class="literal">"provider-page-size"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
595 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
596 |
<p> |
597 |
The scroll page size of the provider pages in the completion window. |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
598 |
</p> |
599 |
<p> |
|
600 |
See the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-page" title='The "move-page" signal'><span class="type">"move-page"</span></a> signal. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
601 |
</p> |
602 |
<p>Allowed values: >= 1</p> |
|
603 |
<p>Default value: 5</p> |
|
604 |
</div> |
|
605 |
<hr> |
|
606 |
<div class="refsect2"> |
|
607 |
<a name="GtkSourceCompletion--remember-info-visibility"></a><h3>The <code class="literal">"remember-info-visibility"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
608 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
609 |
<p> |
610 |
Determines whether the visibility of the info window should be |
|
611 |
saved when the completion is hidden, and restored when the completion |
|
612 |
is shown again. |
|
613 |
</p> |
|
614 |
<p>Default value: FALSE</p> |
|
615 |
</div> |
|
616 |
<hr> |
|
617 |
<div class="refsect2"> |
|
618 |
<a name="GtkSourceCompletion--select-on-show"></a><h3>The <code class="literal">"select-on-show"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
619 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
620 |
<p> |
621 |
Determines whether the first proposal should be selected when the |
|
622 |
completion is first shown. |
|
623 |
</p> |
|
624 |
<p>Default value: TRUE</p> |
|
625 |
</div> |
|
626 |
<hr> |
|
627 |
<div class="refsect2"> |
|
628 |
<a name="GtkSourceCompletion--show-headers"></a><h3>The <code class="literal">"show-headers"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
629 |
<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> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
630 |
<p> |
631 |
Determines whether provider headers should be shown in the proposal |
|
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
632 |
list. It can be useful to disable when there is only one provider. |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
633 |
</p> |
634 |
<p>Default value: TRUE</p> |
|
635 |
</div> |
|
636 |
<hr> |
|
637 |
<div class="refsect2"> |
|
638 |
<a name="GtkSourceCompletion--show-icons"></a><h3>The <code class="literal">"show-icons"</code> property</h3> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
639 |
<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> |
|
0.2.1
by Emilio Pozuelo Monfort
Import upstream version 2.91.4 |
640 |
<p> |
641 |
Determines whether provider and proposal icons should be shown in |
|
642 |
the completion popup. |
|
643 |
</p> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
644 |
<p>Default value: TRUE</p> |
645 |
</div> |
|
646 |
<hr> |
|
647 |
<div class="refsect2"> |
|
648 |
<a name="GtkSourceCompletion--view"></a><h3>The <code class="literal">"view"</code> property</h3> |
|
649 |
<pre class="programlisting"> "view" <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>* : Read / Write / Construct Only</pre> |
|
650 |
<p> |
|
651 |
The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> bound to the completion object. |
|
652 |
</p> |
|
653 |
</div> |
|
654 |
</div> |
|
655 |
<div class="refsect1"> |
|
656 |
<a name="GtkSourceCompletion.signal-details"></a><h2>Signal Details</h2> |
|
657 |
<div class="refsect2"> |
|
658 |
<a name="GtkSourceCompletion-activate-proposal"></a><h3>The <code class="literal">"activate-proposal"</code> signal</h3> |
|
659 |
<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, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
660 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
661 |
<p> |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
662 |
The <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-activate-proposal" title='The "activate-proposal" signal'><span class="type">"activate-proposal"</span></a> signal is a |
663 |
keybinding signal which gets emitted when the user initiates |
|
664 |
a proposal activation. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
665 |
</p> |
666 |
<p> |
|
667 |
Applications should not connect to it, but may emit it with |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
668 |
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><code class="function">g_signal_emit_by_name()</code></a> if they need to control the proposal |
669 |
activation programmatically. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
670 |
</p> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
671 |
<div class="variablelist"><table border="0" class="variablelist"> |
672 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
673 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
674 |
<col> |
675 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
676 |
<tbody> |
677 |
<tr> |
|
678 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
679 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
680 |
</tr> |
|
681 |
<tr> |
|
682 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
683 |
<td>user data set when the signal handler was connected.</td> |
|
684 |
</tr> |
|
685 |
</tbody> |
|
686 |
</table></div> |
|
687 |
</div> |
|
688 |
<hr> |
|
689 |
<div class="refsect2"> |
|
690 |
<a name="GtkSourceCompletion-hide"></a><h3>The <code class="literal">"hide"</code> signal</h3> |
|
691 |
<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, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
692 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
693 |
<p> |
694 |
Emitted when the completion window is hidden. The default handler |
|
695 |
will actually hide the window. |
|
696 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
697 |
<div class="variablelist"><table border="0" class="variablelist"> |
698 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
699 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
700 |
<col> |
701 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
702 |
<tbody> |
703 |
<tr> |
|
704 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
705 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
706 |
</tr> |
|
707 |
<tr> |
|
708 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
709 |
<td>user data set when the signal handler was connected.</td> |
|
710 |
</tr> |
|
711 |
</tbody> |
|
712 |
</table></div> |
|
713 |
</div> |
|
714 |
<hr> |
|
715 |
<div class="refsect2"> |
|
716 |
<a name="GtkSourceCompletion-move-cursor"></a><h3>The <code class="literal">"move-cursor"</code> signal</h3> |
|
717 |
<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, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
718 |
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> step, |
719 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> num, |
|
720 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
721 |
<p> |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
722 |
The <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-cursor" title='The "move-cursor" signal'><span class="type">"move-cursor"</span></a> signal is a keybinding |
723 |
signal which gets emitted when the user initiates a cursor |
|
724 |
movement. |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
725 |
</p> |
726 |
<p> |
|
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
727 |
The <span class="keycap"><strong>Up</strong></span>, <span class="keycap"><strong>Down</strong></span>, |
728 |
<span class="keycap"><strong>PageUp</strong></span>, <span class="keycap"><strong>PageDown</strong></span>, |
|
729 |
<span class="keycap"><strong>Home</strong></span> and <span class="keycap"><strong>End</strong></span> keys are bound to the |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
730 |
normal behavior expected by those keys. |
731 |
</p> |
|
732 |
<p> |
|
733 |
When <em class="parameter"><code>step</code></em> is equal to <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GTK-SCROLL-PAGES:CAPS"><span class="type">GTK_SCROLL_PAGES</span></a>, the page size is defined by |
|
734 |
the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--proposal-page-size" title='The "proposal-page-size" property'><span class="type">"proposal-page-size"</span></a> property. It is used for |
|
735 |
the <span class="keycap"><strong>PageDown</strong></span> and <span class="keycap"><strong>PageUp</strong></span> keys. |
|
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
736 |
</p> |
737 |
<p> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
738 |
Applications should not connect to it, but may emit it with |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
739 |
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><code class="function">g_signal_emit_by_name()</code></a> if they need to control the cursor |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
740 |
programmatically. |
741 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
742 |
<div class="variablelist"><table border="0" class="variablelist"> |
743 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
744 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
745 |
<col> |
746 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
747 |
<tbody> |
748 |
<tr> |
|
749 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
750 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
751 |
</tr> |
|
752 |
<tr> |
|
753 |
<td><p><span class="term"><em class="parameter"><code>step</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
754 |
<td>The <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> by which to move the cursor</td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
755 |
</tr> |
756 |
<tr> |
|
757 |
<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td> |
|
758 |
<td>The amount of steps to move the cursor</td> |
|
759 |
</tr> |
|
760 |
<tr> |
|
761 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
762 |
<td>user data set when the signal handler was connected.</td> |
|
763 |
</tr> |
|
764 |
</tbody> |
|
765 |
</table></div> |
|
766 |
</div> |
|
767 |
<hr> |
|
768 |
<div class="refsect2"> |
|
769 |
<a name="GtkSourceCompletion-move-page"></a><h3>The <code class="literal">"move-page"</code> signal</h3> |
|
770 |
<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, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
771 |
<a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> step, |
772 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> num, |
|
773 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
774 |
<p> |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
775 |
The <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-page" title='The "move-page" signal'><span class="type">"move-page"</span></a> signal is a keybinding |
776 |
signal which gets emitted when the user initiates a page |
|
777 |
movement (i.e. switches between provider pages). |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
778 |
</p> |
779 |
<p> |
|
|
1.1.25
by Sebastien Bacher
Import upstream version 3.4.2 |
780 |
<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Left</strong></span> |
781 |
is for going to the previous provider. |
|
782 |
<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Right</strong></span> |
|
783 |
is for going to the next provider. |
|
784 |
<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Home</strong></span> |
|
785 |
is for displaying all the providers. |
|
786 |
<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>End</strong></span> |
|
787 |
is for going to the last provider. |
|
788 |
</p> |
|
789 |
<p> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
790 |
When <em class="parameter"><code>step</code></em> is equal to <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GTK-SCROLL-PAGES:CAPS"><span class="type">GTK_SCROLL_PAGES</span></a>, the page size is defined by |
791 |
the <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--provider-page-size" title='The "provider-page-size" property'><span class="type">"provider-page-size"</span></a> property. |
|
792 |
</p> |
|
793 |
<p> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
794 |
Applications should not connect to it, but may emit it with |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
795 |
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#g-signal-emit-by-name"><code class="function">g_signal_emit_by_name()</code></a> if they need to control the page selection |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
796 |
programmatically. |
797 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
798 |
<div class="variablelist"><table border="0" class="variablelist"> |
799 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
800 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
801 |
<col> |
802 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
803 |
<tbody> |
804 |
<tr> |
|
805 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
806 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
807 |
</tr> |
|
808 |
<tr> |
|
809 |
<td><p><span class="term"><em class="parameter"><code>step</code></em> :</span></p></td> |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
810 |
<td>The <a href="http://developer.gnome.org/gtk2/gtk3-Standard-Enumerations.html#GtkScrollStep"><span class="type">GtkScrollStep</span></a> by which to move the page</td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
811 |
</tr> |
812 |
<tr> |
|
813 |
<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td> |
|
814 |
<td>The amount of steps to move the page</td> |
|
815 |
</tr> |
|
816 |
<tr> |
|
817 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
818 |
<td>user data set when the signal handler was connected.</td> |
|
819 |
</tr> |
|
820 |
</tbody> |
|
821 |
</table></div> |
|
822 |
</div> |
|
823 |
<hr> |
|
824 |
<div class="refsect2"> |
|
825 |
<a name="GtkSourceCompletion-populate-context"></a><h3>The <code class="literal">"populate-context"</code> signal</h3> |
|
826 |
<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, |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
827 |
<a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context, |
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
828 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
829 |
<p> |
830 |
Emitted just before starting to populate the completion with providers. |
|
831 |
You can use this signal to add additional attributes in the context. |
|
832 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
833 |
<div class="variablelist"><table border="0" class="variablelist"> |
834 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
835 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
836 |
<col> |
837 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
838 |
<tbody> |
839 |
<tr> |
|
840 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
841 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
842 |
</tr> |
|
843 |
<tr> |
|
844 |
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td> |
|
|
1.1.28
by Robert Ancell
Import upstream version 3.5.4 |
845 |
<td>The <a class="link" href="GtkSourceCompletionContext.html" title="GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> for the current completion</td> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
846 |
</tr> |
847 |
<tr> |
|
848 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
849 |
<td>user data set when the signal handler was connected.</td> |
|
850 |
</tr> |
|
851 |
</tbody> |
|
852 |
</table></div> |
|
853 |
</div> |
|
854 |
<hr> |
|
855 |
<div class="refsect2"> |
|
856 |
<a name="GtkSourceCompletion-show"></a><h3>The <code class="literal">"show"</code> signal</h3> |
|
857 |
<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, |
|
|
1.3.1
by Emilio Pozuelo Monfort
Import upstream version 3.8.0 |
858 |
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-ACTION:CAPS"><code class="literal">Action</code></a></pre> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
859 |
<p> |
860 |
Emitted when the completion window is shown. The default handler |
|
861 |
will actually show the window. |
|
862 |
</p> |
|
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
863 |
<div class="variablelist"><table border="0" class="variablelist"> |
864 |
<colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
865 |
<col align="left" valign="top"> |
|
1.1.32
by Sebastien Bacher
Import upstream version 3.6.3 |
866 |
<col> |
867 |
</colgroup> |
|
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
868 |
<tbody> |
869 |
<tr> |
|
870 |
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td> |
|
871 |
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td> |
|
872 |
</tr> |
|
873 |
<tr> |
|
874 |
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> |
|
875 |
<td>user data set when the signal handler was connected.</td> |
|
876 |
</tr> |
|
877 |
</tbody> |
|
878 |
</table></div> |
|
879 |
</div> |
|
880 |
</div> |
|
881 |
</div> |
|
882 |
<div class="footer"> |
|
883 |
<hr> |
|
|
1.1.35
by Sebastien Bacher
Import upstream version 3.8.2 |
884 |
Generated by GTK-Doc V1.19.1</div> |
|
1.1.1
by Michael Terry
Import upstream version 2.91.2 |
885 |
</body> |
886 |
</html> |