Sophie

Sophie

distrib > Mageia > 6 > armv5tl > media > core-release > by-pkgid > 3a4e91bde08970529a0aa07935652fe8 > files > 10

icu-doc-58.2-3.mga6.noarch.rpm

<!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.11"/>
<title>ICU 58.2: appendable.h Source File</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="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">ICU 58.2
   &#160;<span id="projectnumber">58.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">appendable.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="appendable_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// License &amp; terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">*******************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">*   Copyright (C) 2011-2012, International Business Machines</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">*   Corporation and others.  All Rights Reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">*******************************************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">*   file name:  appendable.h</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">*   encoding:   US-ASCII</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">*   tab size:   8 (not used)</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">*   indentation:4</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">*</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">*   created on: 2010dec07</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">*   created by: Markus W. Scherer</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef __APPENDABLE_H__</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define __APPENDABLE_H__</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="utypes_8h.html">unicode/utypes.h</a>&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="uobject_8h.html">unicode/uobject.h</a>&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespaceicu.html">   28</a></span>&#160;<a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">class </span><a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classicu_1_1Appendable.html">   51</a></span>&#160;<span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classicu_1_1Appendable.html">Appendable</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UObject.html">UObject</a> {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    ~<a class="code" href="classicu_1_1Appendable.html">Appendable</a>();</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> appendCodeUnit(<a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> c) = 0;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> appendCodePoint(<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c);</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> appendString(<span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *s, int32_t length);</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> reserveAppendCapacity(int32_t appendCapacity);</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *getAppendBuffer(int32_t minCapacity,</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;                                   int32_t desiredCapacityHint,</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;                                   <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *scratch, int32_t scratchCapacity,</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;                                   int32_t *resultCapacity);</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;};</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;</div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classicu_1_1UnicodeStringAppendable.html">  153</a></span>&#160;<span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classicu_1_1UnicodeStringAppendable.html">UnicodeStringAppendable</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1Appendable.html">Appendable</a> {</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classicu_1_1UnicodeStringAppendable.html#a6ae00c011250894ca83354b1e53c5cfd">  160</a></span>&#160;    <span class="keyword">explicit</span> <a class="code" href="classicu_1_1UnicodeStringAppendable.html#a6ae00c011250894ca83354b1e53c5cfd">UnicodeStringAppendable</a>(<a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;s) : str(s) {}</div><div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    ~<a class="code" href="classicu_1_1UnicodeStringAppendable.html">UnicodeStringAppendable</a>();</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;</div><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="classicu_1_1Appendable.html#a5f306d09d7ae12718a86d6a55fcdb20e">appendCodeUnit</a>(<a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> c);</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div><div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="classicu_1_1Appendable.html#ab6ebdf003f35a831577f7a4a297b826e">appendCodePoint</a>(<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c);</div><div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="classicu_1_1Appendable.html#aa53adceb8a3c9549b1d35f06f63c5c92">appendString</a>(<span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *s, int32_t length);</div><div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;</div><div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="classicu_1_1Appendable.html#a1950ff25060fe2549160b65cb6a08f95">reserveAppendCapacity</a>(int32_t appendCapacity);</div><div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;</div><div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;    <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *<a class="code" href="classicu_1_1Appendable.html#a85c1af8466fa68893689e96dfa583801">getAppendBuffer</a>(int32_t minCapacity,</div><div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;                                   int32_t desiredCapacityHint,</div><div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;                                   <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *scratch, int32_t scratchCapacity,</div><div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;                                   int32_t *resultCapacity);</div><div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;</div><div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;    <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a> &amp;str;</div><div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;};</div><div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;</div><div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="preprocessor">#endif  // __APPENDABLE_H__</span></div><div class="ttc" id="classicu_1_1Appendable_html_a1950ff25060fe2549160b65cb6a08f95"><div class="ttname"><a href="classicu_1_1Appendable.html#a1950ff25060fe2549160b65cb6a08f95">icu::Appendable::reserveAppendCapacity</a></div><div class="ttdeci">virtual UBool reserveAppendCapacity(int32_t appendCapacity)</div><div class="ttdoc">Tells the object that the caller is going to append roughly appendCapacity UChars. </div></div>
<div class="ttc" id="classicu_1_1Appendable_html_a5f306d09d7ae12718a86d6a55fcdb20e"><div class="ttname"><a href="classicu_1_1Appendable.html#a5f306d09d7ae12718a86d6a55fcdb20e">icu::Appendable::appendCodeUnit</a></div><div class="ttdeci">virtual UBool appendCodeUnit(UChar c)=0</div><div class="ttdoc">Appends a 16-bit code unit. </div></div>
<div class="ttc" id="classicu_1_1UnicodeStringAppendable_html"><div class="ttname"><a href="classicu_1_1UnicodeStringAppendable.html">icu::UnicodeStringAppendable</a></div><div class="ttdoc">An Appendable implementation which writes to a UnicodeString. </div><div class="ttdef"><b>Definition:</b> <a href="appendable_8h_source.html#l00153">appendable.h:153</a></div></div>
<div class="ttc" id="classicu_1_1Appendable_html_a85c1af8466fa68893689e96dfa583801"><div class="ttname"><a href="classicu_1_1Appendable.html#a85c1af8466fa68893689e96dfa583801">icu::Appendable::getAppendBuffer</a></div><div class="ttdeci">virtual UChar * getAppendBuffer(int32_t minCapacity, int32_t desiredCapacityHint, UChar *scratch, int32_t scratchCapacity, int32_t *resultCapacity)</div><div class="ttdoc">Returns a writable buffer for appending and writes the buffer&amp;#39;s capacity to *resultCapacity. </div></div>
<div class="ttc" id="uversion_8h_html_a7d9374e037299886d4192b763b4c5e8b"><div class="ttname"><a href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define U_NAMESPACE_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00131">uversion.h:131</a></div></div>
<div class="ttc" id="classicu_1_1Appendable_html_ab6ebdf003f35a831577f7a4a297b826e"><div class="ttname"><a href="classicu_1_1Appendable.html#ab6ebdf003f35a831577f7a4a297b826e">icu::Appendable::appendCodePoint</a></div><div class="ttdeci">virtual UBool appendCodePoint(UChar32 c)</div><div class="ttdoc">Appends a code point. </div></div>
<div class="ttc" id="umachine_8h_html_a09fff5c3b5a5b015324dc3ec3cf92809"><div class="ttname"><a href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a></div><div class="ttdeci">int32_t UChar32</div><div class="ttdoc">Define UChar32 as a type for single Unicode code points. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00357">umachine.h:357</a></div></div>
<div class="ttc" id="classicu_1_1UnicodeStringAppendable_html_a6ae00c011250894ca83354b1e53c5cfd"><div class="ttname"><a href="classicu_1_1UnicodeStringAppendable.html#a6ae00c011250894ca83354b1e53c5cfd">icu::UnicodeStringAppendable::UnicodeStringAppendable</a></div><div class="ttdeci">UnicodeStringAppendable(UnicodeString &amp;s)</div><div class="ttdoc">Aliases the UnicodeString (keeps its reference) for writing. </div><div class="ttdef"><b>Definition:</b> <a href="appendable_8h_source.html#l00160">appendable.h:160</a></div></div>
<div class="ttc" id="uobject_8h_html"><div class="ttname"><a href="uobject_8h.html">uobject.h</a></div><div class="ttdoc">C++ API: Common ICU base class UObject. </div></div>
<div class="ttc" id="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">uint16_t UChar</div><div class="ttdoc">Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...</div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00337">umachine.h:337</a></div></div>
<div class="ttc" id="uversion_8h_html_a3da1f00f3b02976ac53c014a3e4c0933"><div class="ttname"><a href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="ttdeci">#define U_NAMESPACE_END</div><div class="ttdoc">This is used to end a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00132">uversion.h:132</a></div></div>
<div class="ttc" id="classicu_1_1Appendable_html_aa53adceb8a3c9549b1d35f06f63c5c92"><div class="ttname"><a href="classicu_1_1Appendable.html#aa53adceb8a3c9549b1d35f06f63c5c92">icu::Appendable::appendString</a></div><div class="ttdeci">virtual UBool appendString(const UChar *s, int32_t length)</div><div class="ttdoc">Appends a string. </div></div>
<div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div>
<div class="ttc" id="utypes_8h_html_a559955ec3bc692657c5d8b1c6de8e334"><div class="ttname"><a href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a></div><div class="ttdeci">#define U_COMMON_API</div><div class="ttdoc">Set to export library symbols from inside the common library, and to import them from outside...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00359">utypes.h:359</a></div></div>
<div class="ttc" id="classicu_1_1UnicodeString_html"><div class="ttname"><a href="classicu_1_1UnicodeString.html">icu::UnicodeString</a></div><div class="ttdoc">UnicodeString is a string class that stores Unicode characters directly and provides similar function...</div><div class="ttdef"><b>Definition:</b> <a href="unistr_8h_source.html#l00295">unistr.h:295</a></div></div>
<div class="ttc" id="classicu_1_1UObject_html"><div class="ttname"><a href="classicu_1_1UObject.html">icu::UObject</a></div><div class="ttdoc">UObject is the common ICU &quot;boilerplate&quot; class. </div><div class="ttdef"><b>Definition:</b> <a href="uobject_8h_source.html#l00223">uobject.h:223</a></div></div>
<div class="ttc" id="umachine_8h_html_a349ef00011f20ccd1d3b424445681aa5"><div class="ttname"><a href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a></div><div class="ttdeci">int8_t UBool</div><div class="ttdoc">The ICU boolean type. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00259">umachine.h:259</a></div></div>
<div class="ttc" id="classicu_1_1Appendable_html"><div class="ttname"><a href="classicu_1_1Appendable.html">icu::Appendable</a></div><div class="ttdoc">Base class for objects to which Unicode characters and strings can be appended. </div><div class="ttdef"><b>Definition:</b> <a href="appendable_8h_source.html#l00051">appendable.h:51</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>