<html> <head> <title>Interface XCollator</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XCollator-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">i18n</a> :: </p> </td> </tr> <tr> <td class="title">interface XCollator</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides locale-sensitive collation algorithms for string comparison. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Implementing_a_New_Locale#XCollator">OfficeDev - Implementing a New Locale - XCollator</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Overview_and_Using_the_API#XCollator">OfficeDev - Overview and Using the API - XCollator</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#compareSubstring">compareSubstring</a></td> <td class="imsum_right">Compare 2 substrings in specific locale and algorithm. </td> </tr> <tr> <td class="imsum_left"><a href="#compareString">compareString</a></td> <td class="imsum_right">Compare 2 strings in specific locale and algorithm. </td> </tr> <tr> <td class="imsum_left"><a href="#loadDefaultCollator">loadDefaultCollator</a></td> <td class="imsum_right">Load the collator with default algorithm defined in locale data. </td> </tr> <tr> <td class="imsum_left"><a href="#loadCollatorAlgorithm">loadCollatorAlgorithm</a></td> <td class="imsum_right">Load a particular collator algorithm for the locale. </td> </tr> <tr> <td class="imsum_left"><a href="#listCollatorAlgorithms">listCollatorAlgorithms</a></td> <td class="imsum_right">List all collator algorithms for a given locale. </td> </tr> <tr> <td class="imsum_left"><a href="#loadCollatorAlgorithmWithEndUserOption">loadCollatorAlgorithmWithEndUserOption</a></td> <td class="imsum_right">Load a collator algorithm with options chosen by end user. </td> </tr> <tr> <td class="imsum_left"><a href="#listCollatorOptions">listCollatorOptions</a></td> <td class="imsum_right">List all end user collator options for a given algorithm. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="compareSubstring" class="membertitle">compareSubstring</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>compareSubstring</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aStr1,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOff1,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nLen1,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aStr2,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nOff2,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nLen2 );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Compare 2 substrings in specific locale and algorithm. </dd> <dt><b>Parameter aStr1</b></dt> <dd>First string. </dd> <dt><b>Parameter nOff1</b></dt> <dd>Offset (from 0) of the first string. </dd> <dt><b>Parameter nLen1</b></dt> <dd>Length (from offset) of the first substring. </dd> <dt><b>Parameter aStr2</b></dt> <dd>Second string </dd> <dt><b>Parameter nOff2</b></dt> <dd>Offset (from 0) of the second string. </dd> <dt><b>Parameter nLen2</b></dt> <dd>Length (from offset) of the second substring. </dd> <dt><b>Returns</b></dt> <dd>1 if the first string is greater than the second string <br/> 0 if the first string is equal to the second string <br/> -1 if the first string is less than the second string </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="compareString" class="membertitle">compareString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>compareString</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aStr1,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aStr2 );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Compare 2 strings in specific locale and algorithm. </dd> <dt><b>Parameter aStr1</b></dt> <dd>First string. </dd> <dt><b>Parameter aStr2</b></dt> <dd>Second string. </dd> <dt><b>Returns</b></dt> <dd>1 if the first string is greater than the second string <br/> 0 if the first string is equal to the second string <br/> -1 if the first string is less than the second string </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadDefaultCollator" class="membertitle">loadDefaultCollator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>loadDefaultCollator</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCollatorOptions );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Load the collator with default algorithm defined in locale data. </dd> <dt><b>Parameter aLocale</b></dt> <dd>The locale for this collator. </dd> <dt><b>Parameter nCollatorOptions</b></dt> <dd>A mask of <a href="CollatorOptions.html">CollatorOptions</a>. </dd> <dt><b>Returns</b></dt> <dd>Returns 0 when loading was successful, otherwise throws runtime exception. In fact the return value should be ignored and the exception be caught instead. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadCollatorAlgorithm" class="membertitle">loadCollatorAlgorithm</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>loadCollatorAlgorithm</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aAlgorithmName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCollatorOptions );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Load a particular collator algorithm for the locale. </dd> <dt><b>Parameter aAlgorithmName</b></dt> <dd>The algorithm to load. </dd> <dt><b>Parameter aLocale</b></dt> <dd>The locale for this collator. </dd> <dt><b>Parameter nCollatorOptions</b></dt> <dd>A mask of <a href="CollatorOptions.html">CollatorOptions</a>. </dd> <dt><b>Returns</b></dt> <dd>Returns 0 when loading was successful, otherwise throws runtime exception. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="listCollatorAlgorithms" class="membertitle">listCollatorAlgorithms</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>listCollatorAlgorithms</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>List all collator algorithms for a given locale. </dd> <dt><b>Parameter aLocale</b></dt> <dd>The locale for which to list algorithms. </dd> <dt><b>Returns</b></dt> <dd>A sequence of algorithm names. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="loadCollatorAlgorithmWithEndUserOption" class="membertitle">loadCollatorAlgorithmWithEndUserOption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>loadCollatorAlgorithmWithEndUserOption</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aAlgorithmName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> aLocale,</td> </tr> <tr> <td/><td valign="top">[in] sequence< long ></td> <td valign="bottom"> aCollatorOptions );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Load a collator algorithm with options chosen by end user. </dd> <dt><b>Parameter aAlgorithmName</b></dt> <dd>The algorithm name to load. </dd> <dt><b>Parameter aLocale</b></dt> <dd>The locale for this collator. </dd> <dt><b>Parameter aCollatorOptions</b></dt> <dd>A sequence of end user collator options like those returned by <a href="XCollator.html">XCollator</a>::<a href="XCollator.html#listCollatorOptions">listCollatorOptions()</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="listCollatorOptions" class="membertitle">listCollatorOptions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< long ></td> </tr> <tr> <td valign="top"><b>listCollatorOptions</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aAlgorithmName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>List all end user collator options for a given algorithm. </dd> <dt><b>Parameter aAlgorithmName</b></dt> <dd>The algorithm name for this collator. </dd> <dt><b>Returns</b></dt> <dd>An array of end user options available for the algorithm. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
