locale/doc/html/classboost_1_1locale_1_1converter.html
2015-10-18 17:31:48 +03:00

193 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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Boost.Locale: boost::locale::converter&lt; CharType &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Boost.Locale
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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="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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classboost_1_1locale_1_1converter.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classboost_1_1locale_1_1converter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">boost::locale::converter&lt; CharType &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__convert.html">Text Conversions</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The facet that implements text manipulation.
<a href="classboost_1_1locale_1_1converter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="conversion_8hpp_source.html">boost/locale/conversion.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for boost::locale::converter&lt; CharType &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classboost_1_1locale_1_1converter.png" usemap="#boost::locale::converter&lt; CharType &gt;_map" alt=""/>
<map id="boost::locale::converter&lt; CharType &gt;_map" name="boost::locale::converter&lt; CharType &gt;_map">
<area href="classboost_1_1locale_1_1converter__base.html" title="This class provides base flags for text manipulation. It is used as base for converter facet..." alt="boost::locale::converter_base" shape="rect" coords="0,0,223,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bd91f48f4ce7b6c270c5281c8b0313"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#aa9bd91f48f4ce7b6c270c5281c8b0313">converter</a> (size_t refs=0)</td></tr>
<tr class="memdesc:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <br/></td></tr>
<tr class="separator:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85ce9bf935c59b2fdd196ed40a6a5f85"><td class="memItemLeft" align="right" valign="top">virtual std::basic_string&lt; Char &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#a85ce9bf935c59b2fdd196ed40a6a5f85">convert</a> (<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a> how, Char const *begin, Char const *end, int flags=0) const =0</td></tr>
<tr class="separator:a85ce9bf935c59b2fdd196ed40a6a5f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ae18f930e621fbe9848d08a91138f37e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae18f930e621fbe9848d08a91138f37e1"></a>
static std::locale::id&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#ae18f930e621fbe9848d08a91138f37e1">id</a></td></tr>
<tr class="memdesc:ae18f930e621fbe9848d08a91138f37e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locale identification. <br/></td></tr>
<tr class="separator:ae18f930e621fbe9848d08a91138f37e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classboost_1_1locale_1_1converter__base"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classboost_1_1locale_1_1converter__base')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classboost_1_1locale_1_1converter__base.html">boost::locale::converter_base</a></td></tr>
<tr class="memitem:a726bc2bbcbb6f1e550cca14163fb669b inherit pub_types_classboost_1_1locale_1_1converter__base"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a> { <br/>
&#160;&#160;<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bae20bf7eface68062a0b9f2396833354a">normalization</a>,
<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba0fee54e09732910ab30856d0e34c8ad2">upper_case</a>,
<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba2c5c38c6bc6ca01fb9e573c148ba8ebe">lower_case</a>,
<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba91936aed5b7c3a82b4d2c2354ead03d3">case_folding</a>,
<br/>
&#160;&#160;<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bac136b257286085de7bd7eb4a7876dfa7">title_case</a>
<br/>
}</td></tr>
<tr class="separator:a726bc2bbcbb6f1e550cca14163fb669b inherit pub_types_classboost_1_1locale_1_1converter__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename CharType&gt;<br/>
class boost::locale::converter&lt; CharType &gt;</h3>
<p>The facet that implements text manipulation. </p>
<p>It is used to performs text conversion operations defined by <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a>. It is specialized for four types of characters <code>char</code>, <code>wchar_t</code>, <code>char16_t</code>, <code>char32_t</code> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a85ce9bf935c59b2fdd196ed40a6a5f85"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename CharType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::basic_string&lt;Char&gt; <a class="el" href="classboost_1_1locale_1_1converter.html">boost::locale::converter</a>&lt; CharType &gt;::convert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a>&#160;</td>
<td class="paramname"><em>how</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Char const *&#160;</td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Char const *&#160;</td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert text in range [<em>begin</em>, <em>end</em>) according to conversion method <em>how</em>. Parameter <em>flags</em> is used for specification of normalization method like nfd, nfc etc. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>boost/locale/<a class="el" href="conversion_8hpp_source.html">conversion.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">
&copy; Copyright 2009-2012 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
</li>
</ul>
</div>
</body>
</html>