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::info 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 Page</span></a></li> 40 <li><a href="pages.html"><span>Related 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 List</span></a></li> 51 <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> 52 <li><a href="functions.html"><span>Class 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_1info.html','');}); 68</script> 69<div id="doc-content"> 70<div class="header"> 71 <div class="summary"> 72<a href="#pub-types">Public Types</a> | 73<a href="#pub-methods">Public Member Functions</a> | 74<a href="#pub-static-attribs">Static Public Attributes</a> | 75<a href="#pro-methods">Protected Member Functions</a> | 76<a href="classboost_1_1locale_1_1info-members.html">List of all members</a> </div> 77 <div class="headertitle"> 78<div class="title">boost::locale::info Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> 79</div><!--header--> 80<div class="contents"> 81 82<p>a facet that holds general information about locale 83 <a href="classboost_1_1locale_1_1info.html#details">More...</a></p> 84 85<p><code>#include <<a class="el" href="info_8hpp_source.html">boost/locale/info.hpp</a>></code></p> 86<div class="dynheader"> 87Inheritance diagram for boost::locale::info:</div> 88<div class="dyncontent"> 89 <div class="center"> 90 <img src="classboost_1_1locale_1_1info.png" usemap="#boost::locale::info_map" alt=""/> 91 <map id="boost::locale::info_map" name="boost::locale::info_map"> 92</map> 93 </div></div> 94<table class="memberdecls"> 95<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> 96Public Types</h2></td></tr> 97<tr class="memitem:ac79e3924b5473862ab15a3290b1c8d15"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> { <br/> 98  <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf">language_property</a>, 99<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61">country_property</a>, 100<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c">variant_property</a>, 101<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26">encoding_property</a>, 102<br/> 103  <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369">name_property</a> 104<br/> 105 }</td></tr> 106<tr class="separator:ac79e3924b5473862ab15a3290b1c8d15"><td class="memSeparator" colspan="2"> </td></tr> 107<tr class="memitem:a53d7aa756e1b74f360913a9c9d41bb6d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> { <a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea">utf8_property</a> 108 }</td></tr> 109<tr class="separator:a53d7aa756e1b74f360913a9c9d41bb6d"><td class="memSeparator" colspan="2"> </td></tr> 110</table><table class="memberdecls"> 111<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 112Public Member Functions</h2></td></tr> 113<tr class="memitem:a5545bf33988c859b3b864d4d65178134"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a5545bf33988c859b3b864d4d65178134">info</a> (size_t refs=0)</td></tr> 114<tr class="separator:a5545bf33988c859b3b864d4d65178134"><td class="memSeparator" colspan="2"> </td></tr> 115<tr class="memitem:a7c56b9df3aba82649afc66c06192c7df"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a7c56b9df3aba82649afc66c06192c7df">language</a> () const </td></tr> 116<tr class="separator:a7c56b9df3aba82649afc66c06192c7df"><td class="memSeparator" colspan="2"> </td></tr> 117<tr class="memitem:a249c20e36da6827a8dc8b12a8342a7dc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a249c20e36da6827a8dc8b12a8342a7dc">country</a> () const </td></tr> 118<tr class="separator:a249c20e36da6827a8dc8b12a8342a7dc"><td class="memSeparator" colspan="2"> </td></tr> 119<tr class="memitem:a2e949e4362c8f0195e2a645fe875f1b4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a2e949e4362c8f0195e2a645fe875f1b4">variant</a> () const </td></tr> 120<tr class="separator:a2e949e4362c8f0195e2a645fe875f1b4"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:a1979a5d7b90604c45e856a139c68f5ba"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a1979a5d7b90604c45e856a139c68f5ba">encoding</a> () const </td></tr> 122<tr class="separator:a1979a5d7b90604c45e856a139c68f5ba"><td class="memSeparator" colspan="2"> </td></tr> 123<tr class="memitem:af8181bf226f369548c030220932323b9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#af8181bf226f369548c030220932323b9">name</a> () const </td></tr> 124<tr class="separator:af8181bf226f369548c030220932323b9"><td class="memSeparator" colspan="2"> </td></tr> 125<tr class="memitem:aafbbb5c291f60ce6fc3bc056859ba181"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#aafbbb5c291f60ce6fc3bc056859ba181">utf8</a> () const </td></tr> 126<tr class="separator:aafbbb5c291f60ce6fc3bc056859ba181"><td class="memSeparator" colspan="2"> </td></tr> 127</table><table class="memberdecls"> 128<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> 129Static Public Attributes</h2></td></tr> 130<tr class="memitem:a01c274323da1367b153952ee1f056572"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01c274323da1367b153952ee1f056572"></a> 131static std::locale::id </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a01c274323da1367b153952ee1f056572">id</a></td></tr> 132<tr class="memdesc:a01c274323da1367b153952ee1f056572"><td class="mdescLeft"> </td><td class="mdescRight">This member uniquely defines this facet, required by STL. <br/></td></tr> 133<tr class="separator:a01c274323da1367b153952ee1f056572"><td class="memSeparator" colspan="2"> </td></tr> 134</table><table class="memberdecls"> 135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> 136Protected Member Functions</h2></td></tr> 137<tr class="memitem:a38673d9985abd1c98713b262fadfe584"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a38673d9985abd1c98713b262fadfe584">get_string_property</a> (<a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> v) const =0</td></tr> 138<tr class="separator:a38673d9985abd1c98713b262fadfe584"><td class="memSeparator" colspan="2"> </td></tr> 139<tr class="memitem:aee97062cd9c8a1c6b24a160783865ee2"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#aee97062cd9c8a1c6b24a160783865ee2">get_integer_property</a> (<a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> v) const =0</td></tr> 140<tr class="separator:aee97062cd9c8a1c6b24a160783865ee2"><td class="memSeparator" colspan="2"> </td></tr> 141</table> 142<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 143<div class="textblock"><p>a facet that holds general information about locale </p> 144<p>This facet should be always created in order to make all Boost.Locale functions work </p> 145</div><h2 class="groupheader">Member Enumeration Documentation</h2> 146<a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6d"></a> 147<div class="memitem"> 148<div class="memproto"> 149 <table class="memname"> 150 <tr> 151 <td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">boost::locale::info::integer_property</a></td> 152 </tr> 153 </table> 154</div><div class="memdoc"> 155<p>Integer information about locale </p> 156<table class="fieldtable"> 157<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea"></a>utf8_property</em> </td><td class="fielddoc"> 158<p>Non zero value if uses UTF-8 encoding. </p> 159</td></tr> 160</table> 161 162</div> 163</div> 164<a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15"></a> 165<div class="memitem"> 166<div class="memproto"> 167 <table class="memname"> 168 <tr> 169 <td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">boost::locale::info::string_propery</a></td> 170 </tr> 171 </table> 172</div><div class="memdoc"> 173<p>String information about the locale </p> 174<table class="fieldtable"> 175<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf"></a>language_property</em> </td><td class="fielddoc"> 176<p>ISO 639 language id. </p> 177</td></tr> 178<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61"></a>country_property</em> </td><td class="fielddoc"> 179<p>ISO 3166 country id. </p> 180</td></tr> 181<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c"></a>variant_property</em> </td><td class="fielddoc"> 182<p>Variant for locale. </p> 183</td></tr> 184<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26"></a>encoding_property</em> </td><td class="fielddoc"> 185<p>encoding name </p> 186</td></tr> 187<tr><td class="fieldname"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369"></a>name_property</em> </td><td class="fielddoc"> 188<p>locale name </p> 189</td></tr> 190</table> 191 192</div> 193</div> 194<h2 class="groupheader">Constructor & Destructor Documentation</h2> 195<a class="anchor" id="a5545bf33988c859b3b864d4d65178134"></a> 196<div class="memitem"> 197<div class="memproto"> 198<table class="mlabels"> 199 <tr> 200 <td class="mlabels-left"> 201 <table class="memname"> 202 <tr> 203 <td class="memname">boost::locale::info::info </td> 204 <td>(</td> 205 <td class="paramtype">size_t </td> 206 <td class="paramname"><em>refs</em> = <code>0</code></td><td>)</td> 207 <td></td> 208 </tr> 209 </table> 210 </td> 211 <td class="mlabels-right"> 212<span class="mlabels"><span class="mlabel">inline</span></span> </td> 213 </tr> 214</table> 215</div><div class="memdoc"> 216<p>Standard facet's constructor </p> 217 218</div> 219</div> 220<h2 class="groupheader">Member Function Documentation</h2> 221<a class="anchor" id="a249c20e36da6827a8dc8b12a8342a7dc"></a> 222<div class="memitem"> 223<div class="memproto"> 224<table class="mlabels"> 225 <tr> 226 <td class="mlabels-left"> 227 <table class="memname"> 228 <tr> 229 <td class="memname">std::string boost::locale::info::country </td> 230 <td>(</td> 231 <td class="paramname"></td><td>)</td> 232 <td> const</td> 233 </tr> 234 </table> 235 </td> 236 <td class="mlabels-right"> 237<span class="mlabels"><span class="mlabel">inline</span></span> </td> 238 </tr> 239</table> 240</div><div class="memdoc"> 241<p>Get country name </p> 242 243</div> 244</div> 245<a class="anchor" id="a1979a5d7b90604c45e856a139c68f5ba"></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">std::string boost::locale::info::encoding </td> 254 <td>(</td> 255 <td class="paramname"></td><td>)</td> 256 <td> const</td> 257 </tr> 258 </table> 259 </td> 260 <td class="mlabels-right"> 261<span class="mlabels"><span class="mlabel">inline</span></span> </td> 262 </tr> 263</table> 264</div><div class="memdoc"> 265<p>Get encoding </p> 266 267</div> 268</div> 269<a class="anchor" id="aee97062cd9c8a1c6b24a160783865ee2"></a> 270<div class="memitem"> 271<div class="memproto"> 272<table class="mlabels"> 273 <tr> 274 <td class="mlabels-left"> 275 <table class="memname"> 276 <tr> 277 <td class="memname">virtual int boost::locale::info::get_integer_property </td> 278 <td>(</td> 279 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> </td> 280 <td class="paramname"><em>v</em></td><td>)</td> 281 <td> const</td> 282 </tr> 283 </table> 284 </td> 285 <td class="mlabels-right"> 286<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> 287 </tr> 288</table> 289</div><div class="memdoc"> 290<p>Get integer property by its id <em>v</em> </p> 291 292</div> 293</div> 294<a class="anchor" id="a38673d9985abd1c98713b262fadfe584"></a> 295<div class="memitem"> 296<div class="memproto"> 297<table class="mlabels"> 298 <tr> 299 <td class="mlabels-left"> 300 <table class="memname"> 301 <tr> 302 <td class="memname">virtual std::string boost::locale::info::get_string_property </td> 303 <td>(</td> 304 <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> </td> 305 <td class="paramname"><em>v</em></td><td>)</td> 306 <td> const</td> 307 </tr> 308 </table> 309 </td> 310 <td class="mlabels-right"> 311<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> 312 </tr> 313</table> 314</div><div class="memdoc"> 315<p>Get string property by its id <em>v</em> </p> 316 317</div> 318</div> 319<a class="anchor" id="a7c56b9df3aba82649afc66c06192c7df"></a> 320<div class="memitem"> 321<div class="memproto"> 322<table class="mlabels"> 323 <tr> 324 <td class="mlabels-left"> 325 <table class="memname"> 326 <tr> 327 <td class="memname">std::string boost::locale::info::language </td> 328 <td>(</td> 329 <td class="paramname"></td><td>)</td> 330 <td> const</td> 331 </tr> 332 </table> 333 </td> 334 <td class="mlabels-right"> 335<span class="mlabels"><span class="mlabel">inline</span></span> </td> 336 </tr> 337</table> 338</div><div class="memdoc"> 339<p>Get language name </p> 340 341</div> 342</div> 343<a class="anchor" id="af8181bf226f369548c030220932323b9"></a> 344<div class="memitem"> 345<div class="memproto"> 346<table class="mlabels"> 347 <tr> 348 <td class="mlabels-left"> 349 <table class="memname"> 350 <tr> 351 <td class="memname">std::string boost::locale::info::name </td> 352 <td>(</td> 353 <td class="paramname"></td><td>)</td> 354 <td> const</td> 355 </tr> 356 </table> 357 </td> 358 <td class="mlabels-right"> 359<span class="mlabels"><span class="mlabel">inline</span></span> </td> 360 </tr> 361</table> 362</div><div class="memdoc"> 363<p>Get the name of the locale, like en_US.UTF-8 </p> 364 365</div> 366</div> 367<a class="anchor" id="aafbbb5c291f60ce6fc3bc056859ba181"></a> 368<div class="memitem"> 369<div class="memproto"> 370<table class="mlabels"> 371 <tr> 372 <td class="mlabels-left"> 373 <table class="memname"> 374 <tr> 375 <td class="memname">bool boost::locale::info::utf8 </td> 376 <td>(</td> 377 <td class="paramname"></td><td>)</td> 378 <td> const</td> 379 </tr> 380 </table> 381 </td> 382 <td class="mlabels-right"> 383<span class="mlabels"><span class="mlabel">inline</span></span> </td> 384 </tr> 385</table> 386</div><div class="memdoc"> 387<p>True if the underlying encoding is UTF-8 (for char streams and strings) </p> 388 389</div> 390</div> 391<a class="anchor" id="a2e949e4362c8f0195e2a645fe875f1b4"></a> 392<div class="memitem"> 393<div class="memproto"> 394<table class="mlabels"> 395 <tr> 396 <td class="mlabels-left"> 397 <table class="memname"> 398 <tr> 399 <td class="memname">std::string boost::locale::info::variant </td> 400 <td>(</td> 401 <td class="paramname"></td><td>)</td> 402 <td> const</td> 403 </tr> 404 </table> 405 </td> 406 <td class="mlabels-right"> 407<span class="mlabels"><span class="mlabel">inline</span></span> </td> 408 </tr> 409</table> 410</div><div class="memdoc"> 411<p>Get locale variant </p> 412 413</div> 414</div> 415<hr/>The documentation for this class was generated from the following file:<ul> 416<li>boost/locale/<a class="el" href="info_8hpp_source.html">info.hpp</a></li> 417</ul> 418</div><!-- contents --> 419</div><!-- doc-content --> 420 421 <li class="footer"> 422© 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. 423 </li> 424 </ul> 425 </div> 426</body> 427</html> 428
