classboost_1_1locale_1_1localization__backend.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  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::localization_backend 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_1localization__backend.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_1localization__backend-members.html">List of all members</a> </div>
  74. <div class="headertitle">
  75. <div class="title">boost::locale::localization_backend Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>this class represents a localization backend that can be used for localizing your application.
  79. <a href="classboost_1_1locale_1_1localization__backend.html#details">More...</a></p>
  80. <p><code>#include &lt;<a class="el" href="localization__backend_8hpp_source.html">boost/locale/localization_backend.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:ab89828234ca84d4b43f3692bfbb08b25"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend.html#ab89828234ca84d4b43f3692bfbb08b25">clone</a> () const =0</td></tr>
  85. <tr class="separator:ab89828234ca84d4b43f3692bfbb08b25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a3dc9028eb813001f6cdd8fca937837ef"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend.html#a3dc9028eb813001f6cdd8fca937837ef">set_option</a> (std::string const &amp;name, std::string const &amp;value)=0</td></tr>
  87. <tr class="separator:a3dc9028eb813001f6cdd8fca937837ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a631af306f8652dcf7874b0bb38ab8891"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend.html#a631af306f8652dcf7874b0bb38ab8891">clear_options</a> ()=0</td></tr>
  89. <tr class="separator:a631af306f8652dcf7874b0bb38ab8891"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a5992c75d469f775ce1d18a0912bfa8a1"><td class="memItemLeft" align="right" valign="top">virtual std::locale&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend.html#a5992c75d469f775ce1d18a0912bfa8a1">install</a> (std::locale const &amp;base, <a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a> category, <a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a> type=<a class="el" href="namespaceboost_1_1locale.html#a330a4c5134eb5110b33a0b4f986f34be">nochar_facet</a>)=0</td></tr>
  91. <tr class="separator:a5992c75d469f775ce1d18a0912bfa8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94. <div class="textblock"><p>this class represents a localization backend that can be used for localizing your application. </p>
  95. <p>Backends are usually registered inside the localization backends manager and allow transparent support of different backends, so a user can switch the backend by simply linking the application to the correct one.</p>
  96. <p>Backends may support different tuning options, but these are the default options available to the user for all of them</p>
  97. <ol type="1">
  98. <li><code>locale</code> - the name of the locale in POSIX format like en_US.UTF-8</li>
  99. <li><code>use_ansi_encoding</code> - select system locale using ANSI codepages rather then UTF-8 under Windows by default</li>
  100. <li><code>message_path</code> - path to the location of message catalogs (vector of strings)</li>
  101. <li><code>message_application</code> - the name of applications that use message catalogs (vector of strings)</li>
  102. </ol>
  103. <p>Each backend can be installed with a different default priotiry so when you work with two different backends, you can specify priotiry so this backend will be chosen according to their priority. </p>
  104. </div><h2 class="groupheader">Member Function Documentation</h2>
  105. <a class="anchor" id="a631af306f8652dcf7874b0bb38ab8891"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="mlabels">
  109. <tr>
  110. <td class="mlabels-left">
  111. <table class="memname">
  112. <tr>
  113. <td class="memname">virtual void boost::locale::localization_backend::clear_options </td>
  114. <td>(</td>
  115. <td class="paramname"></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </td>
  120. <td class="mlabels-right">
  121. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>Clear all options </p>
  126. </div>
  127. </div>
  128. <a class="anchor" id="ab89828234ca84d4b43f3692bfbb08b25"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">virtual <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a>* boost::locale::localization_backend::clone </td>
  137. <td>(</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td> const</td>
  140. </tr>
  141. </table>
  142. </td>
  143. <td class="mlabels-right">
  144. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>Make a polymorphic copy of the backend </p>
  149. </div>
  150. </div>
  151. <a class="anchor" id="a5992c75d469f775ce1d18a0912bfa8a1"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="mlabels">
  155. <tr>
  156. <td class="mlabels-left">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">virtual std::locale boost::locale::localization_backend::install </td>
  160. <td>(</td>
  161. <td class="paramtype">std::locale const &amp;&#160;</td>
  162. <td class="paramname"><em>base</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a>&#160;</td>
  168. <td class="paramname"><em>category</em>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a>&#160;</td>
  174. <td class="paramname"><em>type</em> = <code><a class="el" href="namespaceboost_1_1locale.html#a330a4c5134eb5110b33a0b4f986f34be">nochar_facet</a></code>&#160;</td>
  175. </tr>
  176. <tr>
  177. <td></td>
  178. <td>)</td>
  179. <td></td><td></td>
  180. </tr>
  181. </table>
  182. </td>
  183. <td class="mlabels-right">
  184. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Create a facet for category <em>category</em> and character type <em>type</em> </p>
  189. </div>
  190. </div>
  191. <a class="anchor" id="a3dc9028eb813001f6cdd8fca937837ef"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="mlabels">
  195. <tr>
  196. <td class="mlabels-left">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">virtual void boost::locale::localization_backend::set_option </td>
  200. <td>(</td>
  201. <td class="paramtype">std::string const &amp;&#160;</td>
  202. <td class="paramname"><em>name</em>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">std::string const &amp;&#160;</td>
  208. <td class="paramname"><em>value</em>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td>)</td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Set option for backend, for example "locale" or "encoding" </p>
  223. </div>
  224. </div>
  225. <hr/>The documentation for this class was generated from the following file:<ul>
  226. <li>boost/locale/<a class="el" href="localization__backend_8hpp_source.html">localization_backend.hpp</a></li>
  227. </ul>
  228. </div><!-- contents -->
  229. </div><!-- doc-content -->
  230. <li class="footer">
  231. &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.
  232. </li>
  233. </ul>
  234. </div>
  235. </body>
  236. </html>