Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 511

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csFmtDefaultReader&lt; T &gt; Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</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>
<h1>csFmtDefaultReader&lt; T &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="csFmtDefaultReader" -->Standard format string source for <a class="el" href="classcsPrintfFormatter.html" title="Templated class for printf()-style string formatting.">csPrintfFormatter</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="formatter_8h-source.html">csutil/formatter.h</a>&gt;</code>
<p>

<p>
<a href="classcsFmtDefaultReader-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFmtDefaultReader.html#c98099f222a46b5c36e67668db02e497">csFmtDefaultReader</a> (const T *string, size_t length)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Init with a string and a length.  <a href="#c98099f222a46b5c36e67668db02e497"></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="classcsFmtDefaultReader.html#1ecd0e98f3e002eeccea014ae60bdef7">GetNext</a> (<a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> &amp;ch)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get next character. Returns false if end of input was reached.  <a href="#1ecd0e98f3e002eeccea014ae60bdef7"></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="classcsFmtDefaultReader.html#dcc493f01d548798fc319e7f51d59d99">GetPosition</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get position relative to beginning.  <a href="#dcc493f01d548798fc319e7f51d59d99"></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="classcsFmtDefaultReader.html#739f3785aebfad81867b12d377b15d38">Reset</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rewind.  <a href="#739f3785aebfad81867b12d377b15d38"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br>
 class csFmtDefaultReader&lt; T &gt;</h3>

Standard format string source for <a class="el" href="classcsPrintfFormatter.html" title="Templated class for printf()-style string formatting.">csPrintfFormatter</a>. 
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Uses <a class="el" href="classcsUnicodeTransform.html#24c171b2e92da381499801aba4422106" title="Decode an Unicode code point encoded in UTF-8.">csUnicodeTransform::Decode()</a>, so it supports utf8_char, utf16_char, utf32_char and wchar_t strings. </dd></dl>

<p>Definition at line <a class="el" href="formatter_8h-source.html#l00072">72</a> of file <a class="el" href="formatter_8h-source.html">formatter.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c98099f222a46b5c36e67668db02e497"></a><!-- doxytag: member="csFmtDefaultReader::csFmtDefaultReader" ref="c98099f222a46b5c36e67668db02e497" args="(const T *string, size_t length)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsFmtDefaultReader.html">csFmtDefaultReader</a>&lt; T &gt;::<a class="el" href="classcsFmtDefaultReader.html">csFmtDefaultReader</a>           </td>
          <td>(</td>
          <td class="paramtype">const T *&nbsp;</td>
          <td class="paramname"> <em>string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>length</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>
Init with a string and a length. 
<p>

<p>Definition at line <a class="el" href="formatter_8h-source.html#l00080">80</a> of file <a class="el" href="formatter_8h-source.html">formatter.h</a>.</p>

<p>References <a class="el" href="formatter_8h-source.html#l00092">csFmtDefaultReader&lt; T &gt;::Reset()</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1ecd0e98f3e002eeccea014ae60bdef7"></a><!-- doxytag: member="csFmtDefaultReader::GetNext" ref="1ecd0e98f3e002eeccea014ae60bdef7" args="(utf32_char &amp;ch)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classcsFmtDefaultReader.html">csFmtDefaultReader</a>&lt; T &gt;::GetNext           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ch</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get next character. Returns false if end of input was reached. 
<p>

<p>Definition at line <a class="el" href="formatter_8h-source.html#l00083">83</a> of file <a class="el" href="formatter_8h-source.html">formatter.h</a>.</p>

<p>References <a class="el" href="csuctransform_8h-source.html#l00277">csUnicodeTransform::Decode()</a>.</p>

</div>
</div><p>
<a class="anchor" name="dcc493f01d548798fc319e7f51d59d99"></a><!-- doxytag: member="csFmtDefaultReader::GetPosition" ref="dcc493f01d548798fc319e7f51d59d99" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classcsFmtDefaultReader.html">csFmtDefaultReader</a>&lt; T &gt;::GetPosition           </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>
Get position relative to beginning. 
<p>

<p>Definition at line <a class="el" href="formatter_8h-source.html#l00094">94</a> of file <a class="el" href="formatter_8h-source.html">formatter.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="739f3785aebfad81867b12d377b15d38"></a><!-- doxytag: member="csFmtDefaultReader::Reset" ref="739f3785aebfad81867b12d377b15d38" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classcsFmtDefaultReader.html">csFmtDefaultReader</a>&lt; T &gt;::Reset           </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>
Rewind. 
<p>

<p>Definition at line <a class="el" href="formatter_8h-source.html#l00092">92</a> of file <a class="el" href="formatter_8h-source.html">formatter.h</a>.</p>

<p>Referenced by <a class="el" href="formatter_8h-source.html#l00080">csFmtDefaultReader&lt; T &gt;::csFmtDefaultReader()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="formatter_8h-source.html">formatter.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>