classboost_1_1locale_1_1localization__backend__manager.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  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_manager 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__manager.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-methods">Static Public Member Functions</a> &#124;
  74. <a href="classboost_1_1locale_1_1localization__backend__manager-members.html">List of all members</a> </div>
  75. <div class="headertitle">
  76. <div class="title">boost::locale::localization_backend_manager Class Reference</div> </div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>Localization backend manager is a class that holds various backend and allows creation of their combination or selection.
  80. <a href="classboost_1_1locale_1_1localization__backend__manager.html#details">More...</a></p>
  81. <p><code>#include &lt;<a class="el" href="localization__backend_8hpp_source.html">boost/locale/localization_backend.hpp</a>&gt;</code></p>
  82. <table class="memberdecls">
  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  84. Public Member Functions</h2></td></tr>
  85. <tr class="memitem:a0407271db5e7722f901c510474c3581f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a0407271db5e7722f901c510474c3581f">localization_backend_manager</a> ()</td></tr>
  86. <tr class="separator:a0407271db5e7722f901c510474c3581f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ad2fb02931f4b202eedc46b3da4a24449"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#ad2fb02931f4b202eedc46b3da4a24449">localization_backend_manager</a> (<a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;)</td></tr>
  88. <tr class="separator:ad2fb02931f4b202eedc46b3da4a24449"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:af506ec1809f2f67c71f590862f63eeab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> <br class="typebreak"/>
  90. const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#af506ec1809f2f67c71f590862f63eeab">operator=</a> (<a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;)</td></tr>
  91. <tr class="separator:af506ec1809f2f67c71f590862f63eeab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a7e602229ef95ea60834fdea95110bf19"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a7e602229ef95ea60834fdea95110bf19">~localization_backend_manager</a> ()</td></tr>
  93. <tr class="separator:a7e602229ef95ea60834fdea95110bf19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a89d377e934af287573212581cab70dd6"><td class="memItemLeft" align="right" valign="top">std::auto_ptr<br class="typebreak"/>
  95. &lt; <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a89d377e934af287573212581cab70dd6">get</a> () const </td></tr>
  96. <tr class="separator:a89d377e934af287573212581cab70dd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ae3c6eca5cc54c5161fef3bfd14509c64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#ae3c6eca5cc54c5161fef3bfd14509c64">add_backend</a> (std::string const &amp;name, std::auto_ptr&lt; <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a> &gt; backend)</td></tr>
  98. <tr class="separator:ae3c6eca5cc54c5161fef3bfd14509c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a8c9841c83aa85dbf8f61b2e17732499a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a8c9841c83aa85dbf8f61b2e17732499a">remove_all_backends</a> ()</td></tr>
  100. <tr class="separator:a8c9841c83aa85dbf8f61b2e17732499a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a7bd336cf325b0ee284ab8a07813679c0"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a7bd336cf325b0ee284ab8a07813679c0">get_all_backends</a> () const </td></tr>
  102. <tr class="separator:a7bd336cf325b0ee284ab8a07813679c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:adf33775a09e7a765c3401e769019e915"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#adf33775a09e7a765c3401e769019e915">select</a> (std::string const &amp;backend_name, <a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a> category=<a class="el" href="namespaceboost_1_1locale.html#ab51b0b65a19b1db3adc14e9866097e2a">all_categories</a>)</td></tr>
  104. <tr class="separator:adf33775a09e7a765c3401e769019e915"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table><table class="memberdecls">
  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  107. Static Public Member Functions</h2></td></tr>
  108. <tr class="memitem:a65649bc161a0cc160da9b40a9ad14e20"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a65649bc161a0cc160da9b40a9ad14e20">global</a> (<a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;)</td></tr>
  109. <tr class="separator:a65649bc161a0cc160da9b40a9ad14e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a0935a48d3012f62197f4e92119ee62b5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html#a0935a48d3012f62197f4e92119ee62b5">global</a> ()</td></tr>
  111. <tr class="separator:a0935a48d3012f62197f4e92119ee62b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>Localization backend manager is a class that holds various backend and allows creation of their combination or selection. </p>
  115. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a class="anchor" id="a0407271db5e7722f901c510474c3581f"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">boost::locale::localization_backend_manager::localization_backend_manager </td>
  122. <td>(</td>
  123. <td class="paramname"></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>New empty <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>
  129. </div>
  130. </div>
  131. <a class="anchor" id="ad2fb02931f4b202eedc46b3da4a24449"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">boost::locale::localization_backend_manager::localization_backend_manager </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;&#160;</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Copy <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="a7e602229ef95ea60834fdea95110bf19"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">boost::locale::localization_backend_manager::~localization_backend_manager </td>
  153. <td>(</td>
  154. <td class="paramname"></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Destructor </p>
  160. </div>
  161. </div>
  162. <h2 class="groupheader">Member Function Documentation</h2>
  163. <a class="anchor" id="ae3c6eca5cc54c5161fef3bfd14509c64"></a>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">void boost::locale::localization_backend_manager::add_backend </td>
  169. <td>(</td>
  170. <td class="paramtype">std::string const &amp;&#160;</td>
  171. <td class="paramname"><em>name</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">std::auto_ptr&lt; <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a> &gt;&#160;</td>
  177. <td class="paramname"><em>backend</em>&#160;</td>
  178. </tr>
  179. <tr>
  180. <td></td>
  181. <td>)</td>
  182. <td></td><td></td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Add new backend to the manager, each backend should be uniquely defined by its name.</p>
  187. <p>This library provides: "icu", "posix", "winapi" and "std" backends. </p>
  188. </div>
  189. </div>
  190. <a class="anchor" id="a89d377e934af287573212581cab70dd6"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">std::auto_ptr&lt;<a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a>&gt; boost::locale::localization_backend_manager::get </td>
  196. <td>(</td>
  197. <td class="paramname"></td><td>)</td>
  198. <td> const</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Create new localization backend according to current settings. </p>
  203. </div>
  204. </div>
  205. <a class="anchor" id="a7bd336cf325b0ee284ab8a07813679c0"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">std::vector&lt;std::string&gt; boost::locale::localization_backend_manager::get_all_backends </td>
  211. <td>(</td>
  212. <td class="paramname"></td><td>)</td>
  213. <td> const</td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Get list of all available backends </p>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a65649bc161a0cc160da9b40a9ad14e20"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">static <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> boost::locale::localization_backend_manager::global </td>
  229. <td>(</td>
  230. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;&#160;</td>
  231. <td class="paramname"></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Set new global backend manager, the old one is returned.</p>
  242. <p>This function is thread safe </p>
  243. </div>
  244. </div>
  245. <a class="anchor" id="a0935a48d3012f62197f4e92119ee62b5"></a>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">static <a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> boost::locale::localization_backend_manager::global </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Get global backend manager</p>
  266. <p>This function is thread safe </p>
  267. </div>
  268. </div>
  269. <a class="anchor" id="af506ec1809f2f67c71f590862f63eeab"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const&amp; boost::locale::localization_backend_manager::operator= </td>
  275. <td>(</td>
  276. <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1localization__backend__manager.html">localization_backend_manager</a> const &amp;&#160;</td>
  277. <td class="paramname"></td><td>)</td>
  278. <td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Assign <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>
  283. </div>
  284. </div>
  285. <a class="anchor" id="a8c9841c83aa85dbf8f61b2e17732499a"></a>
  286. <div class="memitem">
  287. <div class="memproto">
  288. <table class="memname">
  289. <tr>
  290. <td class="memname">void boost::locale::localization_backend_manager::remove_all_backends </td>
  291. <td>(</td>
  292. <td class="paramname"></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Clear backend </p>
  298. </div>
  299. </div>
  300. <a class="anchor" id="adf33775a09e7a765c3401e769019e915"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">void boost::locale::localization_backend_manager::select </td>
  306. <td>(</td>
  307. <td class="paramtype">std::string const &amp;&#160;</td>
  308. <td class="paramname"><em>backend_name</em>, </td>
  309. </tr>
  310. <tr>
  311. <td class="paramkey"></td>
  312. <td></td>
  313. <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a>&#160;</td>
  314. <td class="paramname"><em>category</em> = <code><a class="el" href="namespaceboost_1_1locale.html#ab51b0b65a19b1db3adc14e9866097e2a">all_categories</a></code>&#160;</td>
  315. </tr>
  316. <tr>
  317. <td></td>
  318. <td>)</td>
  319. <td></td><td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Select specific backend by name for a category <em>category</em>. It allows combining different backends for user preferences. </p>
  324. </div>
  325. </div>
  326. <hr/>The documentation for this class was generated from the following file:<ul>
  327. <li>boost/locale/<a class="el" href="localization__backend_8hpp_source.html">localization_backend.hpp</a></li>
  328. </ul>
  329. </div><!-- contents -->
  330. </div><!-- doc-content -->
  331. <li class="footer">
  332. &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.
  333. </li>
  334. </ul>
  335. </div>
  336. </body>
  337. </html>