/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceCompletionProposal.html is in libgtksourceview-3.0-doc 3.4.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceCompletionProposal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="rn01.html" title="API reference">
<link rel="prev" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem">
<link rel="next" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider">
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceCompletionItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 3 Reference Manual</th>
<td><a accesskey="n" href="GtkSourceCompletionProvider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceCompletionProposal.synopsis" class="shortcut">Top</a>
|
<a href="#GtkSourceCompletionProposal.description" class="shortcut">Description</a>
|
<a href="#GtkSourceCompletionProposal.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkSourceCompletionProposal.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#GtkSourceCompletionProposal.implementations" class="shortcut">Known Implementations</a>
|
<a href="#GtkSourceCompletionProposal.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkSourceCompletionProposal"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceCompletionProposal.top_of_page"></a>GtkSourceCompletionProposal</span></h2>
<p>GtkSourceCompletionProposal — Completion proposal object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceCompletionProposal.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksourcecompletionproposal.h>
<a class="link" href="GtkSourceCompletionProposal.html#GtkSourceCompletionProposal-struct" title="GtkSourceCompletionProposal">GtkSourceCompletionProposal</a>;
<span class="returnvalue">gchar</span> * <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-label" title="gtk_source_completion_proposal_get_label ()">gtk_source_completion_proposal_get_label</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-markup" title="gtk_source_completion_proposal_get_markup ()">gtk_source_completion_proposal_get_markup</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-text" title="gtk_source_completion_proposal_get_text ()">gtk_source_completion_proposal_get_text</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">GdkPixbuf</span> * <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-icon" title="gtk_source_completion_proposal_get_icon ()">gtk_source_completion_proposal_get_icon</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-info" title="gtk_source_completion_proposal_get_info ()">gtk_source_completion_proposal_get_info</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-changed" title="gtk_source_completion_proposal_changed ()">gtk_source_completion_proposal_changed</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">guint</span> <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-hash" title="gtk_source_completion_proposal_hash ()">gtk_source_completion_proposal_hash</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-equal" title="gtk_source_completion_proposal_equal ()">gtk_source_completion_proposal_equal</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *other</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----GtkSourceCompletionProposal
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.prerequisites"></a><h2>Prerequisites</h2>
<p>
GtkSourceCompletionProposal requires
GObject.</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.implementations"></a><h2>Known Implementations</h2>
<p>
GtkSourceCompletionProposal is implemented by
<a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem">GtkSourceCompletionItem</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceCompletionProposal.html#GtkSourceCompletionProposal-changed" title='The "changed" signal'>changed</a>" : <code class="literal">Action</code>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.description"></a><h2>Description</h2>
<p>
The proposal interface represents a completion item in the completion window.
It provides information on how to display the completion item and what action
should be taken when the completion item is activated.
</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletionProposal-struct"></a><h3>GtkSourceCompletionProposal</h3>
<pre class="programlisting">typedef struct _GtkSourceCompletionProposal GtkSourceCompletionProposal;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-get-label"></a><h3>gtk_source_completion_proposal_get_label ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_source_completion_proposal_get_label
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Gets the label of <em class="parameter"><code>proposal</code></em>. The label is shown in the list of proposals as
plain text. If you need any markup (such as bold or italic text), you have
to implement <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-markup" title="gtk_source_completion_proposal_get_markup ()"><span class="type">gtk_source_completion_proposal_get_markup</span></a>. The returned string
must be freed with <code class="function">g_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string containing the label of <em class="parameter"><code>proposal</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-get-markup"></a><h3>gtk_source_completion_proposal_get_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_source_completion_proposal_get_markup
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Gets the label of <em class="parameter"><code>proposal</code></em> with markup. The label is shown in the list of
proposals and may contain markup. This will be used instead of
<a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-get-label" title="gtk_source_completion_proposal_get_label ()"><span class="type">gtk_source_completion_proposal_get_label</span></a> if implemented. The returned string
must be freed with <code class="function">g_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string containing the label of <em class="parameter"><code>proposal</code></em> with markup.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-get-text"></a><h3>gtk_source_completion_proposal_get_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_source_completion_proposal_get_text
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Gets the text of <em class="parameter"><code>proposal</code></em>. The text that is inserted into
the text buffer when the proposal is activated by the default activation.
You are free to implement a custom activation handler in the provider and
not implement this function. The returned string must be freed with <code class="function">g_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string containing the text of <em class="parameter"><code>proposal</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-get-icon"></a><h3>gtk_source_completion_proposal_get_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> * gtk_source_completion_proposal_get_icon
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Gets the icon of <em class="parameter"><code>proposal</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The icon of <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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-get-info"></a><h3>gtk_source_completion_proposal_get_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * gtk_source_completion_proposal_get_info
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Gets extra information associated to the proposal. This information will be
used to present the user with extra, detailed information about the
selected proposal. The returned string must be freed with <code class="function">g_free()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new string containing extra information of <em class="parameter"><code>proposal</code></em> or <code class="literal">NULL</code> if
no extra information is associated to <em class="parameter"><code>proposal</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-changed"></a><h3>gtk_source_completion_proposal_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_proposal_changed
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Emits the "changed" signal on <em class="parameter"><code>proposal</code></em>. This should be called by
implementations whenever the name, icon or info of the proposal has
changed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-hash"></a><h3>gtk_source_completion_proposal_hash ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span> gtk_source_completion_proposal_hash (<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>);</pre>
<p>
Get the hash value of <em class="parameter"><code>proposal</code></em>. This is used to (together with
<a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-equal" title="gtk_source_completion_proposal_equal ()"><span class="type">gtk_source_completion_proposal_equal</span></a>) to match proposals in the completion
model. By default, it uses a direct hash (<span class="type">g_direct_hash</span>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The hash value of <em class="parameter"><code>proposal</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-proposal-equal"></a><h3>gtk_source_completion_proposal_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_proposal_equal
(<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *other</code></em>);</pre>
<p>
Get whether two proposal objects are the same. This is used to (together
with <a class="link" href="GtkSourceCompletionProposal.html#gtk-source-completion-proposal-hash" title="gtk_source_completion_proposal_hash ()"><span class="type">gtk_source_completion_proposal_hash</span></a>) to match proposals in the
completion model. By default, it uses direct equality (<span class="type">g_direct_equal</span>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>proposal</code></em> and <em class="parameter"><code>object</code></em> are the same proposal</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionProposal.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletionProposal-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> *proposal,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
Emitted when the proposal has changed. The completion popup
will react to this by updating the shown information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proposal</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|