classboost_1_1locale_1_1converter.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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&lt; CharType &gt; 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&#160;Page</span></a></li>
  40. <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
  51. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  52. <li><a href="functions.html"><span>Class&#160;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> &#124;
  73. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  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&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>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>The facet that implements text manipulation.
  80. <a href="classboost_1_1locale_1_1converter.html#details">More...</a></p>
  81. <p><code>#include &lt;<a class="el" href="conversion_8hpp_source.html">boost/locale/conversion.hpp</a>&gt;</code></p>
  82. <div class="dynheader">
  83. Inheritance diagram for boost::locale::converter&lt; CharType &gt;:</div>
  84. <div class="dyncontent">
  85. <div class="center">
  86. <img src="classboost_1_1locale_1_1converter.png" usemap="#boost::locale::converter&lt; CharType &gt;_map" alt=""/>
  87. <map id="boost::locale::converter&lt; CharType &gt;_map" name="boost::locale::converter&lt; CharType &gt;_map">
  88. <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"/>
  89. </map>
  90. </div></div>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  93. Public Member Functions</h2></td></tr>
  94. <tr class="memitem:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bd91f48f4ce7b6c270c5281c8b0313"></a>
  95. &#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>
  96. <tr class="memdesc:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard constructor. <br/></td></tr>
  97. <tr class="separator:aa9bd91f48f4ce7b6c270c5281c8b0313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <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>
  99. <tr class="separator:a85ce9bf935c59b2fdd196ed40a6a5f85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  102. Static Public Attributes</h2></td></tr>
  103. <tr class="memitem:ae18f930e621fbe9848d08a91138f37e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae18f930e621fbe9848d08a91138f37e1"></a>
  104. 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>
  105. <tr class="memdesc:ae18f930e621fbe9848d08a91138f37e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locale identification. <br/></td></tr>
  106. <tr class="separator:ae18f930e621fbe9848d08a91138f37e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  109. Additional Inherited Members</h2></td></tr>
  110. <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>
  111. <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/>
  112. &#160;&#160;<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bae20bf7eface68062a0b9f2396833354a">normalization</a>,
  113. <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba0fee54e09732910ab30856d0e34c8ad2">upper_case</a>,
  114. <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba2c5c38c6bc6ca01fb9e573c148ba8ebe">lower_case</a>,
  115. <a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669ba91936aed5b7c3a82b4d2c2354ead03d3">case_folding</a>,
  116. <br/>
  117. &#160;&#160;<a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669bac136b257286085de7bd7eb4a7876dfa7">title_case</a>
  118. <br/>
  119. }</td></tr>
  120. <tr class="separator:a726bc2bbcbb6f1e550cca14163fb669b inherit pub_types_classboost_1_1locale_1_1converter__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><h3>template&lt;typename CharType&gt;<br/>
  124. class boost::locale::converter&lt; CharType &gt;</h3>
  125. <p>The facet that implements text manipulation. </p>
  126. <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>
  127. </div><h2 class="groupheader">Member Function Documentation</h2>
  128. <a class="anchor" id="a85ce9bf935c59b2fdd196ed40a6a5f85"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <div class="memtemplate">
  132. template&lt;typename CharType &gt; </div>
  133. <table class="mlabels">
  134. <tr>
  135. <td class="mlabels-left">
  136. <table class="memname">
  137. <tr>
  138. <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>
  139. <td>(</td>
  140. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a>&#160;</td>
  141. <td class="paramname"><em>how</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">Char const *&#160;</td>
  147. <td class="paramname"><em>begin</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">Char const *&#160;</td>
  153. <td class="paramname"><em>end</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">int&#160;</td>
  159. <td class="paramname"><em>flags</em> = <code>0</code>&#160;</td>
  160. </tr>
  161. <tr>
  162. <td></td>
  163. <td>)</td>
  164. <td></td><td> const</td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <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>
  174. </div>
  175. </div>
  176. <hr/>The documentation for this class was generated from the following file:<ul>
  177. <li>boost/locale/<a class="el" href="conversion_8hpp_source.html">conversion.hpp</a></li>
  178. </ul>
  179. </div><!-- contents -->
  180. </div><!-- doc-content -->
  181. <li class="footer">
  182. &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.
  183. </li>
  184. </ul>
  185. </div>
  186. </body>
  187. </html>