libs/locale/doc/html/classboost_1_1locale_1_1generator.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::generator Class 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_1generator.html">boost::locale::generator</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>  </div>
  70   <div class="headertitle">
  71 <h1>boost::locale::generator Class Reference</h1>  </div>
  72 </div>
  73 <div class="contents">
  74 <!-- doxytag: class="boost::locale::generator" -->
  75 <p>the major class used for locale generation
  76 <a href="#_details">More...</a></p>
  77
  78 <p><code>#include &lt;<a class="el" href="generator_8hpp_source.html">boost/locale/generator.hpp</a>&gt;</code></p>
  79
  80 <p><a href="classboost_1_1locale_1_1generator-members.html">List of all members.</a></p>
  81 <table class="memberdecls">
  82 <tr><td colspan="2"><h2><a name="pub-methods"></a>
  83 Public Member Functions</h2></td></tr>
  84 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a25f1d8fbbab6558213991c99630e851c">generator</a> ()</td></tr>
  85 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a767403ea3f6259fd184a6e355caf62f2">generator</a> (<a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;)</td></tr>
  86 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ae3c095f074329954eb90bb80488c7f76">categories</a> (<a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a> cats)</td></tr>
  87 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ad0aa601769d49ea79f354d1e1255cd64">categories</a> () const </td></tr>
  88 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ad5e01c555aa43b438f688dbc29725ab8">characters</a> (<a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a> chars)</td></tr>
  89 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a78feb6e2caae5cc0b01a287cd48691cb">characters</a> () const </td></tr>
  90 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a15020562d16dbbe276325b0162d54565">add_messages_domain</a> (std::string const &amp;domain)</td></tr>
  91 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a4804bc5c4a9adb74cffcc2bdac87da1d">set_default_messages_domain</a> (std::string const &amp;domain)</td></tr>
  92 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ade4a0ae57dbe87dfc38aa945f063d3c4">clear_domains</a> ()</td></tr>
  93 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a12823bbdb209690bfb77caa6404fd91b">add_messages_path</a> (std::string const &amp;path)</td></tr>
  94 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ae6ef1ec096f219f4e6c092507e41fa35">clear_paths</a> ()</td></tr>
  95 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a7b4458ef36df82bc9e359735c55203e8">clear_cache</a> ()</td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ac2d152e2803cd96f4acc646943f2df51">locale_cache_enabled</a> (bool on)</td></tr>
  97 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#aacfcd26484a830723a8a9f9d2e91a0e6">locale_cache_enabled</a> () const </td></tr>
  98 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a9afb2b0791abbabd39c800e08d9c9717">use_ansi_encoding</a> () const </td></tr>
  99 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ad9b74721ce3c5e1c39c7e9a4564e1e7b">use_ansi_encoding</a> (bool enc)</td></tr>
 100 <tr><td class="memItemLeft" align="right" valign="top">std::locale&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a75ba62f2ae7daa5a2d6641e36e064ecb">generate</a> (std::string const &amp;id) const </td></tr>
 101 <tr><td class="memItemLeft" align="right" valign="top">std::locale&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#aa98d7869660a1eb9b658b2cd4db495b3">generate</a> (std::locale const &amp;base, std::string const &amp;id) const </td></tr>
 102 <tr><td class="memItemLeft" align="right" valign="top">std::locale&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#acd80b3f2371c77f4f7e7dfe69ec670ab">operator()</a> (std::string const &amp;id) const </td></tr>
 103 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#ac0bbbb4aca466e59e82b63bcbf2efc8b">set_option</a> (std::string const &amp;name, std::string const &amp;value)</td></tr>
 104 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1generator.html#a1804390c65562fa66327152e9dd04c60">clear_options</a> ()</td></tr>
 105 </table>
 106 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 107 <p>the major class used for locale generation </p>
 108 <p>This class is used for specification of all parameters required for locale generation and caching. This class const member functions are thread safe if locale class implementation is thread safe. </p>
 109 <dl><dt><b>Examples: </b></dt><dd>
 110 <p><a class="el" href="boundary_8cpp-example.html#_a0">boundary.cpp</a>, <a class="el" href="calendar_8cpp-example.html#_a0">calendar.cpp</a>, <a class="el" href="collate_8cpp-example.html#_a0">collate.cpp</a>, <a class="el" href="conversions_8cpp-example.html#_a0">conversions.cpp</a>, <a class="el" href="hello_8cpp-example.html#_a0">hello.cpp</a>, <a class="el" href="wboundary_8cpp-example.html#_a0">wboundary.cpp</a>, <a class="el" href="wconversions_8cpp-example.html#_a0">wconversions.cpp</a>, and <a class="el" href="whello_8cpp-example.html#_a0">whello.cpp</a>.</p>
 111 </dd>
 112 </dl><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 113 <a class="anchor" id="a25f1d8fbbab6558213991c99630e851c"></a><!-- doxytag: member="boost::locale::generator::generator" ref="a25f1d8fbbab6558213991c99630e851c" args="()" -->
 114 <div class="memitem">
 115 <div class="memproto">
 116       <table class="memname">
 117         <tr>
 118           <td class="memname">boost::locale::generator::generator </td>
 119           <td>(</td>
 120           <td class="paramname"></td>
 121           <td>&nbsp;)&nbsp;</td>
 122           <td></td>
 123         </tr>
 124       </table>
 125 </div>
 126 <div class="memdoc">
 127 <p>Create new generator using global <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html" title="Localization backend manager is a class that holds various backend and allows creation of their combi...">localization_backend_manager</a> </p>
 128
 129 </div>
 130 </div>
 131 <a class="anchor" id="a767403ea3f6259fd184a6e355caf62f2"></a><!-- doxytag: member="boost::locale::generator::generator" ref="a767403ea3f6259fd184a6e355caf62f2" args="(localization_backend_manager const &amp;)" -->
 132 <div class="memitem">
 133 <div class="memproto">
 134       <table class="memname">
 135         <tr>
 136           <td class="memname">boost::locale::generator::generator </td>
 137           <td>(</td>
 138           <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;&nbsp;</td>
 139           <td class="paramname"></td>
 140           <td>&nbsp;)&nbsp;</td>
 141           <td></td>
 142         </tr>
 143       </table>
 144 </div>
 145 <div class="memdoc">
 146 <p>Create new generator using specific <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html" title="Localization backend manager is a class that holds various backend and allows creation of their combi...">localization_backend_manager</a> </p>
 147
 148 </div>
 149 </div>
 150 <hr/><h2>Member Function Documentation</h2>
 151 <a class="anchor" id="a15020562d16dbbe276325b0162d54565"></a><!-- doxytag: member="boost::locale::generator::add_messages_domain" ref="a15020562d16dbbe276325b0162d54565" args="(std::string const &amp;domain)" -->
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">void boost::locale::generator::add_messages_domain </td>
 157           <td>(</td>
 158           <td class="paramtype">std::string const &amp;&nbsp;</td>
 159           <td class="paramname"> <em>domain</em></td>
 160           <td>&nbsp;)&nbsp;</td>
 161           <td></td>
 162         </tr>
 163       </table>
 164 </div>
 165 <div class="memdoc">
 166 <p>Add a new domain of messages that would be generated. It should be set in order to enable messages support.</p>
 167 <p>Messages domain has following format: "name" or "name/encoding" where name is the base name of the "mo" file where the catalog is stored without ".mo" extension. For example for file <code>/usr/share/locale/he/LC_MESSAGES/blog</code>.mo it would be <code>blog</code>.</p>
 168 <p>You can optionally specify the encoding of the keys in the sources by adding "/encoding_name" For example blog/cp1255.</p>
 169 <p>If not defined all keys are assumed to be UTF-8 encoded.</p>
 170 <dl class="note"><dt><b>Note:</b></dt><dd>When you select a domain for the program using dgettext or message API, you do not specify the encoding part. So for example if the provided domain name was "blog/windows-1255" then for translation you should use dgettext("blog","Hello") </dd></dl>
 171
 172 </div>
 173 </div>
 174 <a class="anchor" id="a12823bbdb209690bfb77caa6404fd91b"></a><!-- doxytag: member="boost::locale::generator::add_messages_path" ref="a12823bbdb209690bfb77caa6404fd91b" args="(std::string const &amp;path)" -->
 175 <div class="memitem">
 176 <div class="memproto">
 177       <table class="memname">
 178         <tr>
 179           <td class="memname">void boost::locale::generator::add_messages_path </td>
 180           <td>(</td>
 181           <td class="paramtype">std::string const &amp;&nbsp;</td>
 182           <td class="paramname"> <em>path</em></td>
 183           <td>&nbsp;)&nbsp;</td>
 184           <td></td>
 185         </tr>
 186       </table>
 187 </div>
 188 <div class="memdoc">
 189 <p>Add a search path where dictionaries are looked in.</p>
 190 <dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
 191 <ul>
 192 <li>Under the Windows platform the path is treated as a path in the locale's encoding so if you create locale "en_US.windows-1251" then path would be treated as cp1255, and if it is en_US.UTF-8 it is treated as UTF-8. File name is always opened with a wide file name as wide file names are the native file name on Windows.</li>
 193 </ul>
 194 <ul>
 195 <li>Under POSIX platforms all paths passed as-is regardless of encoding as narrow encodings are the native encodings for POSIX platforms. </li>
 196 </ul>
 197
 198 </div>
 199 </div>
 200 <a class="anchor" id="ae3c095f074329954eb90bb80488c7f76"></a><!-- doxytag: member="boost::locale::generator::categories" ref="ae3c095f074329954eb90bb80488c7f76" args="(locale_category_type cats)" -->
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">void boost::locale::generator::categories </td>
 206           <td>(</td>
 207           <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a>&nbsp;</td>
 208           <td class="paramname"> <em>cats</em></td>
 209           <td>&nbsp;)&nbsp;</td>
 210           <td></td>
 211         </tr>
 212       </table>
 213 </div>
 214 <div class="memdoc">
 215 <p>Set types of facets that should be generated, default all </p>
 216
 217 </div>
 218 </div>
 219 <a class="anchor" id="ad0aa601769d49ea79f354d1e1255cd64"></a><!-- doxytag: member="boost::locale::generator::categories" ref="ad0aa601769d49ea79f354d1e1255cd64" args="() const " -->
 220 <div class="memitem">
 221 <div class="memproto">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a> boost::locale::generator::categories </td>
 225           <td>(</td>
 226           <td class="paramname"></td>
 227           <td>&nbsp;)&nbsp;</td>
 228           <td> const</td>
 229         </tr>
 230       </table>
 231 </div>
 232 <div class="memdoc">
 233 <p>Get types of facets that should be generated, default all </p>
 234
 235 </div>
 236 </div>
 237 <a class="anchor" id="a78feb6e2caae5cc0b01a287cd48691cb"></a><!-- doxytag: member="boost::locale::generator::characters" ref="a78feb6e2caae5cc0b01a287cd48691cb" args="() const " -->
 238 <div class="memitem">
 239 <div class="memproto">
 240       <table class="memname">
 241         <tr>
 242           <td class="memname"><a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a> boost::locale::generator::characters </td>
 243           <td>(</td>
 244           <td class="paramname"></td>
 245           <td>&nbsp;)&nbsp;</td>
 246           <td> const</td>
 247         </tr>
 248       </table>
 249 </div>
 250 <div class="memdoc">
 251 <p>Get the characters type for which the facets should be generated, default all supported </p>
 252
 253 </div>
 254 </div>
 255 <a class="anchor" id="ad5e01c555aa43b438f688dbc29725ab8"></a><!-- doxytag: member="boost::locale::generator::characters" ref="ad5e01c555aa43b438f688dbc29725ab8" args="(character_facet_type chars)" -->
 256 <div class="memitem">
 257 <div class="memproto">
 258       <table class="memname">
 259         <tr>
 260           <td class="memname">void boost::locale::generator::characters </td>
 261           <td>(</td>
 262           <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a>&nbsp;</td>
 263           <td class="paramname"> <em>chars</em></td>
 264           <td>&nbsp;)&nbsp;</td>
 265           <td></td>
 266         </tr>
 267       </table>
 268 </div>
 269 <div class="memdoc">
 270 <p>Set the characters type for which the facets should be generated, default all supported </p>
 271
 272 </div>
 273 </div>
 274 <a class="anchor" id="a7b4458ef36df82bc9e359735c55203e8"></a><!-- doxytag: member="boost::locale::generator::clear_cache" ref="a7b4458ef36df82bc9e359735c55203e8" args="()" -->
 275 <div class="memitem">
 276 <div class="memproto">
 277       <table class="memname">
 278         <tr>
 279           <td class="memname">void boost::locale::generator::clear_cache </td>
 280           <td>(</td>
 281           <td class="paramname"></td>
 282           <td>&nbsp;)&nbsp;</td>
 283           <td></td>
 284         </tr>
 285       </table>
 286 </div>
 287 <div class="memdoc">
 288 <p>Remove all cached locales </p>
 289
 290 </div>
 291 </div>
 292 <a class="anchor" id="ade4a0ae57dbe87dfc38aa945f063d3c4"></a><!-- doxytag: member="boost::locale::generator::clear_domains" ref="ade4a0ae57dbe87dfc38aa945f063d3c4" args="()" -->
 293 <div class="memitem">
 294 <div class="memproto">
 295       <table class="memname">
 296         <tr>
 297           <td class="memname">void boost::locale::generator::clear_domains </td>
 298           <td>(</td>
 299           <td class="paramname"></td>
 300           <td>&nbsp;)&nbsp;</td>
 301           <td></td>
 302         </tr>
 303       </table>
 304 </div>
 305 <div class="memdoc">
 306 <p>Remove all added domains from the list </p>
 307
 308 </div>
 309 </div>
 310 <a class="anchor" id="a1804390c65562fa66327152e9dd04c60"></a><!-- doxytag: member="boost::locale::generator::clear_options" ref="a1804390c65562fa66327152e9dd04c60" args="()" -->
 311 <div class="memitem">
 312 <div class="memproto">
 313       <table class="memname">
 314         <tr>
 315           <td class="memname">void boost::locale::generator::clear_options </td>
 316           <td>(</td>
 317           <td class="paramname"></td>
 318           <td>&nbsp;)&nbsp;</td>
 319           <td></td>
 320         </tr>
 321       </table>
 322 </div>
 323 <div class="memdoc">
 324 <p>Clear backend specific options </p>
 325
 326 </div>
 327 </div>
 328 <a class="anchor" id="ae6ef1ec096f219f4e6c092507e41fa35"></a><!-- doxytag: member="boost::locale::generator::clear_paths" ref="ae6ef1ec096f219f4e6c092507e41fa35" args="()" -->
 329 <div class="memitem">
 330 <div class="memproto">
 331       <table class="memname">
 332         <tr>
 333           <td class="memname">void boost::locale::generator::clear_paths </td>
 334           <td>(</td>
 335           <td class="paramname"></td>
 336           <td>&nbsp;)&nbsp;</td>
 337           <td></td>
 338         </tr>
 339       </table>
 340 </div>
 341 <div class="memdoc">
 342 <p>Remove all added paths </p>
 343
 344 </div>
 345 </div>
 346 <a class="anchor" id="aa98d7869660a1eb9b658b2cd4db495b3"></a><!-- doxytag: member="boost::locale::generator::generate" ref="aa98d7869660a1eb9b658b2cd4db495b3" args="(std::locale const &amp;base, std::string const &amp;id) const " -->
 347 <div class="memitem">
 348 <div class="memproto">
 349       <table class="memname">
 350         <tr>
 351           <td class="memname">std::locale boost::locale::generator::generate </td>
 352           <td>(</td>
 353           <td class="paramtype">std::locale const &amp;&nbsp;</td>
 354           <td class="paramname"> <em>base</em>, </td>
 355         </tr>
 356         <tr>
 357           <td class="paramkey"></td>
 358           <td></td>
 359           <td class="paramtype">std::string const &amp;&nbsp;</td>
 360           <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
 361         </tr>
 362         <tr>
 363           <td></td>
 364           <td>)</td>
 365           <td></td><td></td><td> const</td>
 366         </tr>
 367       </table>
 368 </div>
 369 <div class="memdoc">
 370 <p>Generate a locale with id <em>id</em>. Use <em>base</em> as a locale to which all facets are added, instead of std::locale::classic(). </p>
 371
 372 </div>
 373 </div>
 374 <a class="anchor" id="a75ba62f2ae7daa5a2d6641e36e064ecb"></a><!-- doxytag: member="boost::locale::generator::generate" ref="a75ba62f2ae7daa5a2d6641e36e064ecb" args="(std::string const &amp;id) const " -->
 375 <div class="memitem">
 376 <div class="memproto">
 377       <table class="memname">
 378         <tr>
 379           <td class="memname">std::locale boost::locale::generator::generate </td>
 380           <td>(</td>
 381           <td class="paramtype">std::string const &amp;&nbsp;</td>
 382           <td class="paramname"> <em>id</em></td>
 383           <td>&nbsp;)&nbsp;</td>
 384           <td> const</td>
 385         </tr>
 386       </table>
 387 </div>
 388 <div class="memdoc">
 389 <p>Generate a locale with id <em>id</em> </p>
 390
 391 </div>
 392 </div>
 393 <a class="anchor" id="ac2d152e2803cd96f4acc646943f2df51"></a><!-- doxytag: member="boost::locale::generator::locale_cache_enabled" ref="ac2d152e2803cd96f4acc646943f2df51" args="(bool on)" -->
 394 <div class="memitem">
 395 <div class="memproto">
 396       <table class="memname">
 397         <tr>
 398           <td class="memname">void boost::locale::generator::locale_cache_enabled </td>
 399           <td>(</td>
 400           <td class="paramtype">bool&nbsp;</td>
 401           <td class="paramname"> <em>on</em></td>
 402           <td>&nbsp;)&nbsp;</td>
 403           <td></td>
 404         </tr>
 405       </table>
 406 </div>
 407 <div class="memdoc">
 408 <p>Turn locale caching ON </p>
 409
 410 </div>
 411 </div>
 412 <a class="anchor" id="aacfcd26484a830723a8a9f9d2e91a0e6"></a><!-- doxytag: member="boost::locale::generator::locale_cache_enabled" ref="aacfcd26484a830723a8a9f9d2e91a0e6" args="() const " -->
 413 <div class="memitem">
 414 <div class="memproto">
 415       <table class="memname">
 416         <tr>
 417           <td class="memname">bool boost::locale::generator::locale_cache_enabled </td>
 418           <td>(</td>
 419           <td class="paramname"></td>
 420           <td>&nbsp;)&nbsp;</td>
 421           <td> const</td>
 422         </tr>
 423       </table>
 424 </div>
 425 <div class="memdoc">
 426 <p>Get locale cache option </p>
 427
 428 </div>
 429 </div>
 430 <a class="anchor" id="acd80b3f2371c77f4f7e7dfe69ec670ab"></a><!-- doxytag: member="boost::locale::generator::operator()" ref="acd80b3f2371c77f4f7e7dfe69ec670ab" args="(std::string const &amp;id) const " -->
 431 <div class="memitem">
 432 <div class="memproto">
 433       <table class="memname">
 434         <tr>
 435           <td class="memname">std::locale boost::locale::generator::operator() </td>
 436           <td>(</td>
 437           <td class="paramtype">std::string const &amp;&nbsp;</td>
 438           <td class="paramname"> <em>id</em></td>
 439           <td>&nbsp;)&nbsp;</td>
 440           <td> const<code> [inline]</code></td>
 441         </tr>
 442       </table>
 443 </div>
 444 <div class="memdoc">
 445 <p>Shortcut to generate(id) </p>
 446
 447 </div>
 448 </div>
 449 <a class="anchor" id="a4804bc5c4a9adb74cffcc2bdac87da1d"></a><!-- doxytag: member="boost::locale::generator::set_default_messages_domain" ref="a4804bc5c4a9adb74cffcc2bdac87da1d" args="(std::string const &amp;domain)" -->
 450 <div class="memitem">
 451 <div class="memproto">
 452       <table class="memname">
 453         <tr>
 454           <td class="memname">void boost::locale::generator::set_default_messages_domain </td>
 455           <td>(</td>
 456           <td class="paramtype">std::string const &amp;&nbsp;</td>
 457           <td class="paramname"> <em>domain</em></td>
 458           <td>&nbsp;)&nbsp;</td>
 459           <td></td>
 460         </tr>
 461       </table>
 462 </div>
 463 <div class="memdoc">
 464 <p>Set default message domain. If this member was not called, the first added messages domain is used. If the domain <em>domain</em> is not added yet it is added. </p>
 465
 466 </div>
 467 </div>
 468 <a class="anchor" id="ac0bbbb4aca466e59e82b63bcbf2efc8b"></a><!-- doxytag: member="boost::locale::generator::set_option" ref="ac0bbbb4aca466e59e82b63bcbf2efc8b" args="(std::string const &amp;name, std::string const &amp;value)" -->
 469 <div class="memitem">
 470 <div class="memproto">
 471       <table class="memname">
 472         <tr>
 473           <td class="memname">void boost::locale::generator::set_option </td>
 474           <td>(</td>
 475           <td class="paramtype">std::string const &amp;&nbsp;</td>
 476           <td class="paramname"> <em>name</em>, </td>
 477         </tr>
 478         <tr>
 479           <td class="paramkey"></td>
 480           <td></td>
 481           <td class="paramtype">std::string const &amp;&nbsp;</td>
 482           <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
 483         </tr>
 484         <tr>
 485           <td></td>
 486           <td>)</td>
 487           <td></td><td></td><td></td>
 488         </tr>
 489       </table>
 490 </div>
 491 <div class="memdoc">
 492 <p>Set backend specific option </p>
 493
 494 </div>
 495 </div>
 496 <a class="anchor" id="a9afb2b0791abbabd39c800e08d9c9717"></a><!-- doxytag: member="boost::locale::generator::use_ansi_encoding" ref="a9afb2b0791abbabd39c800e08d9c9717" args="() const " -->
 497 <div class="memitem">
 498 <div class="memproto">
 499       <table class="memname">
 500         <tr>
 501           <td class="memname">bool boost::locale::generator::use_ansi_encoding </td>
 502           <td>(</td>
 503           <td class="paramname"></td>
 504           <td>&nbsp;)&nbsp;</td>
 505           <td> const</td>
 506         </tr>
 507       </table>
 508 </div>
 509 <div class="memdoc">
 510 <p>Check if by default ANSI encoding is selected or UTF-8 onces. The default is false. </p>
 511
 512 </div>
 513 </div>
 514 <a class="anchor" id="ad9b74721ce3c5e1c39c7e9a4564e1e7b"></a><!-- doxytag: member="boost::locale::generator::use_ansi_encoding" ref="ad9b74721ce3c5e1c39c7e9a4564e1e7b" args="(bool enc)" -->
 515 <div class="memitem">
 516 <div class="memproto">
 517       <table class="memname">
 518         <tr>
 519           <td class="memname">void boost::locale::generator::use_ansi_encoding </td>
 520           <td>(</td>
 521           <td class="paramtype">bool&nbsp;</td>
 522           <td class="paramname"> <em>enc</em></td>
 523           <td>&nbsp;)&nbsp;</td>
 524           <td></td>
 525         </tr>
 526       </table>
 527 </div>
 528 <div class="memdoc">
 529 <p>Select ANSI encodings as default system encoding rather then UTF-8 by default under Windows.</p>
 530 <p>The default is the most portable and most powerful encoding, UTF-8, but the user can select "system" one if dealing with legacy applications </p>
 531
 532 </div>
 533 </div>
 534 <hr/>The documentation for this class was generated from the following file:<ul>
 535 <li>boost/locale/<a class="el" href="generator_8hpp_source.html">generator.hpp</a></li>
 536 </ul>
 537 </div>
 538 <hr class="footer"/><address class="footer"><small>
 539 &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.
 540 </small></address>
 541 </body>
 542 </html>