<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.SourceView.SourceCompletion</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-SourceView-SourceCompletion.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtksourceview2-0.12.2: Binding to the GtkSourceView library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.SourceView.SourceCompletion</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Types
</a></li><li><a href="#g:2">Methods
</a></li><li><a href="#g:3">Attributes
</a></li><li><a href="#g:4">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:SourceCompletion">SourceCompletion</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> o => <a href="#t:SourceCompletionClass">SourceCompletionClass</a> o </li><li class="src short"><a href="#v:sourceCompletionAddProvider">sourceCompletionAddProvider</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionRemoveProvider">sourceCompletionRemoveProvider</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionGetProviders">sourceCompletionGetProviders</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a>]</li><li class="src short"><a href="#v:sourceCompletionShow">sourceCompletionShow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> [<a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a>] -> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionHide">sourceCompletionHide</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:sourceCompletionGetInfoWindow">sourceCompletionGetInfoWindow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionInfo.html#t:SourceCompletionInfo">SourceCompletionInfo</a></li><li class="src short"><a href="#v:sourceCompletionCreateContext">sourceCompletionCreateContext</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Multiline-TextIter.html#t:TextIter">TextIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a></li><li class="src short"><a href="#v:sourceCompletionMoveWindow">sourceCompletionMoveWindow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Multiline-TextIter.html#t:TextIter">TextIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:sourceCompletionBlockInteractive">sourceCompletionBlockInteractive</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:sourceCompletionUnblockInteractive">sourceCompletionUnblockInteractive</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:sourceCompletionAccelerators">sourceCompletionAccelerators</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:sourceCompletionAutoCompleteDelay">sourceCompletionAutoCompleteDelay</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:sourceCompletionProposalPageSize">sourceCompletionProposalPageSize</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:sourceCompletionProviderPageSize">sourceCompletionProviderPageSize</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:sourceCompletionRememberInfoVisibility">sourceCompletionRememberInfoVisibility</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionSelectOnShow">sourceCompletionSelectOnShow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionShowHeaders">sourceCompletionShowHeaders</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionShowIcons">sourceCompletionShowIcons</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:sourceCompletionView">sourceCompletionView</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="Graphics-UI-Gtk-SourceView-SourceView.html#t:SourceView">SourceView</a></li><li class="src short"><a href="#v:sourceCompletionActivateProposal">sourceCompletionActivateProposal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:sourceCompletionHideSignal">sourceCompletionHideSignal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:sourceCompletionMoveCursor">sourceCompletionMoveCursor</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-General-Enums.html#t:ScrollStep">ScrollStep</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:sourceCompletionMovePage">sourceCompletionMovePage</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-General-Enums.html#t:ScrollStep">ScrollStep</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:sourceCompletionPopulateContext">sourceCompletionPopulateContext</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li class="src short"><a href="#v:sourceCompletionShowSignal">sourceCompletionShowSignal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li></ul></div><div id="interface"><h1 id="g:1">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:SourceCompletion" class="def">SourceCompletion</a> <a href="src/Graphics-UI-Gtk-SourceView-Types.html#SourceCompletion" class="link">Source</a></p><div class="subs instances"><p id="control.i:SourceCompletion" class="caption collapser" onclick="toggleSection('i:SourceCompletion')">Instances</p><div id="section.i:SourceCompletion" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> o => <a name="t:SourceCompletionClass" class="def">SourceCompletionClass</a> o <a href="src/Graphics-UI-Gtk-SourceView-Types.html#SourceCompletionClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:SourceCompletionClass" class="caption collapser" onclick="toggleSection('i:SourceCompletionClass')">Instances</p><div id="section.i:SourceCompletionClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletion">SourceCompletion</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:2">Methods
</h1><div class="top"><p class="src"><a name="v:sourceCompletionAddProvider" class="def">sourceCompletionAddProvider</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionAddProvider" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc</td><td class="doc empty"> </td></tr><tr><td class="src">=> sc</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if provider was successfully added, otherwise if error is provided, it will be set with the error and
</p></td></tr></table></div><div class="doc"><p>Add a new <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a></code> to the completion object. This will add a reference provider,
so make sure to unref your own copy when you no longer need it.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionRemoveProvider" class="def">sourceCompletionRemoveProvider</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionRemoveProvider" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc</td><td class="doc empty"> </td></tr><tr><td class="src">=> sc</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if provider was successfully removed, otherwise if error is provided, it will be set with the error and
</p></td></tr></table></div><div class="doc"><p>Remove provider from the completion.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionGetProviders" class="def">sourceCompletionGetProviders</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a>]<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionGetProviders" class="link">Source</a></p><div class="doc"><p>Get list of providers registered on completion. The returned list is owned by the completion and
should not be freed.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionShow" class="def">sourceCompletionShow</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionShow" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc</td><td class="doc empty"> </td></tr><tr><td class="src">=> sc</td><td class="doc empty"> </td></tr><tr><td class="src">-> [<a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a>]</td><td class="doc"><p><code>providers</code> A list of <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletionProvider.html#t:SourceCompletionProvider">SourceCompletionProvider</a></code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a></td><td class="doc"><p><code>context</code> The <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a></code> with which to start the completion
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> if it was possible to the show completion window.
</p></td></tr></table></div><div class="doc"><p>Starts a new completion with the specified <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a></code> and a list of potential
candidate providers for completion.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionHide" class="def">sourceCompletionHide</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionHide" class="link">Source</a></p><div class="doc"><p>Hides the completion if it is active (visible).
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionGetInfoWindow" class="def">sourceCompletionGetInfoWindow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionInfo.html#t:SourceCompletionInfo">SourceCompletionInfo</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionGetInfoWindow" class="link">Source</a></p><div class="doc"><p>The info widget is the window where the completion displays optional extra information of the
proposal.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionCreateContext" class="def">sourceCompletionCreateContext</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Multiline-TextIter.html#t:TextIter">TextIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionCreateContext" class="link">Source</a></p><div class="doc"><p>Create a new <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a></code> for completion. The position at which the completion using
the new context will consider completion can be provider by position. If position is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>, the
current cursor position will be used.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionMoveWindow" class="def">sourceCompletionMoveWindow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-Multiline-TextIter.html#t:TextIter">TextIter</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionMoveWindow" class="link">Source</a></p><div class="doc"><p>Move the completion window to a specific iter.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionBlockInteractive" class="def">sourceCompletionBlockInteractive</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionBlockInteractive" class="link">Source</a></p><div class="doc"><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
<code><a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#v:sourceCompletionUnblockInteractive">sourceCompletionUnblockInteractive</a></code> to enable interactive completion again.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionUnblockInteractive" class="def">sourceCompletionUnblockInteractive</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => sc -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionUnblockInteractive" class="link">Source</a></p><div class="doc"><p>Unblock interactive completion. This can be used after using <code><a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#v:sourceCompletionBlockInteractive">sourceCompletionBlockInteractive</a></code>
to enable interactive completion again.
</p></div></div><h1 id="g:3">Attributes
</h1><div class="top"><p class="src"><a name="v:sourceCompletionAccelerators" class="def">sourceCompletionAccelerators</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionAccelerators" class="link">Source</a></p><div class="doc"><p>Number of accelerators to show for the first proposals.
</p><p>Allowed values: <= 10
</p><p>Default value: 5
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionAutoCompleteDelay" class="def">sourceCompletionAutoCompleteDelay</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionAutoCompleteDelay" class="link">Source</a></p><div class="doc"><p>Determines the popup delay (in milliseconds) at which the completion will be shown for interactive
completion.
</p><p>Default value: 250
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionProposalPageSize" class="def">sourceCompletionProposalPageSize</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionProposalPageSize" class="link">Source</a></p><div class="doc"><p>The scroll page size of the proposals in the completion window.
</p><p>Allowed values: >= 1
</p><p>Default value: 5
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionProviderPageSize" class="def">sourceCompletionProviderPageSize</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionProviderPageSize" class="link">Source</a></p><div class="doc"><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></div><div class="top"><p class="src"><a name="v:sourceCompletionRememberInfoVisibility" class="def">sourceCompletionRememberInfoVisibility</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionRememberInfoVisibility" class="link">Source</a></p><div class="doc"><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: <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:False">False</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionSelectOnShow" class="def">sourceCompletionSelectOnShow</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionSelectOnShow" class="link">Source</a></p><div class="doc"><p>Determines whether the first proposal should be selected when the completion is first shown.
</p><p>Default value: <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionShowHeaders" class="def">sourceCompletionShowHeaders</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionShowHeaders" class="link">Source</a></p><div class="doc"><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: <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionShowIcons" class="def">sourceCompletionShowIcons</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionShowIcons" class="link">Source</a></p><div class="doc"><p>Determines whether provider and proposal icons should be shown in the completion popup.
</p><p>Default value: <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionView" class="def">sourceCompletionView</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> sc <a href="Graphics-UI-Gtk-SourceView-SourceView.html#t:SourceView">SourceView</a><a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionView" class="link">Source</a></p><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-SourceView-SourceView.html#t:SourceView">SourceView</a></code> bound to the completion object.
</p></div></div><h1 id="g:4">Signals
</h1><div class="top"><p class="src"><a name="v:sourceCompletionActivateProposal" class="def">sourceCompletionActivateProposal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionActivateProposal" class="link">Source</a></p><div class="doc"><p>The <code>activateProposal</code> 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 <code>gSignalEmitByName</code> if they need to
control the proposal activation programmatically.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionHideSignal" class="def">sourceCompletionHideSignal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionHideSignal" class="link">Source</a></p><div class="doc"><p>Emitted when the completion window is hidden. The default handler will actually hide the window.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionMoveCursor" class="def">sourceCompletionMoveCursor</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-General-Enums.html#t:ScrollStep">ScrollStep</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionMoveCursor" class="link">Source</a></p><div class="doc"><p>The <code>moveCursor</code> 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 <code>gSignalEmitByName</code> if they need to
control the cursor programmatically.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionMovePage" class="def">sourceCompletionMovePage</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/gtk-0.12.0/Graphics-UI-Gtk-General-Enums.html#t:ScrollStep">ScrollStep</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionMovePage" class="link">Source</a></p><div class="doc"><p>The <code>movePage</code> 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 <code>gSignalEmitByName</code> if they need to
control the page selection programmatically.
</p></div></div><div class="top"><p class="src"><a name="v:sourceCompletionPopulateContext" class="def">sourceCompletionPopulateContext</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="Graphics-UI-Gtk-SourceView-SourceCompletionContext.html#t:SourceCompletionContext">SourceCompletionContext</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionPopulateContext" class="link">Source</a></p><div class="doc"><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></div><div class="top"><p class="src"><a name="v:sourceCompletionShowSignal" class="def">sourceCompletionShowSignal</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceCompletion.html#t:SourceCompletionClass">SourceCompletionClass</a> sc => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> sc (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-SourceView-SourceCompletion.html#sourceCompletionShowSignal" class="link">Source</a></p><div class="doc"><p>Emitted when the completion window is shown. The default handler will actually show the window.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
