<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="modules.htm"><span>Modules</span></a></li>
<li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Utf_3_0132_01_4.htm">Utf< 32 ></a>
</div>
</div>
<div class="contents">
<h1>sf::Utf< 32 > Class Template Reference</h1><!-- doxytag: class="sf::Utf< 32 >" -->
<p>Specialization of the <a class="el" href="classsf_1_1Utf.htm" title="Utility class providing generic functions for UTF conversions.">Utf</a> template for UTF-32.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Utf_8hpp_source.htm">Utf.hpp</a>></code></p>
<p><a href="classsf_1_1Utf_3_0132_01_4-members.htm">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static In </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a044d58c5501e517607c94ef40cdc6de1">Decode</a> (In begin, In end, Uint32 &output, Uint32 replacement=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a single UTF-32 character. <a href="#a044d58c5501e517607c94ef40cdc6de1"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#ac5efcddddb25eef7acc460eb22201377">Encode</a> (Uint32 input, Out output, Uint32 replacement=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a single UTF-32 character. <a href="#ac5efcddddb25eef7acc460eb22201377"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static In </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a3d37e87cc7bc9474e3ca65bde90e9e93">Next</a> (In begin, In end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance to the next UTF-32 character. <a href="#a3d37e87cc7bc9474e3ca65bde90e9e93"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static std::size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a9dc295f6c5dae84aa8c64228a6affbc4">Count</a> (In begin, In end)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the number of characters of a UTF-32 sequence. <a href="#a9dc295f6c5dae84aa8c64228a6affbc4"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#ae299c18d6fc91e8eea1ceab97de8e049">FromAnsi</a> (In begin, In end, Out output, const std::locale &locale=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an ANSI characters range to UTF-32. <a href="#ae299c18d6fc91e8eea1ceab97de8e049"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a734e146be821b44aba95f2d479390874">FromWide</a> (In begin, In end, Out output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a wide characters range to UTF-32. <a href="#a734e146be821b44aba95f2d479390874"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a0f7c6990fa974b24205e2b5fb4a7ce2a">FromLatin1</a> (In begin, In end, Out output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a latin-1 (ISO-5589-1) characters range to UTF-32. <a href="#a0f7c6990fa974b24205e2b5fb4a7ce2a"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a814bf82259c9ad60bd907103b15070f4">ToAnsi</a> (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an UTF-32 characters range to ANSI characters. <a href="#a814bf82259c9ad60bd907103b15070f4"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a63f51fc0e89e005c697c12128138a36a">ToWide</a> (In begin, In end, Out output, wchar_t replacement=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an UTF-32 characters range to wide characters. <a href="#a63f51fc0e89e005c697c12128138a36a"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#af244c4315abb1731bb4838e9f4758821">ToLatin1</a> (In begin, In end, Out output, char replacement=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters. <a href="#af244c4315abb1731bb4838e9f4758821"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#aa695211f157d22faf8006c768aaf9d66">ToUtf8</a> (In begin, In end, Out output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-32 characters range to UTF-8. <a href="#aa695211f157d22faf8006c768aaf9d66"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#aa09c852287c95c0a8c17113d72a050cf">ToUtf16</a> (In begin, In end, Out output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-32 characters range to UTF-16. <a href="#aa09c852287c95c0a8c17113d72a050cf"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In , typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#aa9a23a5e120267c885438280cf839fd1">ToUtf32</a> (In begin, In end, Out output)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a UTF-32 characters range to UTF-32. <a href="#aa9a23a5e120267c885438280cf839fd1"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Uint32 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a400e15a54d756475b68505e98fd15ad9">DecodeAnsi</a> (In input, const std::locale &locale=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a single ANSI character to UTF-32. <a href="#a400e15a54d756475b68505e98fd15ad9"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename In > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Uint32 </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a2546b0c7663b958fb2ae7900c5572d9b">DecodeWide</a> (In input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode a single wide character to UTF-32. <a href="#a2546b0c7663b958fb2ae7900c5572d9b"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a77ddcb6d803f84f7ea1d70554ee4d0b5">EncodeAnsi</a> (Uint32 codepoint, Out output, char replacement=0, const std::locale &locale=std::locale())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a single UTF-32 character to ANSI. <a href="#a77ddcb6d803f84f7ea1d70554ee4d0b5"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename Out > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">static Out </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf_3_0132_01_4.htm#a0a5967916430e20ed59bc8f81ed02223">EncodeWide</a> (Uint32 codepoint, Out output, wchar_t replacement=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a single UTF-32 character to wide. <a href="#a0a5967916430e20ed59bc8f81ed02223"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<><br/>
class sf::Utf< 32 ></h3>
<p>Specialization of the <a class="el" href="classsf_1_1Utf.htm" title="Utility class providing generic functions for UTF conversions.">Utf</a> template for UTF-32. </p>
<p>Definition at line <a class="el" href="Utf_8hpp_source.htm#l00464">464</a> of file <a class="el" href="Utf_8hpp_source.htm">Utf.hpp</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9dc295f6c5dae84aa8c64228a6affbc4"></a><!-- doxytag: member="sf::Utf< 32 >::Count" ref="a9dc295f6c5dae84aa8c64228a6affbc4" args="(In begin, In end)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In > </div>
<table class="memname">
<tr>
<td class="memname">static std::size_t <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::Count </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Count the number of characters of a UTF-32 sequence. </p>
<p>This function is trivial for UTF-32, which can store every character in a single storage element.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator pointing to one past the last read element of the input sequence </dd></dl>
</div>
</div>
<a class="anchor" id="a044d58c5501e517607c94ef40cdc6de1"></a><!-- doxytag: member="sf::Utf< 32 >::Decode" ref="a044d58c5501e517607c94ef40cdc6de1" args="(In begin, In end, Uint32 &output, Uint32 replacement=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In > </div>
<table class="memname">
<tr>
<td class="memname">static In <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::Decode </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 & </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>replacement</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a single UTF-32 character. </p>
<p>Decoding a character means finding its unique 32-bits code (called the codepoint) in the Unicode standard. For UTF-32, the character value is the same as the codepoint.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Codepoint of the decoded UTF-32 character </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement character to use in case the UTF-8 sequence is invalid</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator pointing to one past the last read element of the input sequence </dd></dl>
</div>
</div>
<a class="anchor" id="a400e15a54d756475b68505e98fd15ad9"></a><!-- doxytag: member="sf::Utf< 32 >::DecodeAnsi" ref="a400e15a54d756475b68505e98fd15ad9" args="(In input, const std::locale &locale=std::locale())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In > </div>
<table class="memname">
<tr>
<td class="memname">static Uint32 <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::DecodeAnsi </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"> <em>locale</em> = <code>std::locale()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a single ANSI character to UTF-32. </p>
<p>This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>Input ANSI character </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>Locale to use for conversion</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Converted character </dd></dl>
</div>
</div>
<a class="anchor" id="a2546b0c7663b958fb2ae7900c5572d9b"></a><!-- doxytag: member="sf::Utf< 32 >::DecodeWide" ref="a2546b0c7663b958fb2ae7900c5572d9b" args="(In input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In > </div>
<table class="memname">
<tr>
<td class="memname">static Uint32 <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::DecodeWide </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>input</em></td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decode a single wide character to UTF-32. </p>
<p>This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>Input wide character</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Converted character </dd></dl>
</div>
</div>
<a class="anchor" id="ac5efcddddb25eef7acc460eb22201377"></a><!-- doxytag: member="sf::Utf< 32 >::Encode" ref="ac5efcddddb25eef7acc460eb22201377" args="(Uint32 input, Out output, Uint32 replacement=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::Encode </td>
<td>(</td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>replacement</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a single UTF-32 character. </p>
<p>Encoding a character means converting a unique 32-bits code (called the codepoint) in the target encoding, UTF-32. For UTF-32, the codepoint is the same as the character value.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>Codepoint to encode as UTF-32 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement for characters not convertible to UTF-32 (use 0 to skip them)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a77ddcb6d803f84f7ea1d70554ee4d0b5"></a><!-- doxytag: member="sf::Utf< 32 >::EncodeAnsi" ref="a77ddcb6d803f84f7ea1d70554ee4d0b5" args="(Uint32 codepoint, Out output, char replacement=0, const std::locale &locale=std::locale())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::EncodeAnsi </td>
<td>(</td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>codepoint</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>replacement</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"> <em>locale</em> = <code>std::locale()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a single UTF-32 character to ANSI. </p>
<p>This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>codepoint</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement if the input character is not convertible to ANSI (use 0 to skip it) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>Locale to use for conversion</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a0a5967916430e20ed59bc8f81ed02223"></a><!-- doxytag: member="sf::Utf< 32 >::EncodeWide" ref="a0a5967916430e20ed59bc8f81ed02223" args="(Uint32 codepoint, Out output, wchar_t replacement=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::EncodeWide </td>
<td>(</td>
<td class="paramtype">Uint32 </td>
<td class="paramname"> <em>codepoint</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t </td>
<td class="paramname"> <em>replacement</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a single UTF-32 character to wide. </p>
<p>This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>codepoint</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement if the input character is not convertible to wide (use 0 to skip it)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="ae299c18d6fc91e8eea1ceab97de8e049"></a><!-- doxytag: member="sf::Utf< 32 >::FromAnsi" ref="ae299c18d6fc91e8eea1ceab97de8e049" args="(In begin, In end, Out output, const std::locale &locale=std::locale())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::FromAnsi </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"> <em>locale</em> = <code>std::locale()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert an ANSI characters range to UTF-32. </p>
<p>The current global locale will be used by default, unless you pass a custom one in the <em>locale</em> parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>Locale to use for conversion</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a0f7c6990fa974b24205e2b5fb4a7ce2a"></a><!-- doxytag: member="sf::Utf< 32 >::FromLatin1" ref="a0f7c6990fa974b24205e2b5fb4a7ce2a" args="(In begin, In end, Out output)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::FromLatin1 </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a latin-1 (ISO-5589-1) characters range to UTF-32. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>Locale to use for conversion</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a734e146be821b44aba95f2d479390874"></a><!-- doxytag: member="sf::Utf< 32 >::FromWide" ref="a734e146be821b44aba95f2d479390874" args="(In begin, In end, Out output)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::FromWide </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a wide characters range to UTF-32. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a3d37e87cc7bc9474e3ca65bde90e9e93"></a><!-- doxytag: member="sf::Utf< 32 >::Next" ref="a3d37e87cc7bc9474e3ca65bde90e9e93" args="(In begin, In end)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In > </div>
<table class="memname">
<tr>
<td class="memname">static In <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::Next </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Advance to the next UTF-32 character. </p>
<p>This function is trivial for UTF-32, which can store every character in a single storage element.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator pointing to one past the last read element of the input sequence </dd></dl>
</div>
</div>
<a class="anchor" id="a814bf82259c9ad60bd907103b15070f4"></a><!-- doxytag: member="sf::Utf< 32 >::ToAnsi" ref="a814bf82259c9ad60bd907103b15070f4" args="(In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale())" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToAnsi </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>replacement</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::locale & </td>
<td class="paramname"> <em>locale</em> = <code>std::locale()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert an UTF-32 characters range to ANSI characters. </p>
<p>The current global locale will be used by default, unless you pass a custom one in the <em>locale</em> parameter.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement for characters not convertible to ANSI (use 0 to skip them) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>Locale to use for conversion</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="af244c4315abb1731bb4838e9f4758821"></a><!-- doxytag: member="sf::Utf< 32 >::ToLatin1" ref="af244c4315abb1731bb4838e9f4758821" args="(In begin, In end, Out output, char replacement=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToLatin1 </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>replacement</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement for characters not convertible to wide (use 0 to skip them)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="aa09c852287c95c0a8c17113d72a050cf"></a><!-- doxytag: member="sf::Utf< 32 >::ToUtf16" ref="aa09c852287c95c0a8c17113d72a050cf" args="(In begin, In end, Out output)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToUtf16 </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a UTF-32 characters range to UTF-16. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="aa9a23a5e120267c885438280cf839fd1"></a><!-- doxytag: member="sf::Utf< 32 >::ToUtf32" ref="aa9a23a5e120267c885438280cf839fd1" args="(In begin, In end, Out output)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToUtf32 </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a UTF-32 characters range to UTF-32. </p>
<p>This functions does nothing more than a direct copy; it is defined only to provide the same interface as other specializations of the sf::Utf<> template, and allow generic code to be written on top of it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="aa695211f157d22faf8006c768aaf9d66"></a><!-- doxytag: member="sf::Utf< 32 >::ToUtf8" ref="aa695211f157d22faf8006c768aaf9d66" args="(In begin, In end, Out output)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToUtf8 </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a UTF-32 characters range to UTF-8. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<a class="anchor" id="a63f51fc0e89e005c697c12128138a36a"></a><!-- doxytag: member="sf::Utf< 32 >::ToWide" ref="a63f51fc0e89e005c697c12128138a36a" args="(In begin, In end, Out output, wchar_t replacement=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename In , typename Out > </div>
<table class="memname">
<tr>
<td class="memname">static Out <a class="el" href="classsf_1_1Utf.htm">sf::Utf</a>< 32 >::ToWide </td>
<td>(</td>
<td class="paramtype">In </td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">In </td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Out </td>
<td class="paramname"> <em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">wchar_t </td>
<td class="paramname"> <em>replacement</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert an UTF-32 characters range to wide characters. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>begin</em> </td><td>Iterator pointing to the beginning of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>Iterator pointing to the end of the input sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>Iterator pointing to the beginning of the output sequence </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replacement</em> </td><td>Replacement for characters not convertible to wide (use 0 to skip them)</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Iterator to the end of the output sequence which has been written </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Utf_8hpp_source.htm">Utf.hpp</a></li>
</ul>
</div>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
distrib
>
Mandriva
>
2010.2
>
i586
>
media
>
contrib-backports
>
by-pkgid
>
f00c83953c7eb23ee3c18f4f35d8eb6b
>
files
>
299
