<html> <head> <title>Interface XConversionDictionaryList</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="XConversionDictionaryList-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">linguistic2</a> :: </p> </td> </tr> <tr> <td class="title">interface XConversionDictionaryList</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used to manage and maintain a list of conversion dictionaries. </dd> <dd><p>The dictionaries added to the list may or may not support the ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XFlushable.html">XFlushable</a> interface. If they do those dictionaries have to be flushed upon termination of the dictionary list.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</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="#getDictionaryContainer">getDictionaryContainer</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#addNewDictionary">addNewDictionary</a></td> <td class="imsum_right">creates a new dictionary and adds it to the dictionary list. </td> </tr> <tr> <td class="imsum_left"><a href="#queryConversions">queryConversions</a></td> <td class="imsum_right">searches for entries that match the given text. </td> </tr> <tr> <td class="imsum_left"><a href="#queryMaxCharCount">queryMaxCharCount</a></td> <td class="imsum_right">returns the maximum number of characters used as left or right text in entries. </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="getDictionaryContainer" class="membertitle">getDictionaryContainer</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a></td> </tr> <tr> <td valign="top"><b>getDictionaryContainer</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the name container interface to the dictionaries in the list. <p>The interface can be used to add, remove or retrieve dictionaries from the list by specifying the name of the dictionary, and (in case of inserting) the interface to the dictionary as second parameter.</p> <p>A dictionary to be added must support the <a href="XConversionDictionary.html">XConversionDictionary</a> interface. The dictionary to be added needs not necessarily be created by this service.</p> <p>The <a href="#replaceByName">replaceByName</a> function is implemented empty since renaming of dictionaries is not allowed.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addNewDictionary" class="membertitle">addNewDictionary</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"><a href="XConversionDictionary.html">XConversionDictionary</a></td> </tr> <tr> <td valign="top"><b>addNewDictionary</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</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] short</td> <td valign="bottom"> nConversionDictionaryType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a>,<br> ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new dictionary and adds it to the dictionary list. </dd> <dd><p>The dictionary will be empty and active.</p> </dd> <dt><b>Returns</b></dt> <dd>an empty dictionary with the given name, locale and conversion type. <b>NULL</b> on failure. </dd> <dt><b>Parameter aName</b></dt> <dd>is the name of the dictionary (should be unique). </dd> <dt><b>Parameter aLocale</b></dt> <dd>defines the language of the dictionary. </dd> <dt><b>Parameter nConversionDictionaryType</b></dt> <dd>One of <a href="ConversionDictionaryType.html">ConversionDictionaryType</a> values. </dd> <dt><b>Throws</b></dt> <dd>NoSupportException when <var>nConversionDictionaryType</var> is not known by the implementation. </dd> <dt><b>Throws</b></dt> <dd>ElementExistException when a dictionary with the specified name already exists. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryConversions" class="membertitle">queryConversions</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>queryConversions</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aText,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nStartPos,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nLength,</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] short</td> <td valign="bottom"> nConversionDictionaryType,</td> </tr> <tr> <td/><td valign="top">[in] <a href="ConversionDirection.html">ConversionDirection</a></td> <td valign="bottom"> eDirection,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nTextConversionOptions )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches for entries that match the given text. </dd> <dd><p>All active dictionaries with matching locales and conversion type will be searched for entries matching the given text.</p> <p>The exact string to be looked for is the substring from the aText parameter that starts at position nStartPos and has the length nLength.</p> </dd> <dt><b>Returns</b></dt> <dd>the list of entries found. If no entry was found, it is empty. </dd> <dt><b>Parameter aText</b></dt> <dd>the text where the substring to be looked for will be taken from. </dd> <dt><b>Parameter nStartPos</b></dt> <dd>the starting pos of the substring to be looked for. </dd> <dt><b>Parameter nLength</b></dt> <dd>the length of the substring to be looked for. </dd> <dt><b>Parameter aLocale</b></dt> <dd>Locale the conversion is refered to. </dd> <dt><b>Parameter nConversionDictionaryType</b></dt> <dd>specifies the type of conversion the dictionary can be used for. It is one of <a href="ConversionDictionaryType.html">ConversionDictionaryType</a>. </dd> <dt><b>Parameter eConversionDirection</b></dt> <dd>specifies the direction of the conversion to look for. It is one of <a href="ConversionDirection.html">ConversionDirection</a>. </dd> <dt><b>Parameter nTextConversionOptions</b></dt> <dd>Combination of ::com::sun::star::<a href="../i18n/module-ix.html">i18n</a>::<a href="../i18n/TextConversionOption.html">TextConversionOption</a> values. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the nTextConversionOptions parameter is invalid for the given locale. </dd> <dt><b>Throws</b></dt> <dd>NoSupportException when <var>nConversionDictionaryType</var> is not known by the implementation, or when the locale is not supported (i.e. there are no dictionaries for that locale available). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryMaxCharCount" class="membertitle">queryMaxCharCount</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">short</td> </tr> <tr> <td valign="top"><b>queryMaxCharCount</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] short</td> <td valign="bottom"> nConversionDictionaryType,</td> </tr> <tr> <td/><td valign="top">[in] <a href="ConversionDirection.html">ConversionDirection</a></td> <td valign="bottom"> eDirection );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the maximum number of characters used as left or right text in entries. </dd> <dd><p>All active dictionaries of the specified locale and type will be looked up to get the result.</p> <p>The parameter eDirection specifies if only the left text or the right text from entries should be considered.</p> </dd> <dt><b>Parameter aLocale</b></dt> <dd>Locale the conversion is refered to. </dd> <dt><b>Parameter nConversionDictionaryType</b></dt> <dd>specifies the type of conversion dictionaries to be looked up. It is one of <a href="ConversionDictionaryType.html">ConversionDictionaryType</a>. </dd> <dt><b>Parameter eDirection</b></dt> <dd>specifies if the left text or the right text of entries will be used. </dd> <dt><b>See also</b></dt> <dd><a href="ConversionDirection.html">ConversionDirection</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4125
