<!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>glibmm: Gio::FilenameCompleter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1FilenameCompleter.html">FilenameCompleter</a>
</div>
</div>
<div class="contents">
<h1>Gio::FilenameCompleter Class Reference</h1><!-- doxytag: class="Gio::FilenameCompleter" --><!-- doxytag: inherits="Glib::Object" -->
<p>Completes partial file and directory names given a partial string by looking in the file system for clues. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGlib_1_1Object.html">Glib::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gio::FilenameCompleter:</div>
<div class="dynsection">
<div class="center"><img src="classGio_1_1FilenameCompleter__coll__graph.png" border="0" usemap="#Gio_1_1FilenameCompleter_coll__map" alt="Collaboration graph"/></div>
<map name="Gio_1_1FilenameCompleter_coll__map" id="Gio_1_1FilenameCompleter_coll__map">
<area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="40,160,131,189"/><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="25,83,145,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="32,5,139,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGio_1_1FilenameCompleter-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#ad72f983849b2ba03e2ef98868b56b27f">~FilenameCompleter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#a6fa2ba7f28935b557fac0dfe965fe916">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6fa2ba7f28935b557fac0dfe965fe916"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#a0a627a9eac4a916e93f94bc4e7bc0d25">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a0a627a9eac4a916e93f94bc4e7bc0d25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#ae069b04fba4a9fff00023476772a7b5b">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#ae069b04fba4a9fff00023476772a7b5b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#ac881f6320fb90d70afa0a5a86a38db11">get_completion_suffix</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& initial_text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtains a completion for <em>initial_text</em> from <em>completer</em>. <a href="#ac881f6320fb90d70afa0a5a86a38db11"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1ArrayHandle.html">Glib::StringArrayHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#aa56775c73bc3d1bd5a9749926d8a7134">get_completions</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a>& initial_text) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an array of completion strings for a given initial text. <a href="#aa56775c73bc3d1bd5a9749926d8a7134"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#abe7160d315c69ed35cdd5e1a25cf06bc">set_dirs_only</a> (bool dirs_only=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If <em>dirs_only</em> is <code>true</code>, <em>completer</em> will only complete directory names, and not file names. <a href="#abe7160d315c69ed35cdd5e1a25cf06bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#a3acc6e4468f03d924b9efae217b49e70">signal_got_completion_data</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGio_1_1FilenameCompleter.html">FilenameCompleter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#aeb7c3042c2f76a62f6806921bef56e89">create</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#a1db98397daf75605c3a827f646ea98ff">FilenameCompleter</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#a092cefc4a3cbeff19f60ef75ebfc8b87">on_got_completion_data</a> ()</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGio_1_1FilenameCompleter.html">Gio::FilenameCompleter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#ad03881744458e4aa6308376f5aebd2b3">wrap</a> (GFilenameCompleter* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ad03881744458e4aa6308376f5aebd2b3"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Completes partial file and directory names given a partial string by looking in the file system for clues. </p>
<p>Can return a list of possible completion strings for widget implementation.</p>
<dl class="since_2_16"><dt><b><a class="el" href="since_2_16.html#_since_2_16000031">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad72f983849b2ba03e2ef98868b56b27f"></a><!-- doxytag: member="Gio::FilenameCompleter::~FilenameCompleter" ref="ad72f983849b2ba03e2ef98868b56b27f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::FilenameCompleter::~FilenameCompleter </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1db98397daf75605c3a827f646ea98ff"></a><!-- doxytag: member="Gio::FilenameCompleter::FilenameCompleter" ref="a1db98397daf75605c3a827f646ea98ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gio::FilenameCompleter::FilenameCompleter </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aeb7c3042c2f76a62f6806921bef56e89"></a><!-- doxytag: member="Gio::FilenameCompleter::create" ref="aeb7c3042c2f76a62f6806921bef56e89" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1FilenameCompleter.html">FilenameCompleter</a>> Gio::FilenameCompleter::create </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac881f6320fb90d70afa0a5a86a38db11"></a><!-- doxytag: member="Gio::FilenameCompleter::get_completion_suffix" ref="ac881f6320fb90d70afa0a5a86a38db11" args="(const std::string &initial_text) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> Gio::FilenameCompleter::get_completion_suffix </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>initial_text</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Obtains a completion for <em>initial_text</em> from <em>completer</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>initial_text</em> </td><td>Text to be completed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A completed string, or <code>0</code> if no completion exists. This string is not owned by GIO, so remember to Glib::free() it when finished. </dd></dl>
</div>
</div>
<a class="anchor" id="aa56775c73bc3d1bd5a9749926d8a7134"></a><!-- doxytag: member="Gio::FilenameCompleter::get_completions" ref="aa56775c73bc3d1bd5a9749926d8a7134" args="(const std::string &initial_text) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1ArrayHandle.html">Glib::StringArrayHandle</a> Gio::FilenameCompleter::get_completions </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00971.html#a32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>initial_text</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets an array of completion strings for a given initial text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>initial_text</em> </td><td>Text to be completed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Array of strings with possible completions for <em>initial_text</em>. This array must be freed by Glib::strfreev() when finished. </dd></dl>
</div>
</div>
<a class="anchor" id="a0a627a9eac4a916e93f94bc4e7bc0d25"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj" ref="a0a627a9eac4a916e93f94bc4e7bc0d25" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GFilenameCompleter* Gio::FilenameCompleter::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a6fa2ba7f28935b557fac0dfe965fe916"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj" ref="a6fa2ba7f28935b557fac0dfe965fe916" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GFilenameCompleter* Gio::FilenameCompleter::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="ae069b04fba4a9fff00023476772a7b5b"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj_copy" ref="ae069b04fba4a9fff00023476772a7b5b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GFilenameCompleter* Gio::FilenameCompleter::gobj_copy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a092cefc4a3cbeff19f60ef75ebfc8b87"></a><!-- doxytag: member="Gio::FilenameCompleter::on_got_completion_data" ref="a092cefc4a3cbeff19f60ef75ebfc8b87" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gio::FilenameCompleter::on_got_completion_data </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="abe7160d315c69ed35cdd5e1a25cf06bc"></a><!-- doxytag: member="Gio::FilenameCompleter::set_dirs_only" ref="abe7160d315c69ed35cdd5e1a25cf06bc" args="(bool dirs_only=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gio::FilenameCompleter::set_dirs_only </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>dirs_only</em> = <code>true</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If <em>dirs_only</em> is <code>true</code>, <em>completer</em> will only complete directory names, and not file names. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dirs_only</em> </td><td>A <code>bool</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3acc6e4468f03d924b9efae217b49e70"></a><!-- doxytag: member="Gio::FilenameCompleter::signal_got_completion_data" ref="a3acc6e4468f03d924b9efae217b49e70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > Gio::FilenameCompleter::signal_got_completion_data </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_got_completion_data()</code> </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="ad03881744458e4aa6308376f5aebd2b3"></a><!-- doxytag: member="Gio::FilenameCompleter::wrap" ref="ad03881744458e4aa6308376f5aebd2b3" args="(GFilenameCompleter *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGio_1_1FilenameCompleter.html">Gio::FilenameCompleter</a> > wrap </td>
<td>(</td>
<td class="paramtype">GFilenameCompleter * </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="el" href="namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>giomm/filenamecompleter.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 11:07:22 2009 for glibmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
