<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>ICU 3.6: LocaleRuns Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.4.7 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li id="current"><a href="classes.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li> <form action="search.php" method="get"> <table cellspacing="0" cellpadding="0" border="0"> <tr> <td><label> <u>S</u>earch for </label></td> <td><input type="text" name="query" value="" size="20" accesskey="s"/></td> </tr> </table> </form> </li> </ul></div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul></div> <h1>LocaleRuns Class Reference</h1><!-- doxytag: class="LocaleRuns" --><!-- doxytag: inherits="RunArray" -->The <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> class associates pointers to <code><a class="el" href="classLocale.html">Locale</a></code> objects with runs of text. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>></code> <p> <p>Inheritance diagram for LocaleRuns: <p><center><img src="classLocaleRuns.png" usemap="#LocaleRuns_map" border="0" alt=""></center> <map name="LocaleRuns_map"> <area href="classRunArray.html" alt="RunArray" shape="rect" coords="0,112,78,136"> <area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,78,80"> <area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,78,24"> </map> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#c85abd4dc631e76f96e696c6b4d5e4c8">LocaleRuns</a> (const <a class="el" href="classLocale.html">Locale</a> **locales, const <a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> *limits, <a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> count)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object from pre-existing arrays of locales and limit indices. <a href="#c85abd4dc631e76f96e696c6b4d5e4c8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#3195d60ef439963c9c0067056f199022">LocaleRuns</a> (<a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> initialCapacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object. <a href="#3195d60ef439963c9c0067056f199022"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#3cf020eb38be0a07815efa752909820a">~LocaleRuns</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor; virtual so that subclass destructors are invoked as well. <a href="#3cf020eb38be0a07815efa752909820a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classLocale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#5f71380787d21525607b375e1676b99f">getLocale</a> (<a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> run) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <code><a class="el" href="classLocale.html">Locale</a></code> object assoicated with the given run of text. <a href="#5f71380787d21525607b375e1676b99f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#4395fb97d931060930a1a7e46c54e4ec">add</a> (const <a class="el" href="classLocale.html">Locale</a> *locale, <a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> limit)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <code><a class="el" href="classLocale.html">Locale</a></code> and limit index pair to the data arrays and return the run index where the data was stored. <a href="#4395fb97d931060930a1a7e46c54e4ec"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#5f46ba4dfc7c4ae59e255717f6725be6">getDynamicClassID</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#5f46ba4dfc7c4ae59e255717f6725be6"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#a071805eedca134c35421bc7ed1ba87a">getStaticClassID</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#a071805eedca134c35421bc7ed1ba87a"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#6305af1c0d7dd33ea574e01069298bb3">init</a> (<a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> capacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a data array with the given initial size. <a href="#6305af1c0d7dd33ea574e01069298bb3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLocaleRuns.html#e1b4ec56248e06a2b8aa216fe4c5f9e6">grow</a> (<a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> capacity)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Grow a data array to the given initial size. <a href="#e1b4ec56248e06a2b8aa216fe4c5f9e6"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> The <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> class associates pointers to <code><a class="el" href="classLocale.html">Locale</a></code> objects with runs of text. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003238">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00407">407</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="c85abd4dc631e76f96e696c6b4d5e4c8"></a><!-- doxytag: member="LocaleRuns::LocaleRuns" ref="c85abd4dc631e76f96e696c6b4d5e4c8" args="(const Locale **locales, const le_int32 *limits, le_int32 count)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LocaleRuns::LocaleRuns </td> <td>(</td> <td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> ** </td> <td class="paramname"> <em>locales</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> * </td> <td class="paramname"> <em>limits</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>count</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct a <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object from pre-existing arrays of locales and limit indices. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>locales</em> </td><td>is the address of an array of pointers to <code><a class="el" href="classLocale.html">Locale</a></code> objects. This array, and the <code><a class="el" href="classLocale.html">Locale</a></code> objects to which it points, must remain valid until the <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object is destroyed.</td></tr> <tr><td valign="top"></td><td valign="top"><em>limits</em> </td><td>is the address of an array of limit indices. This array must remain valid until the <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object is destroyed.</td></tr> <tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>is the number of entries in the two arrays.</td></tr> </table> </dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003259">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00532">532</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. <p> References <a class="el" href="RunArrays_8h-source.html#l00532">LocaleRuns()</a>. <p> Referenced by <a class="el" href="RunArrays_8h-source.html#l00532">LocaleRuns()</a>. </div> </div><p> <a class="anchor" name="3195d60ef439963c9c0067056f199022"></a><!-- doxytag: member="LocaleRuns::LocaleRuns" ref="3195d60ef439963c9c0067056f199022" args="(le_int32 initialCapacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">LocaleRuns::LocaleRuns </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>initialCapacity</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Construct an empty <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object. <p> Clients can add locale and limit indices arrays using the <code>add</code> method.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>initialCapacity</em> </td><td>is the initial size of the locale and limit indices arrays. If this value is zero, no arrays will be allocated.</td></tr> </table> </dl> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocaleRuns.html#4395fb97d931060930a1a7e46c54e4ec">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003260">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="3cf020eb38be0a07815efa752909820a"></a><!-- doxytag: member="LocaleRuns::~LocaleRuns" ref="3cf020eb38be0a07815efa752909820a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual LocaleRuns::~LocaleRuns </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> The destructor; virtual so that subclass destructors are invoked as well. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003261">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="4395fb97d931060930a1a7e46c54e4ec"></a><!-- doxytag: member="LocaleRuns::add" ref="4395fb97d931060930a1a7e46c54e4ec" args="(const Locale *locale, le_int32 limit)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> LocaleRuns::add </td> <td>(</td> <td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> * </td> <td class="paramname"> <em>locale</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>limit</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Add a <code><a class="el" href="classLocale.html">Locale</a></code> and limit index pair to the data arrays and return the run index where the data was stored. <p> This method calls <code>RunArray::add(limit)</code> which will create or grow the arrays as needed.<p> If the <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object was created with a client-supplied locale and limit indices arrays, this method will return a run index of -1.<p> Subclasses should not override this method. Rather they should provide a new <code>add</code> method which takes a locale and a limit index along with whatever other data they implement. The new <code>add</code> method should first call this method to grow the font and limit indices arrays, and use the returned run index to store data their own arrays.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>is the address of the <code><a class="el" href="classLocale.html">Locale</a></code> to add. This object must remain valid until the <code><a class="el" href="classLocaleRuns.html">LocaleRuns</a></code> object is destroyed.</td></tr> <tr><td valign="top"></td><td valign="top"><em>limit</em> </td><td>is the limit index to add</td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>the run index where the locale and limit index were stored, or -1 if the data cannot be stored.</dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003263">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="5f46ba4dfc7c4ae59e255717f6725be6"></a><!-- doxytag: member="LocaleRuns::getDynamicClassID" ref="5f46ba4dfc7c4ae59e255717f6725be6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> LocaleRuns::getDynamicClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> ICU "poor man's RTTI", returns a UClassID for the actual class. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003265">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#3ac4c2be2170153283bf492b876e2766">RunArray</a>. <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00499">499</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. <p> References <a class="el" href="RunArrays_8h-source.html#l00155">RunArray::getStaticClassID()</a>. </div> </div><p> <a class="anchor" name="5f71380787d21525607b375e1676b99f"></a><!-- doxytag: member="LocaleRuns::getLocale" ref="5f71380787d21525607b375e1676b99f" args="(le_int32 run) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classLocale.html">Locale</a>* LocaleRuns::getLocale </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>run</em> </td> <td> ) </td> <td width="100%"> const</td> </tr> </table> </div> <div class="memdoc"> <p> Get the <code><a class="el" href="classLocale.html">Locale</a></code> object assoicated with the given run of text. <p> Use <code>RunArray::getLimit(run)</code> to get the corresponding limit index.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>run</em> </td><td>is the index into the font and limit indices arrays.</td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>the <code><a class="el" href="classLocale.html">Locale</a></code> associated with the given text run.</dd></dl> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classRunArray.html#c0ec7456e8c1c78f515d0a68151cc2e9">RunArray::getLimit</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003262">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div><p> <a class="anchor" name="a071805eedca134c35421bc7ed1ba87a"></a><!-- doxytag: member="LocaleRuns::getStaticClassID" ref="a071805eedca134c35421bc7ed1ba87a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> LocaleRuns::getStaticClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> ICU "poor man's RTTI", returns a UClassID for this class. <p> <dl compact><dt><b><a class="el" href="stable.html#_stable003264">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#978b8547191d5203c10fc1b1079fa94b">RunArray</a>. <p> Definition at line <a class="el" href="RunArrays_8h-source.html#l00492">492</a> of file <a class="el" href="RunArrays_8h-source.html">RunArrays.h</a>. </div> </div><p> <a class="anchor" name="e1b4ec56248e06a2b8aa216fe4c5f9e6"></a><!-- doxytag: member="LocaleRuns::grow" ref="e1b4ec56248e06a2b8aa216fe4c5f9e6" args="(le_int32 capacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void LocaleRuns::grow </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>capacity</em> </td> <td> ) </td> <td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Grow a data array to the given initial size. <p> This method will be called by the <code>add</code> method if the limit indices array is full. Subclasses which override this method must also call it from the overriding method to grow the limit indices array.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>is the initial size of the data array.</td></tr> </table> </dl> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocaleRuns.html#4395fb97d931060930a1a7e46c54e4ec">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003250">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#82fa607d9cc092c30a6ab37b9606ce0b">RunArray</a>. </div> </div><p> <a class="anchor" name="6305af1c0d7dd33ea574e01069298bb3"></a><!-- doxytag: member="LocaleRuns::init" ref="6305af1c0d7dd33ea574e01069298bb3" args="(le_int32 capacity)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void LocaleRuns::init </td> <td>(</td> <td class="paramtype"><a class="el" href="LETypes_8h.html#a201c5c12a85b5089247f931122ec9c9">le_int32</a> </td> <td class="paramname"> <em>capacity</em> </td> <td> ) </td> <td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create a data array with the given initial size. <p> This method will be called by the <code>add</code> method if there is no limit indices array. Subclasses which override this method must also call it from the overriding method to create the limit indices array.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>is the initial size of the data array.</td></tr> </table> </dl> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classLocaleRuns.html#4395fb97d931060930a1a7e46c54e4ec">add</a></dd></dl> <dl compact><dt><b><a class="el" href="stable.html#_stable003249">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p> Reimplemented from <a class="el" href="classRunArray.html#df00fbd3db17dd1a678a8d909211980b">RunArray</a>. </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="RunArrays_8h-source.html">RunArrays.h</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:54 2011 for ICU 3.6 by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address> </body> </html>