classboost_1_1locale_1_1generator.html 27 KB

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