Files
opennurbs/6/db/dcf/class_o_n___text_iterator.html
Bozo 55446d56ce Publish!
Generated from v6.0.11315.11111-test10
2018-01-26 04:54:48 -08:00

347 lines
16 KiB
HTML

<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_TextIterator Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../d7/d15/class_o_n___text_iterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ON_TextIterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Converts wchar_t characters to Unicode codepoints.
<a href="../../db/dcf/class_o_n___text_iterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="../../de/d58/opennurbs__textiterator_8h_source.html">opennurbs_textiterator.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a22b35077feffb0954d5b7d7213a17db0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a22b35077feffb0954d5b7d7213a17db0">ON_TextIterator</a> (const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;str)</td></tr>
<tr class="separator:a22b35077feffb0954d5b7d7213a17db0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bf19c56c0600f73a6b7a4a8d94be56b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a4bf19c56c0600f73a6b7a4a8d94be56b">ON_TextIterator</a> (const wchar_t *str, size_t length)</td></tr>
<tr class="separator:a4bf19c56c0600f73a6b7a4a8d94be56b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03baff467c02a7bf2b29f4453ec8fcce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a03baff467c02a7bf2b29f4453ec8fcce">ON_TextIterator</a> (const <a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a> &amp;)=default</td></tr>
<tr class="separator:a03baff467c02a7bf2b29f4453ec8fcce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41a0f4c634bd0ba65aad86dc8b19a3f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a41a0f4c634bd0ba65aad86dc8b19a3f0">~ON_TextIterator</a> ()=default</td></tr>
<tr class="separator:a41a0f4c634bd0ba65aad86dc8b19a3f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ab16afd986ff3b9ed1f452b40b9385d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a3ab16afd986ff3b9ed1f452b40b9385d">AtBackslashTic</a> () const</td></tr>
<tr class="separator:a3ab16afd986ff3b9ed1f452b40b9385d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3a8d83e7f791afe7da7015a87f8b958"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#ac3a8d83e7f791afe7da7015a87f8b958">Back</a> ()</td></tr>
<tr class="memdesc:ac3a8d83e7f791afe7da7015a87f8b958"><td class="mdescLeft">&#160;</td><td class="mdescRight">move position back and return current codepoint after moving back <a href="#ac3a8d83e7f791afe7da7015a87f8b958">More...</a><br /></td></tr>
<tr class="separator:ac3a8d83e7f791afe7da7015a87f8b958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cb86171bb995280f40591c27bcc5d63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a9cb86171bb995280f40591c27bcc5d63">operator=</a> (const <a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a> &amp;)=default</td></tr>
<tr class="separator:a9cb86171bb995280f40591c27bcc5d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10a6b90408655024dc8aab01c001128a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a10a6b90408655024dc8aab01c001128a">PeekCodePoint</a> (ON__UINT32 &amp;unicode_code_point) const</td></tr>
<tr class="separator:a10a6b90408655024dc8aab01c001128a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1beb199a0221343ca63f0977f72a58f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a1beb199a0221343ca63f0977f72a58f6">ReadCharValue</a> (unsigned char &amp;c)</td></tr>
<tr class="separator:a1beb199a0221343ca63f0977f72a58f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ad6ccb5fde15d34388385c913a668fb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a0ad6ccb5fde15d34388385c913a668fb">ReadCodePoint</a> (ON__UINT32 &amp;unicode_code_point)</td></tr>
<tr class="separator:a0ad6ccb5fde15d34388385c913a668fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0411b494b4d509c953dcfabbfbbfb363"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a0411b494b4d509c953dcfabbfbbfb363">Step</a> ()</td></tr>
<tr class="separator:a0411b494b4d509c953dcfabbfbbfb363"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Converts wchar_t characters to Unicode codepoints. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a22b35077feffb0954d5b7d7213a17db0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22b35077feffb0954d5b7d7213a17db0">&#9670;&nbsp;</a></span>ON_TextIterator() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_TextIterator::ON_TextIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString</a> &amp;&#160;</td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4bf19c56c0600f73a6b7a4a8d94be56b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf19c56c0600f73a6b7a4a8d94be56b">&#9670;&nbsp;</a></span>ON_TextIterator() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ON_TextIterator::ON_TextIterator </td>
<td>(</td>
<td class="paramtype">const wchar_t *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a41a0f4c634bd0ba65aad86dc8b19a3f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41a0f4c634bd0ba65aad86dc8b19a3f0">&#9670;&nbsp;</a></span>~ON_TextIterator()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ON_TextIterator::~ON_TextIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a03baff467c02a7bf2b29f4453ec8fcce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03baff467c02a7bf2b29f4453ec8fcce">&#9670;&nbsp;</a></span>ON_TextIterator() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ON_TextIterator::ON_TextIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3ab16afd986ff3b9ed1f452b40b9385d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ab16afd986ff3b9ed1f452b40b9385d">&#9670;&nbsp;</a></span>AtBackslashTic()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::AtBackslashTic </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac3a8d83e7f791afe7da7015a87f8b958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3a8d83e7f791afe7da7015a87f8b958">&#9670;&nbsp;</a></span>Back()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::Back </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>move position back and return current codepoint after moving back </p>
</div>
</div>
<a id="a9cb86171bb995280f40591c27bcc5d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cb86171bb995280f40591c27bcc5d63">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a>&amp; ON_TextIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../db/dcf/class_o_n___text_iterator.html">ON_TextIterator</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a10a6b90408655024dc8aab01c001128a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10a6b90408655024dc8aab01c001128a">&#9670;&nbsp;</a></span>PeekCodePoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::PeekCodePoint </td>
<td>(</td>
<td class="paramtype">ON__UINT32 &amp;&#160;</td>
<td class="paramname"><em>unicode_code_point</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: unicode_code_point - [out] current unicode code point returned here. 0 = end of string Returns: true if returned unicode_code_point is not zero </p>
</div>
</div>
<a id="a1beb199a0221343ca63f0977f72a58f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1beb199a0221343ca63f0977f72a58f6">&#9670;&nbsp;</a></span>ReadCharValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::ReadCharValue </td>
<td>(</td>
<td class="paramtype">unsigned char &amp;&#160;</td>
<td class="paramname"><em>c</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0ad6ccb5fde15d34388385c913a668fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad6ccb5fde15d34388385c913a668fb">&#9670;&nbsp;</a></span>ReadCodePoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::ReadCodePoint </td>
<td>(</td>
<td class="paramtype">ON__UINT32 &amp;&#160;</td>
<td class="paramname"><em>unicode_code_point</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Gets the current unicode code point and calls <a class="el" href="../../db/dcf/class_o_n___text_iterator.html#a0411b494b4d509c953dcfabbfbbfb363">Step()</a> to advance the text iterator by one code point. Parameters: unicode_code_point - [out] current unicode code point returned here. 0 = end of string Returns: true if returned unicode_code_point is not zero </p>
</div>
</div>
<a id="a0411b494b4d509c953dcfabbfbbfb363"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0411b494b4d509c953dcfabbfbbfb363">&#9670;&nbsp;</a></span>Step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ON_TextIterator::Step </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next UNICODE code point encoded in m_text beginning at m_text[m_next_text_ci]; Save this code point in m_cur_codepoint. Advance m_next_text_ci. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 04:54:33 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>