| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <title>Boost.Locale: boost::locale::info Class Reference</title> |
| |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </script> |
| |
| |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div! --> |
| |
| |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| |
| <td id="projectlogo"><img alt="Logo" src="boost-small.png"/></td> |
| |
| |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Boost.Locale |
| |
| </div> |
| |
| </td> |
| |
| |
| |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| |
| <!-- Generated by Doxygen 1.7.6.1 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="modules.html"><span>Modules</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| initNavTree('classboost_1_1locale_1_1info.html',''); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#pro-methods">Protected Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">boost::locale::info Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <!-- doxytag: class="boost::locale::info" --> |
| <p>a facet that holds general information about locale |
| <a href="classboost_1_1locale_1_1info.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="info_8hpp_source.html">boost/locale/info.hpp</a>></code></p> |
| |
| <p><a href="classboost_1_1locale_1_1info-members.html">List of all members.</a></p> |
| <table class="memberdecls"> |
| <tr><td colspan="2"><h2><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr><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/> |
|   <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf">language_property</a>, |
| <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61">country_property</a>, |
| <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c">variant_property</a>, |
| <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26">encoding_property</a>, |
| <br/> |
|   <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369">name_property</a> |
| <br/> |
| }</td></tr> |
| <tr><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> |
| }</td></tr> |
| <tr><td colspan="2"><h2><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><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> |
| <tr><td colspan="2"><h2><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01c274323da1367b153952ee1f056572"></a><!-- doxytag: member="boost::locale::info::id" ref="a01c274323da1367b153952ee1f056572" args="" --> |
| static std::locale::id </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1info.html#a01c274323da1367b153952ee1f056572">id</a></td></tr> |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">This member uniquely defines this facet, required by STL. <br/></td></tr> |
| <tr><td colspan="2"><h2><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr><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> |
| <tr><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> |
| </table> |
| <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> |
| <div class="textblock"><p>a facet that holds general information about locale </p> |
| <p>This facet should be always created in order to make all Boost.Locale functions work </p> |
| </div><hr/><h2>Member Enumeration Documentation</h2> |
| <a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6d"></a><!-- doxytag: member="boost::locale::info::integer_property" ref="a53d7aa756e1b74f360913a9c9d41bb6d" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">boost::locale::info::integer_property</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Integer information about locale </p> |
| <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em><a class="anchor" id="a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea"></a><!-- doxytag: member="utf8_property" ref="a53d7aa756e1b74f360913a9c9d41bb6da4d27d781e7da56cb9b94bfd8cdcab5ea" args="" -->utf8_property</em> </td><td> |
| <p>Non zero value if uses UTF-8 encoding. </p> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15"></a><!-- doxytag: member="boost::locale::info::string_propery" ref="ac79e3924b5473862ab15a3290b1c8d15" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">boost::locale::info::string_propery</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>String information about the locale </p> |
| <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf"></a><!-- doxytag: member="language_property" ref="ac79e3924b5473862ab15a3290b1c8d15a51e81de8c364b3734f4e2baf1abaddcf" args="" -->language_property</em> </td><td> |
| <p>ISO 639 language id. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61"></a><!-- doxytag: member="country_property" ref="ac79e3924b5473862ab15a3290b1c8d15ab59b95580bc749f21c832a70d4b73c61" args="" -->country_property</em> </td><td> |
| <p>ISO 3166 country id. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c"></a><!-- doxytag: member="variant_property" ref="ac79e3924b5473862ab15a3290b1c8d15a2b38cb5c60ed931f21fc9bec4984900c" args="" -->variant_property</em> </td><td> |
| <p>Variant for locale. </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26"></a><!-- doxytag: member="encoding_property" ref="ac79e3924b5473862ab15a3290b1c8d15a1aa0567014d09df594b4a616f20c9b26" args="" -->encoding_property</em> </td><td> |
| <p>encoding name </p> |
| </td></tr> |
| <tr><td valign="top"><em><a class="anchor" id="ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369"></a><!-- doxytag: member="name_property" ref="ac79e3924b5473862ab15a3290b1c8d15ab68bcb824a19b6cfd95ad3c714369369" args="" -->name_property</em> </td><td> |
| <p>locale name </p> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a5545bf33988c859b3b864d4d65178134"></a><!-- doxytag: member="boost::locale::info::info" ref="a5545bf33988c859b3b864d4d65178134" args="(size_t refs=0)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classboost_1_1locale_1_1info.html#a5545bf33988c859b3b864d4d65178134">boost::locale::info::info</a> </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>refs</em> = <code>0</code></td><td>)</td> |
| <td><code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Standard facet's constructor </p> |
| |
| </div> |
| </div> |
| <hr/><h2>Member Function Documentation</h2> |
| <a class="anchor" id="a249c20e36da6827a8dc8b12a8342a7dc"></a><!-- doxytag: member="boost::locale::info::country" ref="a249c20e36da6827a8dc8b12a8342a7dc" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1info.html#a249c20e36da6827a8dc8b12a8342a7dc">boost::locale::info::country</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get country name </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1979a5d7b90604c45e856a139c68f5ba"></a><!-- doxytag: member="boost::locale::info::encoding" ref="a1979a5d7b90604c45e856a139c68f5ba" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1info.html#a1979a5d7b90604c45e856a139c68f5ba">boost::locale::info::encoding</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get encoding </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee97062cd9c8a1c6b24a160783865ee2"></a><!-- doxytag: member="boost::locale::info::get_integer_property" ref="aee97062cd9c8a1c6b24a160783865ee2" args="(integer_property v) const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int <a class="el" href="classboost_1_1locale_1_1info.html#aee97062cd9c8a1c6b24a160783865ee2">boost::locale::info::get_integer_property</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#a53d7aa756e1b74f360913a9c9d41bb6d">integer_property</a> </td> |
| <td class="paramname"><em>v</em></td><td>)</td> |
| <td> const<code> [protected, pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get integer property by its id <em>v</em> </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38673d9985abd1c98713b262fadfe584"></a><!-- doxytag: member="boost::locale::info::get_string_property" ref="a38673d9985abd1c98713b262fadfe584" args="(string_propery v) const =0" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual std::string <a class="el" href="classboost_1_1locale_1_1info.html#a38673d9985abd1c98713b262fadfe584">boost::locale::info::get_string_property</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classboost_1_1locale_1_1info.html#ac79e3924b5473862ab15a3290b1c8d15">string_propery</a> </td> |
| <td class="paramname"><em>v</em></td><td>)</td> |
| <td> const<code> [protected, pure virtual]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get string property by its id <em>v</em> </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7c56b9df3aba82649afc66c06192c7df"></a><!-- doxytag: member="boost::locale::info::language" ref="a7c56b9df3aba82649afc66c06192c7df" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1info.html#a7c56b9df3aba82649afc66c06192c7df">boost::locale::info::language</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get language name </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af8181bf226f369548c030220932323b9"></a><!-- doxytag: member="boost::locale::info::name" ref="af8181bf226f369548c030220932323b9" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1info.html#af8181bf226f369548c030220932323b9">boost::locale::info::name</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get the name of the locale, like en_US.UTF-8 </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aafbbb5c291f60ce6fc3bc056859ba181"></a><!-- doxytag: member="boost::locale::info::utf8" ref="aafbbb5c291f60ce6fc3bc056859ba181" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="classboost_1_1locale_1_1info.html#aafbbb5c291f60ce6fc3bc056859ba181">boost::locale::info::utf8</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>True if the underlying encoding is UTF-8 (for char streams and strings) </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2e949e4362c8f0195e2a645fe875f1b4"></a><!-- doxytag: member="boost::locale::info::variant" ref="a2e949e4362c8f0195e2a645fe875f1b4" args="() const " --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string <a class="el" href="classboost_1_1locale_1_1info.html#a2e949e4362c8f0195e2a645fe875f1b4">boost::locale::info::variant</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const<code> [inline]</code></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| <p>Get locale variant </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>boost/locale/<a class="el" href="info_8hpp_source.html">info.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><b>boost</b> </li> |
| <li class="navelem"><a class="el" href="namespaceboost_1_1locale.html">locale</a> </li> |
| <li class="navelem"><a class="el" href="classboost_1_1locale_1_1info.html">info</a> </li> |
| |
| <li class="footer"> |
| © 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. |
| </li> |
| </ul> |
| </div> |
| |
| |
| </body> |
| </html> |
