docs/reference/glib/html/glib-Automatic-String-Completion.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Automatic String Completion</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GLib Reference Manual">
   8 <link rel="up" href="deprecated.html" title="Deprecated APIs">
   9 <link rel="prev" href="glib-Relations-and-Tuples.html" title="Relations and Tuples">
  10 <link rel="next" href="tools.html" title="GLib Tools">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="glib-Relations-and-Tuples.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="deprecated.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GLib Reference Manual</th>
  21 <td><a accesskey="n" href="tools.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#glib-Automatic-String-Completion.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#glib-Automatic-String-Completion.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="glib-Automatic-String-Completion"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="glib-Automatic-String-Completion.top_of_page"></a>Automatic String Completion</span></h2>
  34 <p>Automatic String Completion — support for automatic completion using a group
  35                     of target strings</p>
  36 </td>
  37 <td valign="top" align="right"></td>
  38 </tr></table></div>
  39 <div class="refsynopsisdiv">
  40 <a name="glib-Automatic-String-Completion.synopsis"></a><h2>Synopsis</h2>
  41 <pre class="synopsis">
  42 #include &lt;glib.h&gt;
  43
  44 struct              <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion">GCompletion</a>;
  45 <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="returnvalue">GCompletion</span></a> *       <a class="link" href="glib-Automatic-String-Completion.html#g-completion-new" title="g_completion_new ()">g_completion_new</a>                    (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletionFunc" title="GCompletionFunc ()"><span class="type">GCompletionFunc</span></a> func</code></em>);
  46 <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *             (<a class="link" href="glib-Automatic-String-Completion.html#GCompletionFunc" title="GCompletionFunc ()">*GCompletionFunc</a>)                  (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> Param1</code></em>);
  47 <span class="returnvalue">void</span>                <a class="link" href="glib-Automatic-String-Completion.html#g-completion-add-items" title="g_completion_add_items ()">g_completion_add_items</a>              (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
  48                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *items</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="glib-Automatic-String-Completion.html#g-completion-remove-items" title="g_completion_remove_items ()">g_completion_remove_items</a>           (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *items</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="glib-Automatic-String-Completion.html#g-completion-clear-items" title="g_completion_clear_items ()">g_completion_clear_items</a>            (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>);
  52 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete" title="g_completion_complete ()">g_completion_complete</a>               (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
  53                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *prefix</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> **new_prefix</code></em>);
  55 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete-utf8" title="g_completion_complete_utf8 ()">g_completion_complete_utf8</a>          (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
  56                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *prefix</code></em>,
  57                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> **new_prefix</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="glib-Automatic-String-Completion.html#g-completion-set-compare" title="g_completion_set_compare ()">g_completion_set_compare</a>            (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
  59                                                          <em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletionStrncmpFunc" title="GCompletionStrncmpFunc ()"><span class="type">GCompletionStrncmpFunc</span></a> strncmp_func</code></em>);
  60 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="glib-Automatic-String-Completion.html#GCompletionStrncmpFunc" title="GCompletionStrncmpFunc ()">*GCompletionStrncmpFunc</a>)           (<em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *s1</code></em>,
  61                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *s2</code></em>,
  62                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="type">gsize</span></a> n</code></em>);
  63 <span class="returnvalue">void</span>                <a class="link" href="glib-Automatic-String-Completion.html#g-completion-free" title="g_completion_free ()">g_completion_free</a>                   (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>);
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="glib-Automatic-String-Completion.description"></a><h2>Description</h2>
  68 <p>
  69 <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> provides support for automatic completion of a string
  70 using any group of target strings. It is typically used for file
  71 name completion as is common in many UNIX shells.
  72 </p>
  73 <p>
  74 A <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> is created using <a class="link" href="glib-Automatic-String-Completion.html#g-completion-new" title="g_completion_new ()"><code class="function">g_completion_new()</code></a>. Target items are
  75 added and removed with <a class="link" href="glib-Automatic-String-Completion.html#g-completion-add-items" title="g_completion_add_items ()"><code class="function">g_completion_add_items()</code></a>,
  76 <a class="link" href="glib-Automatic-String-Completion.html#g-completion-remove-items" title="g_completion_remove_items ()"><code class="function">g_completion_remove_items()</code></a> and <a class="link" href="glib-Automatic-String-Completion.html#g-completion-clear-items" title="g_completion_clear_items ()"><code class="function">g_completion_clear_items()</code></a>. A
  77 completion attempt is requested with <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete" title="g_completion_complete ()"><code class="function">g_completion_complete()</code></a> or
  78 <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete-utf8" title="g_completion_complete_utf8 ()"><code class="function">g_completion_complete_utf8()</code></a>. When no longer needed, the
  79 <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> is freed with <a class="link" href="glib-Automatic-String-Completion.html#g-completion-free" title="g_completion_free ()"><code class="function">g_completion_free()</code></a>.
  80 </p>
  81 <p>
  82 Items in the completion can be simple strings (e.g. filenames), or
  83 pointers to arbitrary data structures. If data structures are used
  84 you must provide a <a class="link" href="glib-Automatic-String-Completion.html#GCompletionFunc" title="GCompletionFunc ()"><span class="type">GCompletionFunc</span></a> in <a class="link" href="glib-Automatic-String-Completion.html#g-completion-new" title="g_completion_new ()"><code class="function">g_completion_new()</code></a>, which
  85 retrieves the item's string from the data structure. You can change
  86 the way in which strings are compared by setting a different
  87 <a class="link" href="glib-Automatic-String-Completion.html#GCompletionStrncmpFunc" title="GCompletionStrncmpFunc ()"><span class="type">GCompletionStrncmpFunc</span></a> in <a class="link" href="glib-Automatic-String-Completion.html#g-completion-set-compare" title="g_completion_set_compare ()"><code class="function">g_completion_set_compare()</code></a>.
  88 </p>
  89 <p>
  90 GCompletion has been marked as deprecated, since this API is rarely
  91 used and not very actively maintained.
  92 </p>
  93 </div>
  94 <div class="refsect1">
  95 <a name="glib-Automatic-String-Completion.details"></a><h2>Details</h2>
  96 <div class="refsect2">
  97 <a name="GCompletion"></a><h3>struct GCompletion</h3>
  98 <pre class="programlisting">struct GCompletion {
  99   GList* items;
 100   GCompletionFunc func;
 101
 102   gchar* prefix;
 103   GList* cache;
 104   GCompletionStrncmpFunc strncmp_func;
 105 };
 106 </pre>
 107 <p>
 108 The data structure used for automatic completion.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GCompletion.items"></a>items</code></em>;</span></p></td>
 115 <td>list of target items (strings or data structures).</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term"><a class="link" href="glib-Automatic-String-Completion.html#GCompletionFunc" title="GCompletionFunc ()"><span class="type">GCompletionFunc</span></a> <em class="structfield"><code><a name="GCompletion.func"></a>func</code></em>;</span></p></td>
 119 <td>function which is called to get the string associated with a
 120 target item. It is <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the target items are strings.</td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GCompletion.prefix"></a>prefix</code></em>;</span></p></td>
 124 <td>the last prefix passed to <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete" title="g_completion_complete ()"><code class="function">g_completion_complete()</code></a> or
 125 <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete-utf8" title="g_completion_complete_utf8 ()"><code class="function">g_completion_complete_utf8()</code></a>.</td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GCompletion.cache"></a>cache</code></em>;</span></p></td>
 129 <td>the list of items which begin with <em class="parameter"><code>prefix</code></em>.</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term"><a class="link" href="glib-Automatic-String-Completion.html#GCompletionStrncmpFunc" title="GCompletionStrncmpFunc ()"><span class="type">GCompletionStrncmpFunc</span></a> <em class="structfield"><code><a name="GCompletion.strncmp-func"></a>strncmp_func</code></em>;</span></p></td>
 133 <td>The function to use when comparing strings.  Use
 134 <a class="link" href="glib-Automatic-String-Completion.html#g-completion-set-compare" title="g_completion_set_compare ()"><code class="function">g_completion_set_compare()</code></a> to modify this function.</td>
 135 </tr>
 136 </tbody>
 137 </table></div>
 138 </div>
 139 <hr>
 140 <div class="refsect2">
 141 <a name="g-completion-new"></a><h3>g_completion_new ()</h3>
 142 <pre class="programlisting"><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="returnvalue">GCompletion</span></a> *       g_completion_new                    (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletionFunc" title="GCompletionFunc ()"><span class="type">GCompletionFunc</span></a> func</code></em>);</pre>
 143 <p>
 144 Creates a new <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.
 145 </p>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 151 <td>the function to be called to return the string representing
 152 an item in the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if strings are going to
 153 be used as the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> items.</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 157 <td>the new <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 </div>
 162 <hr>
 163 <div class="refsect2">
 164 <a name="GCompletionFunc"></a><h3>GCompletionFunc ()</h3>
 165 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="returnvalue">gchar</span></a> *             (*GCompletionFunc)                  (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> Param1</code></em>);</pre>
 166 <p>
 167 Specifies the type of the function passed to <a class="link" href="glib-Automatic-String-Completion.html#g-completion-new" title="g_completion_new ()"><code class="function">g_completion_new()</code></a>. It
 168 should return the string corresponding to the given target item.
 169 This is used when you use data structures as <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> items.
 170 </p>
 171 <div class="variablelist"><table border="0">
 172 <col align="left" valign="top">
 173 <tbody>
 174 <tr>
 175 <td><p><span class="term"><em class="parameter"><code>Param1</code></em> :</span></p></td>
 176 <td>the completion item.</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 180 <td>the string corresponding to the item.</td>
 181 </tr>
 182 </tbody>
 183 </table></div>
 184 </div>
 185 <hr>
 186 <div class="refsect2">
 187 <a name="g-completion-add-items"></a><h3>g_completion_add_items ()</h3>
 188 <pre class="programlisting"><span class="returnvalue">void</span>                g_completion_add_items              (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
 189                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *items</code></em>);</pre>
 190 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 191 <h3 class="title">Warning</h3>
 192 <p><code class="literal">g_completion_add_items</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 193 </div>
 194 <p>
 195 Adds items to the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.
 196 </p>
 197 <div class="variablelist"><table border="0">
 198 <col align="left" valign="top">
 199 <tbody>
 200 <tr>
 201 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 202 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"><em class="parameter"><code>items</code></em> :</span></p></td>
 206 <td>the list of items to add.</td>
 207 </tr>
 208 </tbody>
 209 </table></div>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="g-completion-remove-items"></a><h3>g_completion_remove_items ()</h3>
 214 <pre class="programlisting"><span class="returnvalue">void</span>                g_completion_remove_items           (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
 215                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *items</code></em>);</pre>
 216 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 217 <h3 class="title">Warning</h3>
 218 <p><code class="literal">g_completion_remove_items</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 219 </div>
 220 <p>
 221 Removes items from a <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.
 222 </p>
 223 <div class="variablelist"><table border="0">
 224 <col align="left" valign="top">
 225 <tbody>
 226 <tr>
 227 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 228 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 229 </tr>
 230 <tr>
 231 <td><p><span class="term"><em class="parameter"><code>items</code></em> :</span></p></td>
 232 <td>the items to remove.</td>
 233 </tr>
 234 </tbody>
 235 </table></div>
 236 </div>
 237 <hr>
 238 <div class="refsect2">
 239 <a name="g-completion-clear-items"></a><h3>g_completion_clear_items ()</h3>
 240 <pre class="programlisting"><span class="returnvalue">void</span>                g_completion_clear_items            (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>);</pre>
 241 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 242 <h3 class="title">Warning</h3>
 243 <p><code class="literal">g_completion_clear_items</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 244 </div>
 245 <p>
 246 Removes all items from the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.
 247 </p>
 248 <div class="variablelist"><table border="0">
 249 <col align="left" valign="top">
 250 <tbody><tr>
 251 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 252 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 253 </tr></tbody>
 254 </table></div>
 255 </div>
 256 <hr>
 257 <div class="refsect2">
 258 <a name="g-completion-complete"></a><h3>g_completion_complete ()</h3>
 259 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_completion_complete               (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
 260                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *prefix</code></em>,
 261                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> **new_prefix</code></em>);</pre>
 262 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 263 <h3 class="title">Warning</h3>
 264 <p><code class="literal">g_completion_complete</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 265 </div>
 266 <p>
 267 Attempts to complete the string <em class="parameter"><code>prefix</code></em> using the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>
 268 target items.
 269 </p>
 270 <div class="variablelist"><table border="0">
 271 <col align="left" valign="top">
 272 <tbody>
 273 <tr>
 274 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 275 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 276 </tr>
 277 <tr>
 278 <td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
 279 <td>the prefix string, typically typed by the user, which is
 280 compared with each of the items.</td>
 281 </tr>
 282 <tr>
 283 <td><p><span class="term"><em class="parameter"><code>new_prefix</code></em> :</span></p></td>
 284 <td>if non-<a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, returns the longest prefix which is
 285 common to all items that matched <em class="parameter"><code>prefix</code></em>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if
 286 no items matched <em class="parameter"><code>prefix</code></em>.  This string should be freed
 287 when no longer needed.</td>
 288 </tr>
 289 <tr>
 290 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 291 <td>the list of items whose strings begin with <em class="parameter"><code>prefix</code></em>. This
 292 should not be changed.</td>
 293 </tr>
 294 </tbody>
 295 </table></div>
 296 </div>
 297 <hr>
 298 <div class="refsect2">
 299 <a name="g-completion-complete-utf8"></a><h3>g_completion_complete_utf8 ()</h3>
 300 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_completion_complete_utf8          (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
 301                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *prefix</code></em>,
 302                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> **new_prefix</code></em>);</pre>
 303 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 304 <h3 class="title">Warning</h3>
 305 <p><code class="literal">g_completion_complete_utf8</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 306 </div>
 307 <p>
 308 Attempts to complete the string <em class="parameter"><code>prefix</code></em> using the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> target items.
 309 In contrast to <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete" title="g_completion_complete ()"><code class="function">g_completion_complete()</code></a>, this function returns the largest common
 310 prefix that is a valid UTF-8 string, omitting a possible common partial
 311 character.
 312 </p>
 313 <p>
 314 You should use this function instead of <a class="link" href="glib-Automatic-String-Completion.html#g-completion-complete" title="g_completion_complete ()"><code class="function">g_completion_complete()</code></a> if your
 315 items are UTF-8 strings.
 316 </p>
 317 <div class="variablelist"><table border="0">
 318 <col align="left" valign="top">
 319 <tbody>
 320 <tr>
 321 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 322 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>
 323 </td>
 324 </tr>
 325 <tr>
 326 <td><p><span class="term"><em class="parameter"><code>prefix</code></em> :</span></p></td>
 327 <td>the prefix string, typically used by the user, which is compared
 328 with each of the items</td>
 329 </tr>
 330 <tr>
 331 <td><p><span class="term"><em class="parameter"><code>new_prefix</code></em> :</span></p></td>
 332 <td>if non-<a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, returns the longest prefix which is common to all
 333 items that matched <em class="parameter"><code>prefix</code></em>, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if no items matched <em class="parameter"><code>prefix</code></em>.
 334 This string should be freed when no longer needed.</td>
 335 </tr>
 336 <tr>
 337 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 338 <td>the list of items whose strings begin with <em class="parameter"><code>prefix</code></em>. This should
 339 not be changed. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 340 </td>
 341 </tr>
 342 </tbody>
 343 </table></div>
 344 <p class="since">Since 2.4</p>
 345 </div>
 346 <hr>
 347 <div class="refsect2">
 348 <a name="g-completion-set-compare"></a><h3>g_completion_set_compare ()</h3>
 349 <pre class="programlisting"><span class="returnvalue">void</span>                g_completion_set_compare            (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>,
 350                                                          <em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletionStrncmpFunc" title="GCompletionStrncmpFunc ()"><span class="type">GCompletionStrncmpFunc</span></a> strncmp_func</code></em>);</pre>
 351 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 352 <h3 class="title">Warning</h3>
 353 <p><code class="literal">g_completion_set_compare</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 354 </div>
 355 <p>
 356 Sets the function to use for string comparisons. The default string
 357 comparison function is <code class="function">strncmp()</code>.
 358 </p>
 359 <div class="variablelist"><table border="0">
 360 <col align="left" valign="top">
 361 <tbody>
 362 <tr>
 363 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 364 <td>a <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 365 </tr>
 366 <tr>
 367 <td><p><span class="term"><em class="parameter"><code>strncmp_func</code></em> :</span></p></td>
 368 <td>the string comparison function.</td>
 369 </tr>
 370 </tbody>
 371 </table></div>
 372 </div>
 373 <hr>
 374 <div class="refsect2">
 375 <a name="GCompletionStrncmpFunc"></a><h3>GCompletionStrncmpFunc ()</h3>
 376 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (*GCompletionStrncmpFunc)           (<em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *s1</code></em>,
 377                                                          <em class="parameter"><code>const <a class="link" href="glib-Basic-Types.html#gchar" title="gchar"><span class="type">gchar</span></a> *s2</code></em>,
 378                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gsize" title="gsize"><span class="type">gsize</span></a> n</code></em>);</pre>
 379 <p>
 380 Specifies the type of the function passed to
 381 <a class="link" href="glib-Automatic-String-Completion.html#g-completion-set-compare" title="g_completion_set_compare ()"><code class="function">g_completion_set_compare()</code></a>. This is used when you use strings as
 382 <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> items.
 383 </p>
 384 <div class="variablelist"><table border="0">
 385 <col align="left" valign="top">
 386 <tbody>
 387 <tr>
 388 <td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
 389 <td>string to compare with <em class="parameter"><code>s2</code></em>.</td>
 390 </tr>
 391 <tr>
 392 <td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
 393 <td>string to compare with <em class="parameter"><code>s1</code></em>.</td>
 394 </tr>
 395 <tr>
 396 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
 397 <td>maximal number of bytes to compare.</td>
 398 </tr>
 399 <tr>
 400 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 401 <td>an integer less than, equal to, or greater than zero if
 402 the first <em class="parameter"><code>n</code></em> bytes of <em class="parameter"><code>s1</code></em> is found, respectively, to be
 403 less than, to match, or to be greater than the first <em class="parameter"><code>n</code></em>
 404 bytes of <em class="parameter"><code>s2</code></em>.</td>
 405 </tr>
 406 </tbody>
 407 </table></div>
 408 </div>
 409 <hr>
 410 <div class="refsect2">
 411 <a name="g-completion-free"></a><h3>g_completion_free ()</h3>
 412 <pre class="programlisting"><span class="returnvalue">void</span>                g_completion_free                   (<em class="parameter"><code><a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a> *cmp</code></em>);</pre>
 413 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 414 <h3 class="title">Warning</h3>
 415 <p><code class="literal">g_completion_free</code> has been deprecated since version 2.26 and should not be used in newly-written code. Rarely used API</p>
 416 </div>
 417 <p>
 418 Frees all memory used by the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.
 419 </p>
 420 <div class="variablelist"><table border="0">
 421 <col align="left" valign="top">
 422 <tbody><tr>
 423 <td><p><span class="term"><em class="parameter"><code>cmp</code></em> :</span></p></td>
 424 <td>the <a class="link" href="glib-Automatic-String-Completion.html#GCompletion" title="struct GCompletion"><span class="type">GCompletion</span></a>.</td>
 425 </tr></tbody>
 426 </table></div>
 427 </div>
 428 </div>
 429 </div>
 430 <div class="footer">
 431 <hr>
 432           Generated by GTK-Doc V1.18</div>
 433 </body>
 434 </html>