<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>glibmm 2.4: Gio::FilenameCompleter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../../../gtkmm-2.4/docs/index.html">Main Page</a>
<a href="../../../../gtkmm-2.4/docs/reference/html/group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html">glibmm Namespaces</a>
<a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="nav">
<a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1FilenameCompleter.html">FilenameCompleter</a></div>
<h1>Gio::FilenameCompleter Class Reference</h1><!-- doxytag: class="Gio::FilenameCompleter" --><!-- doxytag: inherits="Glib::Object" -->Completes partial file and directory names given a partial string by looking in the file system for clues.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Gio::FilenameCompleter:</div>
<div class="dynsection">
<p><center><img src="classGio_1_1FilenameCompleter__inherit__graph.png" border="0" usemap="#Gio_1_1FilenameCompleter__inherit__map" alt="Inheritance graph"></center>
<map name="Gio_1_1FilenameCompleter__inherit__map">
<area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="48,161,141,188"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="32,84,157,111"><area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="39,7,151,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classGio_1_1FilenameCompleter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#d72f983849b2ba03e2ef98868b56b27f">~FilenameCompleter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#6fa2ba7f28935b557fac0dfe965fe916">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#6fa2ba7f28935b557fac0dfe965fe916"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <br>
GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#0a627a9eac4a916e93f94bc4e7bc0d25">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#0a627a9eac4a916e93f94bc4e7bc0d25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GFilenameCompleter* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#e069b04fba4a9fff00023476772a7b5b">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="#e069b04fba4a9fff00023476772a7b5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#c881f6320fb90d70afa0a5a86a38db11">get_completion_suffix</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">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="#c881f6320fb90d70afa0a5a86a38db11"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#a56775c73bc3d1bd5a9749926d8a7134">get_completions</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">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="#a56775c73bc3d1bd5a9749926d8a7134"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#be7160d315c69ed35cdd5e1a25cf06bc">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="#be7160d315c69ed35cdd5e1a25cf06bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a><br>
<void> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#3acc6e4468f03d924b9efae217b49e70">signal_got_completion_data</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl class="user" compact><dt><b>Prototype:</b></dt><dd><code>void on_my_got_completion_data()</code> </dd></dl>
<a href="#3acc6e4468f03d924b9efae217b49e70"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGio_1_1FilenameCompleter.html">FilenameCompleter</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#eb7c3042c2f76a62f6806921bef56e89">create</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#1db98397daf75605c3a827f646ea98ff">FilenameCompleter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1FilenameCompleter.html#092cefc4a3cbeff19f60ef75ebfc8b87">on_got_completion_data</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<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#d03881744458e4aa6308376f5aebd2b3">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#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#d03881744458e4aa6308376f5aebd2b3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Completes partial file and directory names given a partial string by looking in the file system for clues.
<p>
Can return a list of possible completion strings for widget implementation.<p>
<dl compact><dt><b><a class="el" href="newin2p16s.html#_newin2p16s000030">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d72f983849b2ba03e2ef98868b56b27f"></a><!-- doxytag: member="Gio::FilenameCompleter::~FilenameCompleter" ref="d72f983849b2ba03e2ef98868b56b27f" 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 width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1db98397daf75605c3a827f646ea98ff"></a><!-- doxytag: member="Gio::FilenameCompleter::FilenameCompleter" ref="1db98397daf75605c3a827f646ea98ff" 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 width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6fa2ba7f28935b557fac0dfe965fe916"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj" ref="6fa2ba7f28935b557fac0dfe965fe916" 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 width="100%"><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#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="0a627a9eac4a916e93f94bc4e7bc0d25"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj" ref="0a627a9eac4a916e93f94bc4e7bc0d25" 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 width="100%"> 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#778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="e069b04fba4a9fff00023476772a7b5b"></a><!-- doxytag: member="Gio::FilenameCompleter::gobj_copy" ref="e069b04fba4a9fff00023476772a7b5b" 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 width="100%"></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><p>
<a class="anchor" name="eb7c3042c2f76a62f6806921bef56e89"></a><!-- doxytag: member="Gio::FilenameCompleter::create" ref="eb7c3042c2f76a62f6806921bef56e89" 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 width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c881f6320fb90d70afa0a5a86a38db11"></a><!-- doxytag: member="Gio::FilenameCompleter::get_completion_suffix" ref="c881f6320fb90d70afa0a5a86a38db11" args="(const std::string &initial_text) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> Gio::FilenameCompleter::get_completion_suffix </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>initial_text</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Obtains a completion for <em>initial_text</em> from <em>completer</em>.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="a56775c73bc3d1bd5a9749926d8a7134"></a><!-- doxytag: member="Gio::FilenameCompleter::get_completions" ref="a56775c73bc3d1bd5a9749926d8a7134" 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" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>initial_text</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets an array of completion strings for a given initial text.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><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><p>
<a class="anchor" name="be7160d315c69ed35cdd5e1a25cf06bc"></a><!-- doxytag: member="Gio::FilenameCompleter::set_dirs_only" ref="be7160d315c69ed35cdd5e1a25cf06bc" 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 width="100%"></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 compact><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>
</dl>
</div>
</div><p>
<a class="anchor" name="3acc6e4468f03d924b9efae217b49e70"></a><!-- doxytag: member="Gio::FilenameCompleter::signal_got_completion_data" ref="3acc6e4468f03d924b9efae217b49e70" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="user" compact><dt><b>Prototype:</b></dt><dd><code>void on_my_got_completion_data()</code> </dd></dl>
<p>
</div>
</div><p>
<a class="anchor" name="092cefc4a3cbeff19f60ef75ebfc8b87"></a><!-- doxytag: member="Gio::FilenameCompleter::on_got_completion_data" ref="092cefc4a3cbeff19f60ef75ebfc8b87" 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 width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="d03881744458e4aa6308376f5aebd2b3"></a><!-- doxytag: member="Gio::FilenameCompleter::wrap" ref="d03881744458e4aa6308376f5aebd2b3" 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 width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="filenamecompleter_8h.html">filenamecompleter.h</a></ul>
</div> <!-- end main content -->
<hr><address><small>
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.3 © 1997-2001</small></address>
</body>
</html>
