<!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/xhtml;charset=UTF-8"/>
<title>gtksourceviewmm: gtksourceview::SourceCompletionProvider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtksourceviewmm
 <span id="projectnumber">2.10.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>gtksourceview</b> </li>
<li class="navelem"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html">SourceCompletionProvider</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<div class="title">gtksourceview::SourceCompletionProvider Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="gtksourceview::SourceCompletionProvider" --><!-- doxytag: inherits="Glib::Interface" -->
<p>Completion provider interface. <a href="classgtksourceview_1_1SourceCompletionProvider.html#details">More...</a></p>
<p><code>#include <gtksourceviewmm/sourcecompletionprovider.h></code></p>
<div class="dynheader">
Inheritance diagram for gtksourceview::SourceCompletionProvider:</div>
<div class="dyncontent">
<div class="center"><img src="classgtksourceview_1_1SourceCompletionProvider__inherit__graph.png" border="0" usemap="#gtksourceview_1_1SourceCompletionProvider_inherit__map" alt="Inheritance graph"/></div>
<map name="gtksourceview_1_1SourceCompletionProvider_inherit__map" id="gtksourceview_1_1SourceCompletionProvider_inherit__map">
<area shape="rect" id="node9" href="classgtksourceview_1_1SourceCompletionWords.html" title="Words completion provider." alt="" coords="12,304,287,331"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="94,155,204,181"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="86,80,212,107"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="92,5,207,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgtksourceview_1_1SourceCompletionProvider-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0c60bb3895cc4fa52a163842f005990"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::gobj" ref="ab0c60bb3895cc4fa52a163842f005990" args="()" -->
GtkSourceCompletionProvider* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#ab0c60bb3895cc4fa52a163842f005990">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58791e40f7d40132696ba47de4d94bf9"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::gobj" ref="a58791e40f7d40132696ba47de4d94bf9" args="() const " -->
const GtkSourceCompletionProvider* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a58791e40f7d40132696ba47de4d94bf9">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a21cee41644713365dd9762a13cc41b22">get_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the provider. <a href="#a21cee41644713365dd9762a13cc41b22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a5ef627e469af359db709f444cdff9bf5">get_icon</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the icon of the provider. <a href="#a5ef627e469af359db709f444cdff9bf5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#ab2c49572be66ef8b16612d8413b31069">get_icon</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the icon of the provider. <a href="#ab2c49572be66ef8b16612d8413b31069"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#aec1aba9414ba26e9e6a735bc9d5e48c4">populate</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& context)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate <em>context</em> with proposals from a provider. <a href="#aec1aba9414ba26e9e6a735bc9d5e48c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a2df3aff1ab95fa8c559ecb71220c1c22">match</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& context) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether the provider match the context of completion detailed in <em>context</em>. <a href="#a2df3aff1ab95fa8c559ecb71220c1c22"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a42739d90caf4f1d4b2ffcb4d5ba32a35">get_info_widget</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& proposal)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a customized info widget to show extra information of a proposal. <a href="#a42739d90caf4f1d4b2ffcb4d5ba32a35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a5f1f8b084273462ed586ae2f861ff8cd">get_info_widget</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& proposal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a customized info widget to show extra information of a proposal. <a href="#a5f1f8b084273462ed586ae2f861ff8cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a74cc154ba7a4caf641a0e609c3c2e0b0">update_info</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& proposal, const <a class="el" href="classgtksourceview_1_1SourceCompletionInfo.html">SourceCompletionInfo</a>& info)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update extra information shown in <em>info</em> for <em>proposal</em>. <a href="#a74cc154ba7a4caf641a0e609c3c2e0b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#ab602f67c3d7da669d803aa87cb4d7929">get_start_iter</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& context, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& proposal, <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a>& iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a> at which the completion for <em>proposal</em> starts. <a href="#ab602f67c3d7da669d803aa87cb4d7929"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#abb0a505e8b14737667c50e87bd20cfe7">activate_proposal</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& proposal, const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a>& iter)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate <em>proposal</em> at <em>iter</em>. <a href="#abb0a505e8b14737667c50e87bd20cfe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gtksourceviewmmEnums.html#gaa467791958fa7b5403491f7c3b863de3">SourceCompletionActivation</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a385b720e3baefead182088bdabe572e9">get_activation</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get with what kind of activation the provider should be activated. <a href="#a385b720e3baefead182088bdabe572e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#aeb9c637a072ff24f806c158854f3f46e">get_interactive_delay</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the delay in milliseconds before starting interactive completion for this provider. <a href="#aeb9c637a072ff24f806c158854f3f46e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#aff2b8f4611da25d4c8655dfb597bd122">get_priority</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the provider priority. <a href="#aff2b8f4611da25d4c8655dfb597bd122"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html">gtksourceview::SourceCompletionProvider</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a6883c4814c83c9c745e0531857f0ab03">wrap</a> (GtkSourceCompletionProvider* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a6883c4814c83c9c745e0531857f0ab03"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Completion provider interface. </p>
<p>You must implement this interface to provide proposals to <a class="el" href="classgtksourceview_1_1SourceCompletion.html" title="Main Completion Object.">SourceCompletion</a>.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000063">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abb0a505e8b14737667c50e87bd20cfe7"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::activate_proposal" ref="abb0a505e8b14737667c50e87bd20cfe7" args="(const Glib::RefPtr< SourceCompletionProposal > &proposal, const Gtk::TextIter &iter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gtksourceview::SourceCompletionProvider::activate_proposal </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& </td>
<td class="paramname"><em>proposal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a> & </td>
<td class="paramname"><em>iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate <em>proposal</em> at <em>iter</em>. </p>
<p>When this functions returns <code>false</code>, the default activation of <em>proposal</em> will take place which replaces the word at <em>iter</em> with the label of <em>proposal</em>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proposal</td><td>A <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>. </td></tr>
<tr><td class="paramname">iter</td><td>A <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> to indicate that the proposal activation has been handled, <code>false</code> otherwise.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000072">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a385b720e3baefead182088bdabe572e9"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_activation" ref="a385b720e3baefead182088bdabe572e9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__gtksourceviewmmEnums.html#gaa467791958fa7b5403491f7c3b863de3">SourceCompletionActivation</a> gtksourceview::SourceCompletionProvider::get_activation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get with what kind of activation the provider should be activated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A combination of SourceCompletionActivation.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000073">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a5ef627e469af359db709f444cdff9bf5"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_icon" ref="a5ef627e469af359db709f444cdff9bf5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="elRef" href="../../../gtkmm-2.4/reference/html/classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> gtksourceview::SourceCompletionProvider::get_icon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the icon of the provider. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The icon to be used for the provider, or empty <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a> if the provider does not have a special icon.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000064">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ab2c49572be66ef8b16612d8413b31069"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_icon" ref="ab2c49572be66ef8b16612d8413b31069" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>> gtksourceview::SourceCompletionProvider::get_icon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the icon of the provider. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The icon to be used for the provider, or empty <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a> if the provider does not have a special icon.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000065">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a42739d90caf4f1d4b2ffcb4d5ba32a35"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_info_widget" ref="a42739d90caf4f1d4b2ffcb4d5ba32a35" args="(const Glib::RefPtr< const SourceCompletionProposal > &proposal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a>* gtksourceview::SourceCompletionProvider::get_info_widget </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& </td>
<td class="paramname"><em>proposal</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a customized info widget to show extra information of a proposal. </p>
<p>This allows for customized widgets on a proposal basis, although in general providers will have the same custom widget for all their proposals and <em>proposal</em> can be ignored. The implementation of this function is optional. If implemented, <a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a74cc154ba7a4caf641a0e609c3c2e0b0" title="Update extra information shown in info for proposal.">update_info()</a> <b>must</b> also be implemented. If not implemented, the default get_info() will be used to display extra information about a <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proposal</td><td>The currently selected <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A custom <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a> to show extra information about <em>proposal</em>.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000068">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a5f1f8b084273462ed586ae2f861ff8cd"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_info_widget" ref="a5f1f8b084273462ed586ae2f861ff8cd" args="(const Glib::RefPtr< const SourceCompletionProposal > &proposal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a>* gtksourceview::SourceCompletionProvider::get_info_widget </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& </td>
<td class="paramname"><em>proposal</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a customized info widget to show extra information of a proposal. </p>
<p>This allows for customized widgets on a proposal basis, although in general providers will have the same custom widget for all their proposals and <em>proposal</em> can be ignored. The implementation of this function is optional. If implemented, <a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a74cc154ba7a4caf641a0e609c3c2e0b0" title="Update extra information shown in info for proposal.">update_info()</a> <b>must</b> also be implemented. If not implemented, the default get_info() will be used to display extra information about a <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proposal</td><td>The currently selected <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A custom <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1Widget.html">Gtk::Widget</a> to show extra information about <em>proposal</em>.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000069">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="aeb9c637a072ff24f806c158854f3f46e"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_interactive_delay" ref="aeb9c637a072ff24f806c158854f3f46e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gtksourceview::SourceCompletionProvider::get_interactive_delay </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the delay in milliseconds before starting interactive completion for this provider. </p>
<p>A value of -1 indicates to use the default value as set by <a class="el" href="classgtksourceview_1_1SourceCompletion.html#ade2378bc2c90b131edaba556c95fb2f6" title="Completion popup delay for interactive completion.">SourceCompletion::property_auto_complete_delay()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The interactive delay in milliseconds.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000074">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a21cee41644713365dd9762a13cc41b22"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_name" ref="a21cee41644713365dd9762a13cc41b22" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> gtksourceview::SourceCompletionProvider::get_name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the name of the provider. </p>
<p>This should be a translatable name for display to the user. For example: _("Document word completion provider"). The returned string must be freed with Glib::free(). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new string containing the name of the provider. </dd></dl>
</div>
</div>
<a class="anchor" id="aff2b8f4611da25d4c8655dfb597bd122"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_priority" ref="aff2b8f4611da25d4c8655dfb597bd122" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gtksourceview::SourceCompletionProvider::get_priority </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the provider priority. </p>
<p>The priority determines the order in which proposals appear in the completion popup. Higher priorities are sorted before lower priorities. The default priority is 0.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The provider priority.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000075">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ab602f67c3d7da669d803aa87cb4d7929"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::get_start_iter" ref="ab602f67c3d7da669d803aa87cb4d7929" args="(const Glib::RefPtr< const SourceCompletionContext > &context, const Glib::RefPtr< const SourceCompletionProposal > &proposal, Gtk::TextIter &iter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gtksourceview::SourceCompletionProvider::get_start_iter </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& </td>
<td class="paramname"><em>proposal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a> & </td>
<td class="paramname"><em>iter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a> at which the completion for <em>proposal</em> starts. </p>
<p>When implemented, the completion can use this information to position the completion window accordingly when a proposal is selected in the completion window.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proposal</td><td>A <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>. </td></tr>
<tr><td class="paramname">context</td><td>A <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html" title="SourceCompletionContext.">SourceCompletionContext</a>. </td></tr>
<tr><td class="paramname">iter</td><td>A <a class="elRef" href="../../../gtkmm-2.4/reference/html/classGtk_1_1TextIter.html">Gtk::TextIter</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if <em>iter</em> was set for <em>proposal</em>, <code>false</code> otherwise.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000071">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a2df3aff1ab95fa8c559ecb71220c1c22"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::match" ref="a2df3aff1ab95fa8c559ecb71220c1c22" args="(const Glib::RefPtr< const SourceCompletionContext > &context) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gtksourceview::SourceCompletionProvider::match </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& </td>
<td class="paramname"><em>context</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get whether the provider match the context of completion detailed in <em>context</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html" title="SourceCompletionContext.">SourceCompletionContext</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if provider matches the completion context, <code>false</code> otherwise.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000067">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="aec1aba9414ba26e9e6a735bc9d5e48c4"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::populate" ref="aec1aba9414ba26e9e6a735bc9d5e48c4" args="(const Glib::RefPtr< SourceCompletionContext > &context)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceCompletionProvider::populate </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html">SourceCompletionContext</a> >& </td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate <em>context</em> with proposals from a provider. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The <a class="el" href="classgtksourceview_1_1SourceCompletionContext.html" title="SourceCompletionContext.">SourceCompletionContext</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000066">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a74cc154ba7a4caf641a0e609c3c2e0b0"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::update_info" ref="a74cc154ba7a4caf641a0e609c3c2e0b0" args="(const Glib::RefPtr< const SourceCompletionProposal > &proposal, const SourceCompletionInfo &info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceCompletionProvider::update_info </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html">SourceCompletionProposal</a> >& </td>
<td class="paramname"><em>proposal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classgtksourceview_1_1SourceCompletionInfo.html">SourceCompletionInfo</a>& </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update extra information shown in <em>info</em> for <em>proposal</em>. </p>
<p>This should be implemented if your provider sets a custom info widget for <em>proposal</em>. This function <b>must</b> be implemented when <a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html#a42739d90caf4f1d4b2ffcb4d5ba32a35" title="Get a customized info widget to show extra information of a proposal.">get_info_widget()</a> is implemented.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">proposal</td><td>A <a class="el" href="classgtksourceview_1_1SourceCompletionProposal.html" title="Completion proposal object.">SourceCompletionProposal</a>. </td></tr>
<tr><td class="paramname">info</td><td>A <a class="el" href="classgtksourceview_1_1SourceCompletionInfo.html" title="Calltips object.">SourceCompletionInfo</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="since_2_10"><dt><b><a class="el" href="since_2_10.html#_since_2_10000070">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a6883c4814c83c9c745e0531857f0ab03"></a><!-- doxytag: member="gtksourceview::SourceCompletionProvider::wrap" ref="a6883c4814c83c9c745e0531857f0ab03" args="(GtkSourceCompletionProvider *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceCompletionProvider.html">gtksourceview::SourceCompletionProvider</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkSourceCompletionProvider * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2012 21:27:04 for gtksourceviewmm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>
