namespaceboost_1_1locale_1_1utf.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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::utf Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  43. <li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
  51. <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
  52. </ul>
  53. </div>
  54. </div><!-- top -->
  55. <div id="side-nav" class="ui-resizable side-nav-resizable">
  56. <div id="nav-tree">
  57. <div id="nav-tree-contents">
  58. <div id="nav-sync" class="sync"></div>
  59. </div>
  60. </div>
  61. <div id="splitbar" style="-moz-user-select:none;"
  62. class="ui-resizable-handle">
  63. </div>
  64. </div>
  65. <script type="text/javascript">
  66. $(document).ready(function(){initNavTree('namespaceboost_1_1locale_1_1utf.html','');});
  67. </script>
  68. <div id="doc-content">
  69. <div class="header">
  70. <div class="summary">
  71. <a href="#nested-classes">Classes</a> &#124;
  72. <a href="#typedef-members">Typedefs</a> &#124;
  73. <a href="#func-members">Functions</a> &#124;
  74. <a href="#var-members">Variables</a> </div>
  75. <div class="headertitle">
  76. <div class="title">boost::locale::utf Namespace Reference</div> </div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p>Namespace that holds basic operations on UTF encoded sequences.
  80. <a href="#details">More...</a></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  83. Classes</h2></td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structboost_1_1locale_1_1utf_1_1utf__traits.html">utf_traits</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">UTF Traits class - functions to convert UTF sequences to and from Unicode code points. <a href="structboost_1_1locale_1_1utf_1_1utf__traits.html#details">More...</a><br/></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  89. Typedefs</h2></td></tr>
  90. <tr class="memitem:a068111a6b9d6d465a63893ed5c05e2f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a068111a6b9d6d465a63893ed5c05e2f8"></a>
  91. typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a></td></tr>
  92. <tr class="memdesc:a068111a6b9d6d465a63893ed5c05e2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The integral type that can hold a Unicode code point. <br/></td></tr>
  93. <tr class="separator:a068111a6b9d6d465a63893ed5c05e2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  96. Functions</h2></td></tr>
  97. <tr class="memitem:a189805c4e9f4c033ce5f88daf780e08e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a189805c4e9f4c033ce5f88daf780e08e"></a>
  98. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a189805c4e9f4c033ce5f88daf780e08e">is_valid_codepoint</a> (<a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a> v)</td></tr>
  99. <tr class="memdesc:a189805c4e9f4c033ce5f88daf780e08e"><td class="mdescLeft">&#160;</td><td class="mdescRight">the function checks if <em>v</em> is a valid code point <br/></td></tr>
  100. <tr class="separator:a189805c4e9f4c033ce5f88daf780e08e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  103. Variables</h2></td></tr>
  104. <tr class="memitem:a30010000878c7732340bda8956b844fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30010000878c7732340bda8956b844fb"></a>
  105. static const <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a30010000878c7732340bda8956b844fb">illegal</a> = 0xFFFFFFFFu</td></tr>
  106. <tr class="memdesc:a30010000878c7732340bda8956b844fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines illegal code point. <br/></td></tr>
  107. <tr class="separator:a30010000878c7732340bda8956b844fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a20dbe458fd18229a0e6c09888d031b38"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20dbe458fd18229a0e6c09888d031b38"></a>
  109. static const <a class="el" href="namespaceboost_1_1locale_1_1utf.html#a068111a6b9d6d465a63893ed5c05e2f8">code_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1locale_1_1utf.html#a20dbe458fd18229a0e6c09888d031b38">incomplete</a> = 0xFFFFFFFEu</td></tr>
  110. <tr class="memdesc:a20dbe458fd18229a0e6c09888d031b38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines incomplete code point. <br/></td></tr>
  111. <tr class="separator:a20dbe458fd18229a0e6c09888d031b38"><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>Namespace that holds basic operations on UTF encoded sequences. </p>
  115. <p>All functions defined in this namespace do not require linking with Boost.Locale library </p>
  116. </div></div><!-- contents -->
  117. </div><!-- doc-content -->
  118. <li class="footer">
  119. &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.
  120. </li>
  121. </ul>
  122. </div>
  123. </body>
  124. </html>