libs/locale/doc/html/classboost_1_1locale_1_1localization__backend.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 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>Boost.Locale: boost::locale::localization_backend Class Reference</title>
   7
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  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 </script>
  17
  18
  19 </head>
  20 <body>
  21 <div id="top"><!-- do not remove this div! -->
  22
  23
  24 <div id="titlearea">
  25 <table cellspacing="0" cellpadding="0">
  26  <tbody>
  27  <tr style="height: 56px;">
  28
  29   <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td>
  30
  31
  32   <td style="padding-left: 0.5em;">
  33    <div id="projectname">Boost.Locale
  34
  35    </div>
  36
  37   </td>
  38
  39
  40
  41  </tr>
  42  </tbody>
  43 </table>
  44 </div>
  45
  46 <!-- Generated by Doxygen 1.7.6.1 -->
  47   <div id="navrow1" class="tabs">
  48     <ul class="tablist">
  49       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  50       <li><a href="modules.html"><span>Modules</span></a></li>
  51       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  52       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  53       <li><a href="files.html"><span>Files</span></a></li>
  54       <li><a href="examples.html"><span>Examples</span></a></li>
  55     </ul>
  56   </div>
  57   <div id="navrow2" class="tabs2">
  58     <ul class="tablist">
  59       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  61       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  62     </ul>
  63   </div>
  64 </div>
  65 <div id="side-nav" class="ui-resizable side-nav-resizable">
  66   <div id="nav-tree">
  67     <div id="nav-tree-contents">
  68     </div>
  69   </div>
  70   <div id="splitbar" style="-moz-user-select:none;"
  71        class="ui-resizable-handle">
  72   </div>
  73 </div>
  74 <script type="text/javascript">
  75   initNavTree('classboost_1_1locale_1_1localization__backend.html','');
  76 </script>
  77 <div id="doc-content">
  78 <div class="header">
  79   <div class="summary">
  80 <a href="#pub-methods">Public Member Functions</a>  </div>
  81   <div class="headertitle">
  82 <div class="title">boost::locale::localization_backend Class Reference</div>  </div>
  83 </div><!--header-->
  84 <div class="contents">
  85 <!-- doxytag: class="boost::locale::localization_backend" -->
  86 <p>this class represents a localization backend that can be used for localizing your application.
  87  <a href="classboost_1_1locale_1_1localization__backend.html#details">More...</a></p>
  88
  89 <p><code>#include &lt;<a class="el" href="localization__backend_8hpp_source.html">boost/locale/localization_backend.hpp</a>&gt;</code></p>
  90
  91 <p><a href="classboost_1_1locale_1_1localization__backend-members.html">List of all members.</a></p>
  92 <table class="memberdecls">
  93 <tr><td colspan="2"><h2><a name="pub-methods"></a>
  94 Public Member Functions</h2></td></tr>
  95 <tr><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>
  96 <tr><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>
  97 <tr><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>
  98 <tr><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>
  99 </table>
 100 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 101 <div class="textblock"><p>this class represents a localization backend that can be used for localizing your application. </p>
 102 <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>
 103 <p>Backends may support different tuning options, but these are the default options available to the user for all of them</p>
 104 <ol type="1">
 105 <li><code>locale</code> - the name of the locale in POSIX format like en_US.UTF-8</li>
 106 <li><code>use_ansi_encoding</code> - select system locale using ANSI codepages rather then UTF-8 under Windows by default</li>
 107 <li><code>message_path</code> - path to the location of message catalogs (vector of strings)</li>
 108 <li><code>message_application</code> - the name of applications that use message catalogs (vector of strings)</li>
 109 </ol>
 110 <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>
 111 </div><hr/><h2>Member Function Documentation</h2>
 112 <a class="anchor" id="a631af306f8652dcf7874b0bb38ab8891"></a><!-- doxytag: member="boost::locale::localization_backend::clear_options" ref="a631af306f8652dcf7874b0bb38ab8891" args="()=0" -->
 113 <div class="memitem">
 114 <div class="memproto">
 115       <table class="memname">
 116         <tr>
 117           <td class="memname">virtual void <a class="el" href="classboost_1_1locale_1_1localization__backend.html#a631af306f8652dcf7874b0bb38ab8891">boost::locale::localization_backend::clear_options</a> </td>
 118           <td>(</td>
 119           <td class="paramname"></td><td>)</td>
 120           <td><code> [pure virtual]</code></td>
 121         </tr>
 122       </table>
 123 </div>
 124 <div class="memdoc">
 125 <p>Clear all options </p>
 126
 127 </div>
 128 </div>
 129 <a class="anchor" id="ab89828234ca84d4b43f3692bfbb08b25"></a><!-- doxytag: member="boost::locale::localization_backend::clone" ref="ab89828234ca84d4b43f3692bfbb08b25" args="() const =0" -->
 130 <div class="memitem">
 131 <div class="memproto">
 132       <table class="memname">
 133         <tr>
 134           <td class="memname">virtual <a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a>* <a class="el" href="classboost_1_1locale_1_1localization__backend.html#ab89828234ca84d4b43f3692bfbb08b25">boost::locale::localization_backend::clone</a> </td>
 135           <td>(</td>
 136           <td class="paramname"></td><td>)</td>
 137           <td> const<code> [pure virtual]</code></td>
 138         </tr>
 139       </table>
 140 </div>
 141 <div class="memdoc">
 142 <p>Make a polymorphic copy of the backend </p>
 143
 144 </div>
 145 </div>
 146 <a class="anchor" id="a5992c75d469f775ce1d18a0912bfa8a1"></a><!-- doxytag: member="boost::locale::localization_backend::install" ref="a5992c75d469f775ce1d18a0912bfa8a1" args="(std::locale const &amp;base, locale_category_type category, character_facet_type type=nochar_facet)=0" -->
 147 <div class="memitem">
 148 <div class="memproto">
 149       <table class="memname">
 150         <tr>
 151           <td class="memname">virtual std::locale <a class="el" href="classboost_1_1locale_1_1localization__backend.html#a5992c75d469f775ce1d18a0912bfa8a1">boost::locale::localization_backend::install</a> </td>
 152           <td>(</td>
 153           <td class="paramtype">std::locale const &amp;&#160;</td>
 154           <td class="paramname"><em>base</em>, </td>
 155         </tr>
 156         <tr>
 157           <td class="paramkey"></td>
 158           <td></td>
 159           <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a32e8cb87d2f68a5577dbb7ce55c0d2b1">locale_category_type</a>&#160;</td>
 160           <td class="paramname"><em>category</em>, </td>
 161         </tr>
 162         <tr>
 163           <td class="paramkey"></td>
 164           <td></td>
 165           <td class="paramtype"><a class="el" href="namespaceboost_1_1locale.html#a8c993aaf15e683e97d062560ccf914d8">character_facet_type</a>&#160;</td>
 166           <td class="paramname"><em>type</em> = <code><a class="el" href="namespaceboost_1_1locale.html#a330a4c5134eb5110b33a0b4f986f34be">nochar_facet</a></code>&#160;</td>
 167         </tr>
 168         <tr>
 169           <td></td>
 170           <td>)</td>
 171           <td></td><td><code> [pure virtual]</code></td>
 172         </tr>
 173       </table>
 174 </div>
 175 <div class="memdoc">
 176 <p>Create a facet for category <em>category</em> and character type <em>type</em> </p>
 177
 178 </div>
 179 </div>
 180 <a class="anchor" id="a3dc9028eb813001f6cdd8fca937837ef"></a><!-- doxytag: member="boost::locale::localization_backend::set_option" ref="a3dc9028eb813001f6cdd8fca937837ef" args="(std::string const &amp;name, std::string const &amp;value)=0" -->
 181 <div class="memitem">
 182 <div class="memproto">
 183       <table class="memname">
 184         <tr>
 185           <td class="memname">virtual void <a class="el" href="classboost_1_1locale_1_1localization__backend.html#a3dc9028eb813001f6cdd8fca937837ef">boost::locale::localization_backend::set_option</a> </td>
 186           <td>(</td>
 187           <td class="paramtype">std::string const &amp;&#160;</td>
 188           <td class="paramname"><em>name</em>, </td>
 189         </tr>
 190         <tr>
 191           <td class="paramkey"></td>
 192           <td></td>
 193           <td class="paramtype">std::string const &amp;&#160;</td>
 194           <td class="paramname"><em>value</em>&#160;</td>
 195         </tr>
 196         <tr>
 197           <td></td>
 198           <td>)</td>
 199           <td></td><td><code> [pure virtual]</code></td>
 200         </tr>
 201       </table>
 202 </div>
 203 <div class="memdoc">
 204 <p>Set option for backend, for example "locale" or "encoding" </p>
 205
 206 </div>
 207 </div>
 208 <hr/>The documentation for this class was generated from the following file:<ul>
 209 <li>boost/locale/<a class="el" href="localization__backend_8hpp_source.html">localization_backend.hpp</a></li>
 210 </ul>
 211 </div><!-- contents -->
 212 </div>
 213   <div id="nav-path" class="navpath">
 214     <ul>
 215       <li class="navelem"><b>boost</b>      </li>
 216       <li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a>      </li>
 217       <li class="navelem"><a class="el" href="classboost_1_1locale_1_1localization__backend.html">localization_backend</a>      </li>
 218
 219     <li class="footer">
 220 &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.
 221     </li>
 222    </ul>
 223  </div>
 224
 225
 226 </body>
 227 </html>