blob: 4fadd5ca4ee1f83e6ad90909f9c78ca7db63c38f [file] [log] [blame]
<!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::utf Namespace 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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#160;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('namespaceboost_1_1locale_1_1utf.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">boost::locale::utf Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Namespace that holds basic operations on UTF encoded sequences.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><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>
<tr><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>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a068111a6b9d6d465a63893ed5c05e2f8"></a><!-- doxytag: member="boost::locale::utf::code_point" ref="a068111a6b9d6d465a63893ed5c05e2f8" args="" -->
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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The integral type that can hold a Unicode code point. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a189805c4e9f4c033ce5f88daf780e08e"></a><!-- doxytag: member="boost::locale::utf::is_valid_codepoint" ref="a189805c4e9f4c033ce5f88daf780e08e" args="(code_point v)" -->
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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">the function checks if <em>v</em> is a valid code point <br/></td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30010000878c7732340bda8956b844fb"></a><!-- doxytag: member="boost::locale::utf::illegal" ref="a30010000878c7732340bda8956b844fb" args="" -->
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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines illegal code point. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20dbe458fd18229a0e6c09888d031b38"></a><!-- doxytag: member="boost::locale::utf::incomplete" ref="a20dbe458fd18229a0e6c09888d031b38" args="" -->
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>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Special constant that defines incomplete code point. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Namespace that holds basic operations on UTF encoded sequences. </p>
<p>All functions defined in this namespace do not require linking with Boost.Locale library </p>
</div></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="namespaceboost_1_1locale_1_1utf.html">utf</a> </li>
<li class="footer">
&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.
</li>
</ul>
</div>
</body>
</html>