<!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: CollatorFactory 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>CollatorFactory Class Reference</h1><!-- doxytag: class="CollatorFactory" --><!-- doxytag: inherits="UObject" -->A factory, used with registerFactory, the creates multiple collators and provides display names for them.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="coll_8h-source.html">coll.h</a>></code>
<p>
<p>Inheritance diagram for CollatorFactory:
<p><center><img src="classCollatorFactory.png" usemap="#CollatorFactory_map" border="0" alt=""></center>
<map name="CollatorFactory_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,100,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,100,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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollatorFactory.html#965c8077151efec8a169dbf534315b57">~CollatorFactory</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#965c8077151efec8a169dbf534315b57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollatorFactory.html#d7a91609868c9c9da9fd76bbe51e6027">visible</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if this factory is visible. <a href="#d7a91609868c9c9da9fd76bbe51e6027"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCollator.html">Collator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollatorFactory.html#b1ba9eec8827e0432cba88fad9afc051">createCollator</a> (const <a class="el" href="classLocale.html">Locale</a> &loc)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a collator for the provided locale. <a href="#b1ba9eec8827e0432cba88fad9afc051"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollatorFactory.html#721690212a243922f1604fdbb5b93880">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &objectLocale, const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the collator for the objectLocale, localized for the displayLocale. <a href="#721690212a243922f1604fdbb5b93880"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCollatorFactory.html#47f4f598d9d27e2892b4c2bf2ad14d7e">getSupportedIDs</a> (<a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> &count, <a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an array of all the locale names directly supported by this factory. <a href="#47f4f598d9d27e2892b4c2bf2ad14d7e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A factory, used with registerFactory, the creates multiple collators and provides display names for them.
<p>
A factory supports some number of locales-- these are the locales for which it can create collators. The factory can be visible, in which case the supported locales will be enumerated by getAvailableLocales, or invisible, in which they are not. Invisible locales are still supported, they are just not listed by getAvailableLocales. <p>
If standard locale display names are sufficient, <a class="el" href="classCollator.html">Collator</a> instances can be registered using registerInstance instead. <p>
Note: if the collators are to be used from C APIs, they must be instances of <a class="el" href="classRuleBasedCollator.html">RuleBasedCollator</a>.<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001932">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="coll_8h-source.html#l00977">977</a> of file <a class="el" href="coll_8h-source.html">coll.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="965c8077151efec8a169dbf534315b57"></a><!-- doxytag: member="CollatorFactory::~CollatorFactory" ref="965c8077151efec8a169dbf534315b57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual CollatorFactory::~CollatorFactory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001972">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b1ba9eec8827e0432cba88fad9afc051"></a><!-- doxytag: member="CollatorFactory::createCollator" ref="b1ba9eec8827e0432cba88fad9afc051" args="(const Locale &loc)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCollator.html">Collator</a>* CollatorFactory::createCollator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>loc</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a collator for the provided locale.
<p>
If the locale is not supported, return NULL. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>loc</em> </td><td>the locale identifying the collator to be created. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>a new collator if the locale is supported, otherwise NULL. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001974">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="721690212a243922f1604fdbb5b93880"></a><!-- doxytag: member="CollatorFactory::getDisplayName" ref="721690212a243922f1604fdbb5b93880" args="(const Locale &objectLocale, const Locale &displayLocale, UnicodeString &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a>& CollatorFactory::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>result</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the name of the collator for the objectLocale, localized for the displayLocale.
<p>
If objectLocale is not supported, or the factory is not visible, set the result string to bogus. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectLocale</em> </td><td>the locale identifying the collator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>the locale for which the display name of the collator should be localized </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>an output parameter for the display name, set to bogus if not supported. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the display name </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001975">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="47f4f598d9d27e2892b4c2bf2ad14d7e"></a><!-- doxytag: member="CollatorFactory::getSupportedIDs" ref="47f4f598d9d27e2892b4c2bf2ad14d7e" args="(int32_t &count, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>* CollatorFactory::getSupportedIDs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> & </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an array of all the locale names directly supported by this factory.
<p>
The number of names is returned in count. This array is owned by the factory. Its contents must never change. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>output parameter for the number of locales supported by the factory </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out error code </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>a pointer to an array of count UnicodeStrings. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001976">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d7a91609868c9c9da9fd76bbe51e6027"></a><!-- doxytag: member="CollatorFactory::visible" ref="d7a91609868c9c9da9fd76bbe51e6027" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#349ef00011f20ccd1d3b424445681aa5">UBool</a> CollatorFactory::visible </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if this factory is visible.
<p>
Default is true. If not visible, the locales supported by this factory will not be listed by getAvailableLocales. <dl compact><dt><b>Returns:</b></dt><dd>true if the factory is visible. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001973">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="coll_8h-source.html">coll.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:56 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>
