]> git.sur5r.net Git - glabels/blobdiff - docs/libglabels/html/libglabels-3.0-str.html
Imported Upstream version 3.2.1
[glabels] / docs / libglabels / html / libglabels-3.0-str.html
index 72c75367f800b51175734f992e8ebc110f13c784..182f4f5be4ad025e73972b2714a193abe122c658 100644 (file)
@@ -2,29 +2,26 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>String Utility Functions</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<title>LibGlabels 3.0 Reference Manual: String Utility Functions</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
 <link rel="up" href="ch03.html" title="Miscellaneous">
 <link rel="prev" href="libglabels-3.0-units.html" title="Units">
-<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </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="libglabels-3.0-units.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
-<td><a accesskey="u" href="ch03.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">LibGlabels 3.0 Reference Manual</th>
-<td> </td>
-</tr>
-<tr><td colspan="5" class="shortcuts">
-<a href="#libglabels-3.0-str.synopsis" class="shortcut">Top</a>
-                   | 
-                  <a href="#libglabels-3.0-str.description" class="shortcut">Description</a>
-</td></tr>
-</table>
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
+                  <a href="#libglabels-3.0-str.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
+                  <a href="#libglabels-3.0-str.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="libglabels-3.0-units.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
+</tr></table>
 <div class="refentry">
 <a name="libglabels-3.0-str"></a><div class="titlepage"></div>
 <div class="refnamediv"><table width="100%"><tr>
 <h2><span class="refentrytitle"><a name="libglabels-3.0-str.top_of_page"></a>String Utility Functions</span></h2>
 <p>String Utility Functions — String utility functions provided by libglabels</p>
 </td>
-<td valign="top" align="right"></td>
+<td class="gallery_image" valign="top" align="right"></td>
 </tr></table></div>
-<div class="refsynopsisdiv">
-<a name="libglabels-3.0-str.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis">
-#include &lt;libglabels/lgl-str.h&gt;
-
-<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libglabels-3.0-str.html#lgl-str-utf8-casecmp" title="lgl_str_utf8_casecmp ()">lgl_str_utf8_casecmp</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
-                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);
-<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libglabels-3.0-str.html#lgl-str-part-name-cmp" title="lgl_str_part_name_cmp ()">lgl_str_part_name_cmp</a>               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
-                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);
-<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libglabels-3.0-str.html#lgl-str-format-fraction" title="lgl_str_format_fraction ()">lgl_str_format_fraction</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>);
+<div class="refsect1">
+<a name="libglabels-3.0-str.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="libglabels-3.0-str.html#lgl-str-utf8-casecmp" title="lgl_str_utf8_casecmp ()">lgl_str_utf8_casecmp</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="libglabels-3.0-str.html#lgl-str-part-name-cmp" title="lgl_str_part_name_cmp ()">lgl_str_part_name_cmp</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="libglabels-3.0-str.html#lgl-str-format-fraction" title="lgl_str_format_fraction ()">lgl_str_format_fraction</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="libglabels-3.0-str.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">
+</pre>
+</div>
+<div class="refsect1">
+<a name="libglabels-3.0-str.includes"></a><h2>Includes</h2>
+<pre class="synopsis">#include &lt;libglabels/lgl-str.h&gt;
 </pre>
 </div>
 <div class="refsect1">
@@ -54,116 +84,129 @@ possible use to a user of libglabels.
 </p>
 </div>
 <div class="refsect1">
-<a name="libglabels-3.0-str.details"></a><h2>Details</h2>
+<a name="libglabels-3.0-str.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
-<a name="lgl-str-utf8-casecmp"></a><h3>lgl_str_utf8_casecmp ()</h3>
-<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_str_utf8_casecmp                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
-                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);</pre>
-<p>
-Compare two UTF-8 strings, ignoring the case of characters.
-</p>
-<p>
-This function should be used only on strings that are known to be encoded
-in UTF-8 or a compatible UTF-8 subset.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
+<a name="lgl-str-utf8-casecmp"></a><h3>lgl_str_utf8_casecmp ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
+lgl_str_utf8_casecmp (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
+                      <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);</pre>
+<p>Compare two UTF-8 strings, ignoring the case of characters.</p>
+<p>This function should be used only on strings that are known to be encoded
+in UTF-8 or a compatible UTF-8 subset.</p>
+<div class="refsect3">
+<a name="id-1.4.3.7.2.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
-<td>string to compare with s2.</td>
-</tr>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
-<td>string to compare with s1.</td>
+<td class="parameter_name"><p>s1</p></td>
+<td class="parameter_description"><p>string to compare with s2.</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>0 if the strings match, a negative value if s1 &lt; s2,
-or a positive value if s1 &gt; s2.</td>
+<td class="parameter_name"><p>s2</p></td>
+<td class="parameter_description"><p>string to compare with s1.</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
 </div>
+<div class="refsect3">
+<a name="id-1.4.3.7.2.7"></a><h4>Returns</h4>
+<p> 0 if the strings match, a negative value if s1 &lt; s2,
+or a positive value if s1 &gt; s2.</p>
+<p></p>
+</div>
+</div>
 <hr>
 <div class="refsect2">
-<a name="lgl-str-part-name-cmp"></a><h3>lgl_str_part_name_cmp ()</h3>
-<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_str_part_name_cmp               (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
-                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);</pre>
-<p>
-Compare two UTF-8 strings representing part names or numbers.  This function
-uses a natural sort order:
-</p>
-<p>
- - Ignores case.
-</p>
-<p>
- - Strings are divided into chunks (numeric and non-numeric)
-</p>
-<p>
- - Non-numeric chunks are compared character by character
-</p>
-<p>
- - Numerical chunks are compared numerically, so that "20" precedes "100".
-</p>
-<p>
- - Comparison of chunks is performed left to right until the first difference
-   is encountered or all chunks evaluate as equal.
-</p>
-<p>
-This function should be used only on strings that are known to be encoded
-in UTF-8 or a compatible UTF-8 subset.
-</p>
-<p>
-Numeric chunks are converted to 64 bit unsigned integers for comparison,
+<a name="lgl-str-part-name-cmp"></a><h3>lgl_str_part_name_cmp ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
+lgl_str_part_name_cmp (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s1</code></em>,
+                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *s2</code></em>);</pre>
+<p>Compare two UTF-8 strings representing part names or numbers.  This function
+uses a natural sort order:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>Ignores case.</p></li>
+<li class="listitem"><p>Strings are divided into chunks (numeric and non-numeric)</p></li>
+<li class="listitem"><p>Non-numeric chunks are compared character by character</p></li>
+<li class="listitem"><p>Numerical chunks are compared numerically, so that "20" precedes "100".</p></li>
+<li class="listitem"><p>Comparison of chunks is performed left to right until the first difference
+is encountered or all chunks evaluate as equal.</p></li>
+</ul></div>
+<p>This function should be used only on strings that are known to be encoded
+in UTF-8 or a compatible UTF-8 subset.</p>
+<p>Numeric chunks are converted to 64 bit unsigned integers for comparison,
 so the behaviour may be unpredictable for numeric chunks that exceed
-18446744073709551615.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
+18446744073709551615.</p>
+<div class="refsect3">
+<a name="id-1.4.3.7.3.8"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
 <tbody>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
-<td>string to compare with s2.</td>
+<td class="parameter_name"><p>s1</p></td>
+<td class="parameter_description"><p>string to compare with s2.</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 <tr>
-<td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
-<td>string to compare with s1.</td>
-</tr>
-<tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>0 if the strings match, a negative value if s1 &lt; s2,
-or a positive value if s1 &gt; s2.</td>
+<td class="parameter_name"><p>s2</p></td>
+<td class="parameter_description"><p>string to compare with s1.</p></td>
+<td class="parameter_annotations"> </td>
 </tr>
 </tbody>
 </table></div>
 </div>
+<div class="refsect3">
+<a name="id-1.4.3.7.3.9"></a><h4>Returns</h4>
+<p> 0 if the strings match, a negative value if s1 &lt; s2,
+or a positive value if s1 &gt; s2.</p>
+<p></p>
+</div>
+</div>
 <hr>
 <div class="refsect2">
-<a name="lgl-str-format-fraction"></a><h3>lgl_str_format_fraction ()</h3>
-<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             lgl_str_format_fraction             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>);</pre>
-<p>
-Create fractional representation of number, if possible.  Uses UTF-8 superscripts and
-subscripts for numerator and denominator values respecively.
-</p>
-<div class="variablelist"><table border="0">
-<col align="left" valign="top">
-<tbody>
-<tr>
-<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
-<td>Floating point number to convert to fractional notation</td>
-</tr>
-<tr>
-<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
-<td>UTF-8 string containing fractional representation of x.</td>
-</tr>
-</tbody>
+<a name="lgl-str-format-fraction"></a><h3>lgl_str_format_fraction ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
+lgl_str_format_fraction (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>);</pre>
+<p>Create fractional representation of number, if possible.  Uses UTF-8 superscripts and
+subscripts for numerator and denominator values respecively.</p>
+<div class="refsect3">
+<a name="id-1.4.3.7.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>x</p></td>
+<td class="parameter_description"><p>Floating point number to convert to fractional notation</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
 </table></div>
 </div>
+<div class="refsect3">
+<a name="id-1.4.3.7.4.6"></a><h4>Returns</h4>
+<p> UTF-8 string containing fractional representation of x.</p>
+<p></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="libglabels-3.0-str.other_details"></a><h2>Types and Values</h2>
 </div>
 </div>
 <div class="footer">
 <hr>
-          Generated by GTK-Doc V1.18</div>
+          Generated by GTK-Doc V1.20</div>
 </body>
 </html>
\ No newline at end of file