/usr/share/gtk-doc/html/gtksourceview-3.0/GtkSourceCompletion.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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceCompletion</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="GtkSourceBuffer.html" title="GtkSourceBuffer">
<link rel="next" href="gtksourceview-3.0-completioncontext.html" title="GtkSourceCompletionContext">
<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="GtkSourceBuffer.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="gtksourceview-3.0-completioncontext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceCompletion.synopsis" class="shortcut">Top</a>
|
<a href="#GtkSourceCompletion.description" class="shortcut">Description</a>
|
<a href="#GtkSourceCompletion.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkSourceCompletion.properties" class="shortcut">Properties</a>
|
<a href="#GtkSourceCompletion.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkSourceCompletion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceCompletion.top_of_page"></a>GtkSourceCompletion</span></h2>
<p>GtkSourceCompletion — Main Completion Object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceCompletion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksourcecompletion.h>
struct <a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-struct" title="struct GtkSourceCompletion">GtkSourceCompletion</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-add-provider" title="gtk_source_completion_add_provider ()">gtk_source_completion_add_provider</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-remove-provider" title="gtk_source_completion_remove_provider ()">gtk_source_completion_remove_provider</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GList</span> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-providers" title="gtk_source_completion_get_providers ()">gtk_source_completion_get_providers</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-show" title="gtk_source_completion_show ()">gtk_source_completion_show</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><span class="type">GList</span> *providers</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);
<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>);
<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>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
struct <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="returnvalue">_GtkSourceView</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-get-view" title="gtk_source_completion_get_view ()">gtk_source_completion_get_view</a> (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
<a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="returnvalue">GtkSourceCompletionContext</span></a> * <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-create-context" title="gtk_source_completion_create_context ()">gtk_source_completion_create_context</a>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *position</code></em>);
<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>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>);
<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>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
<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>
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GtkSourceCompletion
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--accelerators" title='The "accelerators" property'>accelerators</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--auto-complete-delay" title='The "auto-complete-delay" property'>auto-complete-delay</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--proposal-page-size" title='The "proposal-page-size" property'>proposal-page-size</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--provider-page-size" title='The "provider-page-size" property'>provider-page-size</a>" <span class="type">guint</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--remember-info-visibility" title='The "remember-info-visibility" property'>remember-info-visibility</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--select-on-show" title='The "select-on-show" property'>select-on-show</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-headers" title='The "show-headers" property'>show-headers</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion--show-icons" title='The "show-icons" property'>show-icons</a>" <span class="type">gboolean</span> : Read / Write / Construct
"<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
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-activate-proposal" title='The "activate-proposal" signal'>activate-proposal</a>" : <code class="literal">Action</code>
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-hide" title='The "hide" signal'>hide</a>" : <code class="literal">Action</code>
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-cursor" title='The "move-cursor" signal'>move-cursor</a>" : <code class="literal">Action</code>
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-move-page" title='The "move-page" signal'>move-page</a>" : <code class="literal">Action</code>
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-populate-context" title='The "populate-context" signal'>populate-context</a>" : <code class="literal">Action</code>
"<a class="link" href="GtkSourceCompletion.html#GtkSourceCompletion-show" title='The "show" signal'>show</a>" : <code class="literal">Action</code>
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletion-struct"></a><h3>struct GtkSourceCompletion</h3>
<pre class="programlisting">struct GtkSourceCompletion;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-add-provider"></a><h3>gtk_source_completion_add_provider ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_add_provider (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Add a new <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> to the completion object. This will
add a reference <em class="parameter"><code>provider</code></em>, so make sure to unref your own copy when you
no longer need it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</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>provider</code></em> was successfully added, otherwise if <em class="parameter"><code>error</code></em>
is provided, it will be set with the error and <code class="literal">FALSE</code> is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-remove-provider"></a><h3>gtk_source_completion_remove_provider ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_remove_provider
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a> *provider</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Remove <em class="parameter"><code>provider</code></em> from the completion.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</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>provider</code></em> was successfully removed, otherwise if <em class="parameter"><code>error</code></em>
is provided, it will be set with the error and <code class="literal">FALSE</code> is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-get-providers"></a><h3>gtk_source_completion_get_providers ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * gtk_source_completion_get_providers (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
<p>
Get list of providers registered on <em class="parameter"><code>completion</code></em>. The returned list is owned
by the completion and should not be freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-show"></a><h3>gtk_source_completion_show ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_source_completion_show (<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><span class="type">GList</span> *providers</code></em>,
<em class="parameter"><code><a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context</code></em>);</pre>
<p>
Starts a new completion with the specified <a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> and
a list of potential candidate providers for completion.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>providers</code></em> :</span></p></td>
<td>a list of <a class="link" href="GtkSourceCompletionProvider.html" title="GtkSourceCompletionProvider"><span class="type">GtkSourceCompletionProvider</span></a>, or <code class="literal">NULL</code>. <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>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>The <a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>
with which to start the completion. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</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 it was possible to the show completion window.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-hide"></a><h3>gtk_source_completion_hide ()</h3>
<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>
<p>
Hides the completion if it is active (visible).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-get-info-window"></a><h3>gtk_source_completion_get_info_window ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="returnvalue">GtkSourceCompletionInfo</span></a> * gtk_source_completion_get_info_window
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
<p>
The info widget is the window where the completion displays optional extra
information of the proposal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo"><span class="type">GtkSourceCompletionInfo</span></a> window
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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-get-view"></a><h3>gtk_source_completion_get_view ()</h3>
<pre class="programlisting">struct <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>
<p>
The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> associated with <em class="parameter"><code>completion</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>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-create-context"></a><h3>gtk_source_completion_create_context ()</h3>
<pre class="programlisting"><a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="returnvalue">GtkSourceCompletionContext</span></a> * gtk_source_completion_create_context
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *position</code></em>);</pre>
<p>
Create a new <a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> for <em class="parameter"><code>completion</code></em>. The position at
which the completion using the new context will consider completion can
be provider by <em class="parameter"><code>position</code></em>. If <em class="parameter"><code>position</code></em> is <code class="literal">NULL</code>, the current cursor
position will be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>a <span class="type">GtkTextIter</span>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a>.
The reference being returned is a 'floating' reference,
so if you invoke <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-show" title="gtk_source_completion_show ()"><span class="type">gtk_source_completion_show</span></a> with this context
you don't need to unref it. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-move-window"></a><h3>gtk_source_completion_move_window ()</h3>
<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>,
<em class="parameter"><code><span class="type">GtkTextIter</span> *iter</code></em>);</pre>
<p>
Move the completion window to a specific iter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
<td>a <span class="type">GtkTextIter</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-block-interactive"></a><h3>gtk_source_completion_block_interactive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_block_interactive
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
<p>
Block interactive completion. This can be used to disable interactive
completion when inserting or deleting text from the buffer associated with
the completion. Use <a class="link" href="GtkSourceCompletion.html#gtk-source-completion-unblock-interactive" title="gtk_source_completion_unblock_interactive ()"><span class="type">gtk_source_completion_unblock_interactive</span></a> to enable
interactive completion again.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-unblock-interactive"></a><h3>gtk_source_completion_unblock_interactive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_source_completion_unblock_interactive
(<em class="parameter"><code><a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> *completion</code></em>);</pre>
<p>
Unblock interactive completion. This can be used after using
<a class="link" href="GtkSourceCompletion.html#gtk-source-completion-block-interactive" title="gtk_source_completion_block_interactive ()"><span class="type">gtk_source_completion_block_interactive</span></a> to enable interactive completion
again.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>a <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a>.</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletion--accelerators"></a><h3>The <code class="literal">"accelerators"</code> property</h3>
<pre class="programlisting"> "accelerators" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>
Number of accelerators to show for the first proposals.
</p>
<p>Allowed values: <= 10</p>
<p>Default value: 5</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--auto-complete-delay"></a><h3>The <code class="literal">"auto-complete-delay"</code> property</h3>
<pre class="programlisting"> "auto-complete-delay" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>
Determines the popup delay (in milliseconds) at which the completion
will be shown for interactive completion.
</p>
<p>Default value: 250</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--proposal-page-size"></a><h3>The <code class="literal">"proposal-page-size"</code> property</h3>
<pre class="programlisting"> "proposal-page-size" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>
The scroll page size of the proposals in the completion window.
</p>
<p>Allowed values: >= 1</p>
<p>Default value: 5</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--provider-page-size"></a><h3>The <code class="literal">"provider-page-size"</code> property</h3>
<pre class="programlisting"> "provider-page-size" <span class="type">guint</span> : Read / Write / Construct</pre>
<p>
The scroll page size of the provider pages in the completion window.
</p>
<p>Allowed values: >= 1</p>
<p>Default value: 5</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--remember-info-visibility"></a><h3>The <code class="literal">"remember-info-visibility"</code> property</h3>
<pre class="programlisting"> "remember-info-visibility" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Determines whether the visibility of the info window should be
saved when the completion is hidden, and restored when the completion
is shown again.
</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--select-on-show"></a><h3>The <code class="literal">"select-on-show"</code> property</h3>
<pre class="programlisting"> "select-on-show" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Determines whether the first proposal should be selected when the
completion is first shown.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--show-headers"></a><h3>The <code class="literal">"show-headers"</code> property</h3>
<pre class="programlisting"> "show-headers" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Determines whether provider headers should be shown in the proposal
list if there is more than one provider with proposals.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--show-icons"></a><h3>The <code class="literal">"show-icons"</code> property</h3>
<pre class="programlisting"> "show-icons" <span class="type">gboolean</span> : Read / Write / Construct</pre>
<p>
Determines whether provider and proposal icons should be shown in
the completion popup.
</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion--view"></a><h3>The <code class="literal">"view"</code> property</h3>
<pre class="programlisting"> "view" <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a>* : Read / Write / Construct Only</pre>
<p>
The <a class="link" href="GtkSourceView.html" title="GtkSourceView"><span class="type">GtkSourceView</span></a> bound to the completion object.
</p>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletion.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletion-activate-proposal"></a><h3>The <code class="literal">"activate-proposal"</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
The ::activate-proposal signal is a keybinding signal which gets
emitted when the user initiates a proposal activation.
</p>
<p>
Applications should not connect to it, but may emit it with
<span class="type">g_signal_emit_by_name</span> if they need to control the proposal activation
programmatically.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</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>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion-hide"></a><h3>The <code class="literal">"hide"</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
Emitted when the completion window is hidden. The default handler
will actually hide the window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</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>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion-move-cursor"></a><h3>The <code class="literal">"move-cursor"</code> signal</h3>
<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,
<span class="type">GtkScrollStep</span> step,
<span class="type">gint</span> num,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
The ::move-cursor signal is a keybinding signal which gets emitted when
the user initiates a cursor movement.
</p>
<p>
Applications should not connect to it, but may emit it with
<span class="type">g_signal_emit_by_name</span> if they need to control the cursor
programmatically.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>step</code></em> :</span></p></td>
<td>The <span class="type">GtkScrollStep</span> by which to move the cursor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td>
<td>The amount of steps to move the cursor</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>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion-move-page"></a><h3>The <code class="literal">"move-page"</code> signal</h3>
<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,
<span class="type">GtkScrollStep</span> step,
<span class="type">gint</span> num,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
The ::move-page signal is a keybinding signal which gets emitted when
the user initiates a page movement (i.e. switches between provider
pages).
</p>
<p>
Applications should not connect to it, but may emit it with
<span class="type">g_signal_emit_by_name</span> if they need to control the page selection
programmatically.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>step</code></em> :</span></p></td>
<td>The <span class="type">GtkScrollStep</span> by which to move the page</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td>
<td>The amount of steps to move the page</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>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion-populate-context"></a><h3>The <code class="literal">"populate-context"</code> signal</h3>
<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,
<a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> *context,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
Emitted just before starting to populate the completion with providers.
You can use this signal to add additional attributes in the context.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>The <a class="link" href="gtksourceview-3.0-completioncontext.html#GtkSourceCompletionContext"><span class="type">GtkSourceCompletionContext</span></a> for the current completion</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>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletion-show"></a><h3>The <code class="literal">"show"</code> signal</h3>
<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,
<span class="type">gpointer</span> user_data) : <code class="literal">Action</code></pre>
<p>
Emitted when the completion window is shown. The default handler
will actually show the window.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>completion</code></em> :</span></p></td>
<td>The <a class="link" href="GtkSourceCompletion.html" title="GtkSourceCompletion"><span class="type">GtkSourceCompletion</span></a> who emits the signal</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>
|