2
0
mirror of https://github.com/boostorg/locale.git synced 2026-02-26 04:42:21 +00:00
Files
locale/doc/html/group__codepage.html
Artyom Beilis 48ff4519b8 - Updates according to library requirements
- cleanup of inspect warnings
  - various requiremets like libraries.htm and maintainers.txt


[SVN r73786]
2011-08-15 19:04:34 +00:00

215 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Boost.Locale: Codepage</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link rel="stylesheet" type="text/css" href="../style/section-basic.css">
</head>
<body>
<div id="boost-common-heading-doc">
<div class="heading-inner">
<div class="heading-placard"></div>
<h1 class="heading-title">
<a href="http://www.boost.org/">
<img src="../style/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
<span class="heading-boost">Boost</span>
<span class="heading-cpplibraries">C++ Libraries</span>
</a>
</h1>
<p class="heading-quote">
<q>...one of the most highly
regarded and expertly designed C++ library projects in the
world.</q>
<span class="heading-attribution">&mdash; <a href=
"http://www.gotw.ca/" class="external">Herb Sutter</a> and <a href=
"http://en.wikipedia.org/wiki/Andrei_Alexandrescu" class="external">Andrei
Alexandrescu</a>, <a href=
"http://safari.awprofessional.com/?XmlId=0321113586" class="external">C++
Coding Standards</a></span>
</p>
</div>
</div>
<div id="boost-common-heading-doc-spacer"></div>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.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><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Codepage</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1conv_1_1conversion__error.html">boost::locale::conv::conversion_error</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The excepton that is thrown in case of conversion error. <a href="classboost_1_1locale_1_1conv_1_1conversion__error.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1conv_1_1invalid__charset__error.html">boost::locale::conv::invalid_charset_error</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This exception is thrown in case of use of unsupported or invalid character set. <a href="classboost_1_1locale_1_1conv_1_1invalid__charset__error.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">boost::locale::conv::method_type</a> { <a class="el" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84ae9b554a2955deddf714757788819edf9">boost::locale::conv::skip</a> = 0,
<a class="el" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383">boost::locale::conv::stop</a> = 1,
<a class="el" href="group__codepage.html#gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559">boost::locale::conv::default_method</a> = skip
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename CharOut , typename CharIn &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::basic_string&lt; CharOut &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__codepage.html#ga2de4d9d38004e5d7146abf2bd6a3df0b">boost::locale::conv::utf_to_utf</a> (CharIn const *begin, CharIn const *end, method_type how=default_method)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename CharOut , typename CharIn &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::basic_string&lt; CharOut &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__codepage.html#gae36d1fa29f675c4f13164afd8e0fabde">boost::locale::conv::utf_to_utf</a> (CharIn const *str, method_type how=default_method)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename CharOut , typename CharIn &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">std::basic_string&lt; CharOut &gt;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__codepage.html#ga2aa7d34682ff4e66b297ab5d75e1de51">boost::locale::conv::utf_to_utf</a> (std::basic_string&lt; CharIn &gt; const &amp;str, method_type how=default_method)</td></tr>
</table>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga8e3c5a274f57107ec5745e227c26ba84"></a><!-- doxytag: member="boost::locale::conv::method_type" ref="ga8e3c5a274f57107ec5745e227c26ba84" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__codepage.html#ga8e3c5a274f57107ec5745e227c26ba84">boost::locale::conv::method_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>enum that defines conversion policy </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga8e3c5a274f57107ec5745e227c26ba84ae9b554a2955deddf714757788819edf9"></a><!-- doxytag: member="skip" ref="gga8e3c5a274f57107ec5745e227c26ba84ae9b554a2955deddf714757788819edf9" args="" -->skip</em>&nbsp;</td><td>
<p>Skip illegal/unconvertable characters. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383"></a><!-- doxytag: member="stop" ref="gga8e3c5a274f57107ec5745e227c26ba84aab08f9ee241c405ef40bd3cedb43b383" args="" -->stop</em>&nbsp;</td><td>
<p>Stop conversion and throw <a class="el" href="classboost_1_1locale_1_1conv_1_1conversion__error.html" title="The excepton that is thrown in case of conversion error.">conversion_error</a>. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559"></a><!-- doxytag: member="default_method" ref="gga8e3c5a274f57107ec5745e227c26ba84adcdc34a57dd2a3ca917f73c13f18b559" args="" -->default_method</em>&nbsp;</td><td>
<p>Default method - skip. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga2de4d9d38004e5d7146abf2bd6a3df0b"></a><!-- doxytag: member="boost::locale::conv::utf_to_utf" ref="ga2de4d9d38004e5d7146abf2bd6a3df0b" args="(CharIn const *begin, CharIn const *end, method_type how=default_method)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharOut , typename CharIn &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_string&lt;CharOut&gt; boost::locale::conv::utf_to_utf </td>
<td>(</td>
<td class="paramtype">CharIn const *&nbsp;</td>
<td class="paramname"> <em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">CharIn const *&nbsp;</td>
<td class="paramname"> <em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">method_type&nbsp;</td>
<td class="paramname"> <em>how</em> = <code>default_method</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a Unicode text in range [begin,end) to other Unicode encoding </p>
</div>
</div>
<a class="anchor" id="ga2aa7d34682ff4e66b297ab5d75e1de51"></a><!-- doxytag: member="boost::locale::conv::utf_to_utf" ref="ga2aa7d34682ff4e66b297ab5d75e1de51" args="(std::basic_string&lt; CharIn &gt; const &amp;str, method_type how=default_method)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharOut , typename CharIn &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_string&lt;CharOut&gt; boost::locale::conv::utf_to_utf </td>
<td>(</td>
<td class="paramtype">std::basic_string&lt; CharIn &gt; const &amp;&nbsp;</td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">method_type&nbsp;</td>
<td class="paramname"> <em>how</em> = <code>default_method</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a Unicode string <em>str</em> other Unicode encoding </p>
</div>
</div>
<a class="anchor" id="gae36d1fa29f675c4f13164afd8e0fabde"></a><!-- doxytag: member="boost::locale::conv::utf_to_utf" ref="gae36d1fa29f675c4f13164afd8e0fabde" args="(CharIn const *str, method_type how=default_method)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharOut , typename CharIn &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::basic_string&lt;CharOut&gt; boost::locale::conv::utf_to_utf </td>
<td>(</td>
<td class="paramtype">CharIn const *&nbsp;</td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">method_type&nbsp;</td>
<td class="paramname"> <em>how</em> = <code>default_method</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a Unicode NUL terminated string <em>str</em> other Unicode encoding </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
&copy; Copyright 2009-2011 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
</small></address>
</body>
</html>