<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>GFilenameCompleter</title> <meta name="generator" content="DocBook XSL Stylesheets V1.74.3"> <link rel="home" href="index.html" title="GIO Reference Manual"> <link rel="up" href="utils.html" title="Utilities"> <link rel="prev" href="utils.html" title="Utilities"> <link rel="next" href="extending.html" title="Extending GIO"> <meta name="generator" content="GTK-Doc V1.11 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> <link rel="part" href="pt01.html" title="Part I. GIO Overview"> <link rel="chapter" href="ch01.html" title="Introduction"> <link rel="chapter" href="ch02.html" title="Compiling GIO applications"> <link rel="chapter" href="ch03.html" title="Running GIO applications"> <link rel="chapter" href="extending-gio.html" title="Extending GIO"> <link rel="part" href="pt02.html" title="Part II. API Reference"> <link rel="chapter" href="file_ops.html" title="File Operations"> <link rel="chapter" href="file_mon.html" title="File System Monitoring"> <link rel="chapter" href="async.html" title="Asynchronous I/O"> <link rel="chapter" href="streaming.html" title="Streaming I/O"> <link rel="chapter" href="types.html" title="File types and applications"> <link rel="chapter" href="volume_mon.html" title="Volumes and Drives"> <link rel="chapter" href="icons.html" title="Icons"> <link rel="chapter" href="utils.html" title="Utilities"> <link rel="chapter" href="extending.html" title="Extending GIO"> <link rel="part" href="migrating.html" title="Part III. Migrating to GIO"> <link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO"> <link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO"> <link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy"> <link rel="index" href="ix01.html" title="Index"> <link rel="index" href="ix02.html" title="Index of new symbols in 2.18"> <link rel="index" href="ix03.html" title="Index of new symbols in 2.20"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> <tr valign="middle"> <td><a accesskey="p" href="utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td><a accesskey="u" href="utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">GIO Reference Manual</th> <td><a accesskey="n" href="extending.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr> <tr><td colspan="5" class="shortcuts"> <a href="#GFilenameCompleter.synopsis" class="shortcut">Top</a> | <a href="#GFilenameCompleter.description" class="shortcut">Description</a> | <a href="#GFilenameCompleter.object-hierarchy" class="shortcut">Object Hierarchy</a> | <a href="#GFilenameCompleter.signals" class="shortcut">Signals</a> </td></tr> </table> <div class="refentry" lang="en"> <a name="GFilenameCompleter"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> <h2><span class="refentrytitle"><a name="GFilenameCompleter.top_of_page"></a>GFilenameCompleter</span></h2> <p>GFilenameCompleter — Filename Completer</p> </td> <td valign="top" align="right"></td> </tr></table></div> <div class="refsynopsisdiv"> <a name="GFilenameCompleter.synopsis"></a><h2>Synopsis</h2> <pre class="synopsis"> #include <gio/gio.h> <a class="link" href="GFilenameCompleter.html#GFilenameCompleter-struct" title="GFilenameCompleter">GFilenameCompleter</a>; <a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> * <a class="link" href="GFilenameCompleter.html#g-filename-completer-new" title="g_filename_completer_new ()">g_filename_completer_new</a> (void); char * <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completion-suffix" title="g_filename_completer_get_completion_suffix ()">g_filename_completer_get_completion_suffix</a> (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, const char *initial_text); char ** <a class="link" href="GFilenameCompleter.html#g-filename-completer-get-completions" title="g_filename_completer_get_completions ()">g_filename_completer_get_completions</a> (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, const char *initial_text); void <a class="link" href="GFilenameCompleter.html#g-filename-completer-set-dirs-only" title="g_filename_completer_set_dirs_only ()">g_filename_completer_set_dirs_only</a> (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean" >gboolean</a> dirs_only); </pre> </div> <div class="refsect1" lang="en"> <a name="GFilenameCompleter.object-hierarchy"></a><h2>Object Hierarchy</h2> <pre class="synopsis"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject" >GObject</a> +----GFilenameCompleter </pre> </div> <div class="refsect1" lang="en"> <a name="GFilenameCompleter.signals"></a><h2>Signals</h2> <pre class="synopsis"> "<a class="link" href="GFilenameCompleter.html#GFilenameCompleter-got-completion-data" title='The "got-completion-data" signal'>got-completion-data</a>" : Run Last </pre> </div> <div class="refsect1" lang="en"> <a name="GFilenameCompleter.description"></a><h2>Description</h2> <p> Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible completion strings for widget implementations.</p> <p> </p> </div> <div class="refsect1" lang="en"> <a name="GFilenameCompleter.details"></a><h2>Details</h2> <div class="refsect2" lang="en"> <a name="GFilenameCompleter-struct"></a><h3>GFilenameCompleter</h3> <pre class="programlisting">typedef struct _GFilenameCompleter GFilenameCompleter;</pre> <p> Completes filenames based on files that exist within the file system.</p> <p> </p> </div> <hr> <div class="refsect2" lang="en"> <a name="g-filename-completer-new"></a><h3>g_filename_completer_new ()</h3> <pre class="programlisting"><a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> * g_filename_completer_new (void);</pre> <p> Creates a new filename completer.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> a <a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter"><span class="type">GFilenameCompleter</span></a>. </td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="g-filename-completer-get-completion-suffix"></a><h3>g_filename_completer_get_completion_suffix ()</h3> <pre class="programlisting">char * g_filename_completer_get_completion_suffix (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, const char *initial_text);</pre> <p> Obtains a completion for <em class="parameter"><code>initial_text</code></em> from <em class="parameter"><code>completer</code></em>.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td> <td> the filename completer. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>initial_text</code></em> :</span></p></td> <td> text to be completed. </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> a completed string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS" ><code class="literal">NULL</code></a> if no completion exists. This string is not owned by GIO, so remember to <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free" ><code class="function">g_free()</code></a> it when finished. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="g-filename-completer-get-completions"></a><h3>g_filename_completer_get_completions ()</h3> <pre class="programlisting">char ** g_filename_completer_get_completions (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, const char *initial_text);</pre> <p> Gets an array of completion strings for a given initial text.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td> <td> the filename completer. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>initial_text</code></em> :</span></p></td> <td> text to be completed. </td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> array of strings with possible completions for <em class="parameter"><code>initial_text</code></em>. This array must be freed by <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev" ><code class="function">g_strfreev()</code></a> when finished. </td> </tr> </tbody> </table></div> </div> <hr> <div class="refsect2" lang="en"> <a name="g-filename-completer-set-dirs-only"></a><h3>g_filename_completer_set_dirs_only ()</h3> <pre class="programlisting">void g_filename_completer_set_dirs_only (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *completer, <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean" >gboolean</a> dirs_only);</pre> <p> If <em class="parameter"><code>dirs_only</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS" ><code class="literal">TRUE</code></a>, <em class="parameter"><code>completer</code></em> will only complete directory names, and not file names.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>completer</code></em> :</span></p></td> <td> the filename completer. </td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>dirs_only</code></em> :</span></p></td> <td> a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean" ><span class="type">gboolean</span></a>. </td> </tr> </tbody> </table></div> </div> </div> <div class="refsect1" lang="en"> <a name="GFilenameCompleter.signal-details"></a><h2>Signal Details</h2> <div class="refsect2" lang="en"> <a name="GFilenameCompleter-got-completion-data"></a><h3>The <code class="literal">"got-completion-data"</code> signal</h3> <pre class="programlisting">void user_function (<a class="link" href="GFilenameCompleter.html" title="GFilenameCompleter">GFilenameCompleter</a> *arg0, <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer" >gpointer</a> user_data) : Run Last</pre> <p> Emitted when the file name completion information comes available.</p> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody><tr> <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> <td>user data set when the signal handler was connected.</td> </tr></tbody> </table></div> </div> </div> </div> <div class="footer"> <hr> Generated by GTK-Doc V1.11</div> </body> </html>