1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.6"/> 7<title>Boost.Locale: boost::locale::converter< CharType > Class Template Reference</title> 8<link href="tabs.css" rel="stylesheet" type="text/css"/> 9<script type="text/javascript" src="jquery.js"></script> 10<script type="text/javascript" src="dynsections.js"></script> 11<link href="navtree.css" rel="stylesheet" type="text/css"/> 12<script type="text/javascript" src="resize.js"></script> 13<script type="text/javascript" src="navtree.js"></script> 14<script type="text/javascript"> 15 $(document).ready(initResizable); 16 $(window).load(resizeHeight); 17</script> 18<link href="doxygen.css" rel="stylesheet" type="text/css" /> 19</head> 20<body> 21<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 22<div id="titlearea"> 23<table cellspacing="0" cellpadding="0"> 24 <tbody> 25 <tr style="height: 56px;"> 26 <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td> 27 <td style="padding-left: 0.5em;"> 28 <div id="projectname">Boost.Locale 29 </div> 30 </td> 31 </tr> 32 </tbody> 33</table> 34</div> 35<!-- end header part --> 36<!-- Generated by Doxygen 1.8.6 --> 37 <div id="navrow1" class="tabs"> 38 <ul class="tablist"> 39 <li><a href="index.html"><span>Main Page</span></a></li> 40 <li><a href="pages.html"><span>Related Pages</span></a></li> 41 <li><a href="modules.html"><span>Modules</span></a></li> 42 <li><a href="namespaces.html"><span>Namespaces</span></a></li> 43 <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 44 <li><a href="files.html"><span>Files</span></a></li> 45 <li><a href="examples.html"><span>Examples</span></a></li> 46 </ul> 47 </div> 48 <div id="navrow2" class="tabs2"> 49 <ul class="tablist"> 50 <li><a href="annotated.html"><span>Class List</span></a></li> 51 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> 52 <li><a href="functions.html"><span>Class Members</span></a></li> 53 </ul> 54 </div> 55</div><!-- top --> 56<div id="side-nav" class="ui-resizable side-nav-resizable"> 57 <div id="nav-tree"> 58 <div id="nav-tree-contents"> 59 <div id="nav-sync" class="sync"></div> 60 </div> 61 </div> 62 <div id="splitbar" style="-moz-user-select:none;" 63 class="ui-resizable-handle"> 64 </div> 65</div> 66<script type="text/javascript"> 67$(document).ready(function(){initNavTree('classboost_1_1locale_1_1converter.html','');}); 68</script> 69<div id="doc-content"> 70<div class="header"> 71 <div class="summary"> 72<a href="#pub-methods">Public Member Functions</a> | 73<a href="#pub-static-attribs">Static Public Attributes</a> | 74<a href="classboost_1_1locale_1_1converter-members.html">List of all members</a> </div> 75 <div class="headertitle"> 76<div class="title">boost::locale::converter< CharType > 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> 77</div><!--header--> 78<div class="contents"> 79 80<p>The facet that implements text manipulation. 81 <a href="classboost_1_1locale_1_1converter.html#details">More...</a></p> 82 83<p><code>#include <<a class="el" href="conversion_8hpp_source.html">boost/locale/conversion.hpp</a>></code></p> 84<div class="dynheader"> 85Inheritance diagram for boost::locale::converter< CharType >:</div> 86<div class="dyncontent"> 87 <div class="center"> 88 <img src="classboost_1_1locale_1_1converter.png" usemap="#boost::locale::converter< CharType >_map" alt=""/> 89 <map id="boost::locale::converter< CharType >_map" name="boost::locale::converter< CharType >_map"> 90<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"/> 91</map> 92 </div></div> 93<table class="memberdecls"> 94<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 95Public Member Functions</h2></td></tr> 96<tr class="memitem:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bd91f48f4ce7b6c270c5281c8b0313"></a> 97 </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> 98<tr class="memdesc:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="mdescLeft"> </td><td class="mdescRight">Standard constructor. <br/></td></tr> 99<tr class="separator:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memSeparator" colspan="2"> </td></tr> 100<tr class="memitem:a85ce9bf935c59b2fdd196ed40a6a5f85"><td class="memItemLeft" align="right" valign="top">virtual std::basic_string< Char > </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> 101<tr class="separator:a85ce9bf935c59b2fdd196ed40a6a5f85"><td class="memSeparator" colspan="2"> </td></tr> 102</table><table class="memberdecls"> 103<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> 104Static Public Attributes</h2></td></tr> 105<tr class="memitem:ae18f930e621fbe9848d08a91138f37e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae18f930e621fbe9848d08a91138f37e1"></a> 106static std::locale::id </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#ae18f930e621fbe9848d08a91138f37e1">id</a></td></tr> 107<tr class="memdesc:ae18f930e621fbe9848d08a91138f37e1"><td class="mdescLeft"> </td><td class="mdescRight">Locale identification. <br/></td></tr> 108<tr class="separator:ae18f930e621fbe9848d08a91138f37e1"><td class="memSeparator" colspan="2"> </td></tr> 109</table><table class="memberdecls"> 110<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> 111Additional Inherited Members</h2></td></tr> 112<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="-"/> Public Types inherited from <a class="el" href="classboost_1_1locale_1_1converter__base.html">boost::locale::converter_base</a></td></tr> 113<tr class="memitem:a726bc2bbcbb6f1e550cca14163fb669b inherit pub_types_classboost_1_1locale_1_1converter__base"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a> { <br/> 114  <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bae20bf7eface68062a0b9f2396833354a">normalization</a>, 115<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba0fee54e09732910ab30856d0e34c8ad2">upper_case</a>, 116<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba2c5c38c6bc6ca01fb9e573c148ba8ebe">lower_case</a>, 117<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba91936aed5b7c3a82b4d2c2354ead03d3">case_folding</a>, 118<br/> 119  <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bac136b257286085de7bd7eb4a7876dfa7">title_case</a> 120<br/> 121 }</td></tr> 122<tr class="separator:a726bc2bbcbb6f1e550cca14163fb669b inherit pub_types_classboost_1_1locale_1_1converter__base"><td class="memSeparator" colspan="2"> </td></tr> 123</table> 124<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 125<div class="textblock"><h3>template<typename CharType><br/> 126class boost::locale::converter< CharType ></h3> 127 128<p>The facet that implements text manipulation. </p> 129<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> 130</div><h2 class="groupheader">Member Function Documentation</h2> 131<a class="anchor" id="a85ce9bf935c59b2fdd196ed40a6a5f85"></a> 132<div class="memitem"> 133<div class="memproto"> 134<div class="memtemplate"> 135template<typename CharType > </div> 136<table class="mlabels"> 137 <tr> 138 <td class="mlabels-left"> 139 <table class="memname"> 140 <tr> 141 <td class="memname">virtual std::basic_string<Char> <a class="el" href="classboost_1_1locale_1_1converter.html">boost::locale::converter</a>< CharType >::convert </td> 142 <td>(</td> 143 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a> </td> 144 <td class="paramname"><em>how</em>, </td> 145 </tr> 146 <tr> 147 <td class="paramkey"></td> 148 <td></td> 149 <td class="paramtype">Char const * </td> 150 <td class="paramname"><em>begin</em>, </td> 151 </tr> 152 <tr> 153 <td class="paramkey"></td> 154 <td></td> 155 <td class="paramtype">Char const * </td> 156 <td class="paramname"><em>end</em>, </td> 157 </tr> 158 <tr> 159 <td class="paramkey"></td> 160 <td></td> 161 <td class="paramtype">int </td> 162 <td class="paramname"><em>flags</em> = <code>0</code> </td> 163 </tr> 164 <tr> 165 <td></td> 166 <td>)</td> 167 <td></td><td> const</td> 168 </tr> 169 </table> 170 </td> 171 <td class="mlabels-right"> 172<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> 173 </tr> 174</table> 175</div><div class="memdoc"> 176<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> 177 178</div> 179</div> 180<hr/>The documentation for this class was generated from the following file:<ul> 181<li>boost/locale/<a class="el" href="conversion_8hpp_source.html">conversion.hpp</a></li> 182</ul> 183</div><!-- contents --> 184</div><!-- doc-content --> 185 186 <li class="footer"> 187© 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. 188 </li> 189 </ul> 190 </div> 191</body> 192</html> 193