Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > 2dc7ae7102ce788eb8a15dec0caf7708 > files > 177

xapian-core-devel-1.0.21-1.fc13.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::Utf8Iterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a></div>
<h1>Xapian::Utf8Iterator Class Reference</h1><!-- doxytag: class="Xapian::Utf8Iterator" -->An iterator which returns <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character values from a UTF-8 encoded string.  
<a href="#_details">More...</a>
<p>
<a href="classXapian_1_1Utf8Iterator-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 Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::input_iterator_tag&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#6610090727e218ea795648417985c5d6">iterator_category</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We implement the semantics of an STL input_iterator.  <a href="#6610090727e218ea795648417985c5d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#a3348546aff8fa8cae41963dc43e54b6">value_type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We implement the semantics of an STL input_iterator.  <a href="#a3348546aff8fa8cae41963dc43e54b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#6edb1128a7809af78365c4707b9e72a0">difference_type</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We implement the semantics of an STL input_iterator.  <a href="#6edb1128a7809af78365c4707b9e72a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef const unsigned *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#5be0948b154ef36457c2723f378f9c9d">pointer</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We implement the semantics of an STL input_iterator.  <a href="#5be0948b154ef36457c2723f378f9c9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef const unsigned &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#b2a2b2ae205dca0e40040eee63789989">reference</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">We implement the semantics of an STL input_iterator.  <a href="#b2a2b2ae205dca0e40040eee63789989"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#608a87cc6457b46e3dad32ab9a9bb024">raw</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the raw const char * pointer for the current position.  <a href="#608a87cc6457b46e3dad32ab9a9bb024"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#68197aed4a92e1dc1bed19021bcaa279">left</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of bytes left in the iterator's buffer.  <a href="#68197aed4a92e1dc1bed19021bcaa279"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#bef71d16997ae0fb1e786038501762b6">assign</a> (const char *p_, size_t len)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign a new string to the iterator.  <a href="#bef71d16997ae0fb1e786038501762b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#ad2d8a188c07ec6e9ab456e14597625c">assign</a> (const std::string &amp;s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign a new string to the iterator.  <a href="#ad2d8a188c07ec6e9ab456e14597625c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#74404df7b0c648db9ba4e89f4ae19ddd">Utf8Iterator</a> (const char *p_)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator given a pointer to a null terminated string.  <a href="#74404df7b0c648db9ba4e89f4ae19ddd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#751a24656d8adb8d89a71e60d6cb46f8">Utf8Iterator</a> (const char *p_, size_t len)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator given a pointer and a length.  <a href="#751a24656d8adb8d89a71e60d6cb46f8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#f15aa02248ecf5757da20b34cb334d3c">Utf8Iterator</a> (const std::string &amp;s)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator given a string.  <a href="#f15aa02248ecf5757da20b34cb334d3c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#dbf68d75021b3a9623552abf42e8f1ff">Utf8Iterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an iterator which is at the end of its iteration.  <a href="#dbf68d75021b3a9623552abf42e8f1ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#068d7ba7dc93b66972b1496ea865c66f">operator *</a> () const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character value pointed to by the iterator.  <a href="#068d7ba7dc93b66972b1496ea865c66f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#c07043e999ebf169eb2b7fe1738b2707">operator++</a> (int)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character.  <a href="#c07043e999ebf169eb2b7fe1738b2707"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#d2f73b48793d312f57690cadeb86f826">operator++</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character.  <a href="#d2f73b48793d312f57690cadeb86f826"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#f3247ab0bcbb472aceb0a5e59b020f20">operator==</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> &amp;other) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test two Utf8Iterators for equality.  <a href="#f3247ab0bcbb472aceb0a5e59b020f20"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Utf8Iterator.html#09e12ac62841fcc2b0f7383aed9e1277">operator!=</a> (const <a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> &amp;other) const</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test two Utf8Iterators for inequality.  <a href="#09e12ac62841fcc2b0f7383aed9e1277"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator which returns <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character values from a UTF-8 encoded string. 
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="6610090727e218ea795648417985c5d6"></a><!-- doxytag: member="Xapian::Utf8Iterator::iterator_category" ref="6610090727e218ea795648417985c5d6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::input_iterator_tag <a class="el" href="classXapian_1_1Utf8Iterator.html#6610090727e218ea795648417985c5d6">Xapian::Utf8Iterator::iterator_category</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
We implement the semantics of an STL input_iterator. 
<p>

</div>
</div><p>
<a class="anchor" name="a3348546aff8fa8cae41963dc43e54b6"></a><!-- doxytag: member="Xapian::Utf8Iterator::value_type" ref="a3348546aff8fa8cae41963dc43e54b6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef unsigned <a class="el" href="classXapian_1_1Utf8Iterator.html#a3348546aff8fa8cae41963dc43e54b6">Xapian::Utf8Iterator::value_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
We implement the semantics of an STL input_iterator. 
<p>

</div>
</div><p>
<a class="anchor" name="6edb1128a7809af78365c4707b9e72a0"></a><!-- doxytag: member="Xapian::Utf8Iterator::difference_type" ref="6edb1128a7809af78365c4707b9e72a0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef size_t <a class="el" href="classXapian_1_1Utf8Iterator.html#6edb1128a7809af78365c4707b9e72a0">Xapian::Utf8Iterator::difference_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
We implement the semantics of an STL input_iterator. 
<p>

</div>
</div><p>
<a class="anchor" name="5be0948b154ef36457c2723f378f9c9d"></a><!-- doxytag: member="Xapian::Utf8Iterator::pointer" ref="5be0948b154ef36457c2723f378f9c9d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef const unsigned* <a class="el" href="classXapian_1_1Utf8Iterator.html#5be0948b154ef36457c2723f378f9c9d">Xapian::Utf8Iterator::pointer</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
We implement the semantics of an STL input_iterator. 
<p>

</div>
</div><p>
<a class="anchor" name="b2a2b2ae205dca0e40040eee63789989"></a><!-- doxytag: member="Xapian::Utf8Iterator::reference" ref="b2a2b2ae205dca0e40040eee63789989" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef const unsigned&amp; <a class="el" href="classXapian_1_1Utf8Iterator.html#b2a2b2ae205dca0e40040eee63789989">Xapian::Utf8Iterator::reference</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
We implement the semantics of an STL input_iterator. 
<p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="74404df7b0c648db9ba4e89f4ae19ddd"></a><!-- doxytag: member="Xapian::Utf8Iterator::Utf8Iterator" ref="74404df7b0c648db9ba4e89f4ae19ddd" args="(const char *p_)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::Utf8Iterator::Utf8Iterator           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>p_</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an iterator given a pointer to a null terminated string. 
<p>
The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.<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>p_</em>&nbsp;</td><td>A pointer to the start of the null terminated string to read. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="751a24656d8adb8d89a71e60d6cb46f8"></a><!-- doxytag: member="Xapian::Utf8Iterator::Utf8Iterator" ref="751a24656d8adb8d89a71e60d6cb46f8" args="(const char *p_, size_t len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::Utf8Iterator::Utf8Iterator           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>p_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an iterator given a pointer and a length. 
<p>
The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.<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>p_</em>&nbsp;</td><td>A pointer to the start of the string to read.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>The length of the string to read. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="f15aa02248ecf5757da20b34cb334d3c"></a><!-- doxytag: member="Xapian::Utf8Iterator::Utf8Iterator" ref="f15aa02248ecf5757da20b34cb334d3c" args="(const std::string &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::Utf8Iterator::Utf8Iterator           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an iterator given a string. 
<p>
The iterator will return characters from the start of the string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.<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>s</em>&nbsp;</td><td>The string to read. Must not be modified while the iteration is in progress. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="dbf68d75021b3a9623552abf42e8f1ff"></a><!-- doxytag: member="Xapian::Utf8Iterator::Utf8Iterator" ref="dbf68d75021b3a9623552abf42e8f1ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Xapian::Utf8Iterator::Utf8Iterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an iterator which is at the end of its iteration. 
<p>
This can be compared to another iterator to check if the other iterator has reached its end. 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="608a87cc6457b46e3dad32ab9a9bb024"></a><!-- doxytag: member="Xapian::Utf8Iterator::raw" ref="608a87cc6457b46e3dad32ab9a9bb024" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* Xapian::Utf8Iterator::raw           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the raw const char * pointer for the current position. 
<p>

</div>
</div><p>
<a class="anchor" name="68197aed4a92e1dc1bed19021bcaa279"></a><!-- doxytag: member="Xapian::Utf8Iterator::left" ref="68197aed4a92e1dc1bed19021bcaa279" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t Xapian::Utf8Iterator::left           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the number of bytes left in the iterator's buffer. 
<p>

</div>
</div><p>
<a class="anchor" name="bef71d16997ae0fb1e786038501762b6"></a><!-- doxytag: member="Xapian::Utf8Iterator::assign" ref="bef71d16997ae0fb1e786038501762b6" args="(const char *p_, size_t len)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::Utf8Iterator::assign           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>p_</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>len</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assign a new string to the iterator. 
<p>
The iterator will forget the string it was iterating through, and return characters from the start of the new string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.<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>p_</em>&nbsp;</td><td>A pointer to the start of the string to read.</td></tr>
    <tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>The length of the string to read. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="ad2d8a188c07ec6e9ab456e14597625c"></a><!-- doxytag: member="Xapian::Utf8Iterator::assign" ref="ad2d8a188c07ec6e9ab456e14597625c" args="(const std::string &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Xapian::Utf8Iterator::assign           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assign a new string to the iterator. 
<p>
The iterator will forget the string it was iterating through, and return characters from the start of the new string when next called. The string is not copied into the iterator, so it must remain valid while the iteration is in progress.<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>s</em>&nbsp;</td><td>The string to read. Must not be modified while the iteration is in progress. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="068d7ba7dc93b66972b1496ea865c66f"></a><!-- doxytag: member="Xapian::Utf8Iterator::operator *" ref="068d7ba7dc93b66972b1496ea865c66f" args="() const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned Xapian::Utf8Iterator::operator *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the current <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character value pointed to by the iterator. 
<p>
Returns unsigned(-1) if the iterator has reached the end of its buffer. 
</div>
</div><p>
<a class="anchor" name="c07043e999ebf169eb2b7fe1738b2707"></a><!-- doxytag: member="Xapian::Utf8Iterator::operator++" ref="c07043e999ebf169eb2b7fe1738b2707" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> Xapian::Utf8Iterator::operator++           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An iterator pointing to the position before the move. </dd></dl>

</div>
</div><p>
<a class="anchor" name="d2f73b48793d312f57690cadeb86f826"></a><!-- doxytag: member="Xapian::Utf8Iterator::operator++" ref="d2f73b48793d312f57690cadeb86f826" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a>&amp; Xapian::Utf8Iterator::operator++           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Move forward to the next <a class="el" href="namespaceXapian_1_1Unicode.html" title="Functions associated with handling Unicode characters.">Unicode</a> character. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to this object. </dd></dl>

</div>
</div><p>
<a class="anchor" name="f3247ab0bcbb472aceb0a5e59b020f20"></a><!-- doxytag: member="Xapian::Utf8Iterator::operator==" ref="f3247ab0bcbb472aceb0a5e59b020f20" args="(const Utf8Iterator &amp;other) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Xapian::Utf8Iterator::operator==           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test two Utf8Iterators for equality. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true iff the iterators point to the same position. </dd></dl>

</div>
</div><p>
<a class="anchor" name="09e12ac62841fcc2b0f7383aed9e1277"></a><!-- doxytag: member="Xapian::Utf8Iterator::operator!=" ref="09e12ac62841fcc2b0f7383aed9e1277" args="(const Utf8Iterator &amp;other) const" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Xapian::Utf8Iterator::operator!=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classXapian_1_1Utf8Iterator.html">Utf8Iterator</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>other</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Test two Utf8Iterators for inequality. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true iff the iterators do not point to the same position. </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="unicode_8h.html">unicode.h</a></ul>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>