libs/locale/doc/html/classboost_1_1locale_1_1converter.html

   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 <title>Boost.Locale: boost::locale::converter&lt; Char &gt; Class Template Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 <link rel="stylesheet" type="text/css" href="../style/section-basic.css">
   9 </head>
  10 <body>
  11 <div id="boost-common-heading-doc">
  12     <div class="heading-inner">
  13         <div class="heading-placard"></div>
  14
  15         <h1 class="heading-title">
  16             <a href="http://www.boost.org/">
  17                 <img src="../style/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
  18                 <span class="heading-boost">Boost</span>
  19                 <span class="heading-cpplibraries">C++ Libraries</span>
  20             </a>
  21         </h1>
  22
  23         <p class="heading-quote">
  24
  25             <q>...one of the most highly
  26             regarded and expertly designed C++ library projects in the
  27             world.</q>
  28
  29             <span class="heading-attribution">&mdash; <a href=
  30             "http://www.gotw.ca/" class="external">Herb Sutter</a> and <a href=
  31             "http://en.wikipedia.org/wiki/Andrei_Alexandrescu" class="external">Andrei
  32             Alexandrescu</a>, <a href=
  33             "http://safari.awprofessional.com/?XmlId=0321113586" class="external">C++
  34             Coding Standards</a></span>
  35         </p>
  36     </div>
  37 </div>
  38
  39 <div id="boost-common-heading-doc-spacer"></div>
  40 <!-- Generated by Doxygen 1.7.1 -->
  41 <div class="navigation" id="top">
  42   <div class="tabs">
  43     <ul class="tablist">
  44       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  45       <li><a href="modules.html"><span>Modules</span></a></li>
  46       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  47       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  48       <li><a href="files.html"><span>Files</span></a></li>
  49       <li><a href="examples.html"><span>Examples</span></a></li>
  50     </ul>
  51   </div>
  52   <div class="tabs2">
  53     <ul class="tablist">
  54       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  55       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  56       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  57     </ul>
  58   </div>
  59   <div class="navpath">
  60     <ul>
  61       <li><b>boost</b>      </li>
  62       <li><a class="el" href="namespaceboost_1_1locale.html">locale</a>      </li>
  63       <li><a class="el" href="classboost_1_1locale_1_1converter.html">boost::locale::converter&lt; Char &gt;</a>      </li>
  64     </ul>
  65   </div>
  66 </div>
  67 <div class="header">
  68   <div class="summary">
  69 <a href="#pub-methods">Public Member Functions</a> &#124;
  70 <a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  71   <div class="headertitle">
  72 <h1>boost::locale::converter&lt; Char &gt; Class Template Reference<br/>
  73 <small>
  74 [<a class="el" href="group__convert.html">Text Conversions</a>]</small>
  75 </h1>  </div>
  76 </div>
  77 <div class="contents">
  78 <!-- doxytag: class="boost::locale::converter" --><!-- doxytag: inherits="boost::locale::converter_base" -->
  79 <p>The facet that implements text manipulation.
  80 <a href="#_details">More...</a></p>
  81
  82 <p><code>#include &lt;<a class="el" href="conversion_8hpp_source.html">boost/locale/conversion.hpp</a>&gt;</code></p>
  83 <div class="dynheader">
  84 Inheritance diagram for boost::locale::converter&lt; Char &gt;:</div>
  85 <div class="dyncontent">
  86  <div class="center">
  87   <img src="classboost_1_1locale_1_1converter.png" usemap="#boost::locale::converter&lt; Char &gt;_map" alt=""/>
  88   <map id="boost::locale::converter&lt; Char &gt;_map" name="boost::locale::converter&lt; Char &gt;_map">
  89 <area href="classboost_1_1locale_1_1converter__base.html" alt="boost::locale::converter_base" shape="rect" coords="0,0,195,24"/>
  90 </map>
  91 </div>
  92
  93 <p><a href="classboost_1_1locale_1_1converter-members.html">List of all members.</a></p>
  94 <table class="memberdecls">
  95 <tr><td colspan="2"><h2><a name="pub-methods"></a>
  96 Public Member Functions</h2></td></tr>
  97 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba25fd4a18937543823cd61bef72c628"></a><!-- doxytag: member="boost::locale::converter::converter" ref="aba25fd4a18937543823cd61bef72c628" args="(size_t refs=0)" -->
  98 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#aba25fd4a18937543823cd61bef72c628">converter</a> (size_t refs=0)</td></tr>
  99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor. <br/></td></tr>
 100 <tr><td class="memItemLeft" align="right" valign="top">virtual std::basic_string&lt; Char &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#a38dcc87504308ad5a51f3190e3c0da4b">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><td colspan="2"><h2><a name="pub-static-attribs"></a>
 102 Static Public Attributes</h2></td></tr>
 103 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ab17b265161bb2c5d7a233710d2740b"></a><!-- doxytag: member="boost::locale::converter::id" ref="a0ab17b265161bb2c5d7a233710d2740b" args="" -->
 104 static std::locale::id&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1converter.html#a0ab17b265161bb2c5d7a233710d2740b">id</a></td></tr>
 105 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Locale identification. <br/></td></tr>
 106 </table>
 107 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 108 <h3>template&lt;typename Char&gt;<br/>
 109  class boost::locale::converter&lt; Char &gt;</h3>
 110
 111 <p>The facet that implements text manipulation. </p>
 112 <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>
 113 <hr/><h2>Member Function Documentation</h2>
 114 <a class="anchor" id="a38dcc87504308ad5a51f3190e3c0da4b"></a><!-- doxytag: member="boost::locale::converter::convert" ref="a38dcc87504308ad5a51f3190e3c0da4b" args="(conversion_type how, Char const *begin, Char const *end, int flags=0) const =0" -->
 115 <div class="memitem">
 116 <div class="memproto">
 117 <div class="memtemplate">
 118 template&lt;typename Char &gt; </div>
 119       <table class="memname">
 120         <tr>
 121           <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; Char &gt;::convert </td>
 122           <td>(</td>
 123           <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1converter__base.html#a726bc2bbcbb6f1e550cca14163fb669b">conversion_type</a>&nbsp;</td>
 124           <td class="paramname"> <em>how</em>, </td>
 125         </tr>
 126         <tr>
 127           <td class="paramkey"></td>
 128           <td></td>
 129           <td class="paramtype">Char const *&nbsp;</td>
 130           <td class="paramname"> <em>begin</em>, </td>
 131         </tr>
 132         <tr>
 133           <td class="paramkey"></td>
 134           <td></td>
 135           <td class="paramtype">Char const *&nbsp;</td>
 136           <td class="paramname"> <em>end</em>, </td>
 137         </tr>
 138         <tr>
 139           <td class="paramkey"></td>
 140           <td></td>
 141           <td class="paramtype">int&nbsp;</td>
 142           <td class="paramname"> <em>flags</em> = <code>0</code></td><td>&nbsp;</td>
 143         </tr>
 144         <tr>
 145           <td></td>
 146           <td>)</td>
 147           <td></td><td></td><td> const<code> [pure virtual]</code></td>
 148         </tr>
 149       </table>
 150 </div>
 151 <div class="memdoc">
 152 <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>
 153
 154 </div>
 155 </div>
 156 <hr/>The documentation for this class was generated from the following file:<ul>
 157 <li>boost/locale/<a class="el" href="conversion_8hpp_source.html">conversion.hpp</a></li>
 158 </ul>
 159 </div>
 160 <hr class="footer"/><address class="footer"><small>
 161 &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.
 162 </small></address>
 163 </body>
 164 </html>