<html> <head> <title>Interface XConversionDictionary</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="XConversionDictionary-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 XConversionDictionary</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Allows the user to access a conversion dictionary. </dd> <dd><p>The dictionary consists of entries (pairs) of the form ( aLeftText, aRightText ). Those pairs can be added and removed. Also it can be looked for all entries where the left text or the right text matches a given text. Thus it can be used for conversions in both directions.</p> <p>Restrictions to what has to be the left and right text are usually given by specific services implementing this interface.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="ConversionDictionary.html">ConversionDictionary</a>, <a href="HangulHanjaConversionDictionary.html">HangulHanjaConversionDictionary</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="#getName">getName</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getLocale">getLocale</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getConversionType">getConversionType</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setActive">setActive</a></td> <td class="imsum_right">specifies whether the dictionary should be used or not . </td> </tr> <tr> <td class="imsum_left"><a href="#isActive">isActive</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#clear">clear</a></td> <td class="imsum_right">removes all entries from the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#getConversions">getConversions</a></td> <td class="imsum_right">searches for entries or conversions that match the given text. </td> </tr> <tr> <td class="imsum_left"><a href="#addEntry">addEntry</a></td> <td class="imsum_right">is used to add a conversion pair to the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#removeEntry">removeEntry</a></td> <td class="imsum_right">removes a conversion pair from the dictionary. </td> </tr> <tr> <td class="imsum_left"><a href="#getMaxCharCount">getMaxCharCount</a></td> <td class="imsum_right">returns the maximum number of characters used as left or right text in entries. </td> </tr> <tr> <td class="imsum_left"><a href="#getConversionEntries">getConversionEntries</a></td> <td class="imsum_right"> </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="getName" class="membertitle">getName</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">string</td> </tr> <tr> <td valign="top"><b>getName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the name of the dictionary. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocale" class="membertitle">getLocale</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="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>getLocale</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the language supported by the dictionary. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getConversionType" class="membertitle">getConversionType</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>getConversionType</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the conversion type supported by the dictionary. </dd> <dt><b>See also</b></dt> <dd><a href="ConversionDictionaryType.html">ConversionDictionaryType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setActive" class="membertitle">setActive</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>setActive</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bActivate );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the dictionary should be used or not . </dd> <dt><b>Parameter bAcvtivate</b></dt> <dd><b>true</b> if the dictionary should be used, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isActive" class="membertitle">isActive</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">boolean</td> </tr> <tr> <td valign="top"><b>isActive</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the dictionary is active, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="clear" class="membertitle">clear</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>clear</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes all entries from the dictionary. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getConversions" class="membertitle">getConversions</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>getConversions</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] <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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches for entries or conversions that match the given text. </dd> <dd><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 conversions found for the supplied text. If no nothing 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. Depending on the conversion direction parameter it specifies either the left text or the right text to look for. </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 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 locale is not supported by the dictionary or if nTextConversionOptions is invalid for the given locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addEntry" class="membertitle">addEntry</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>addEntry</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLeftText,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aRightText )</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="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is used to add a conversion pair to the dictionary. </dd> <dt><b>Parameter aLeftText</b></dt> <dd>the left text of the pair to be added. </dd> <dt><b>Parameter aRightText</b></dt> <dd>the right text of the pair to be added. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the arguments are invalid. For example if the specifications defined by the service implementing this object are not met. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::ElementExistException if such an entry already exists. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeEntry" class="membertitle">removeEntry</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>removeEntry</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLeftText,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aRightText )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a conversion pair from the dictionary. </dd> <dt><b>Parameter aLeftText</b></dt> <dd>the left text of the pair to be removed. </dd> <dt><b>Parameter aRightText</b></dt> <dd>the right text of the pair to be removed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::container::NoSuchElementException if there is no such entry. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMaxCharCount" class="membertitle">getMaxCharCount</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>getMaxCharCount</b>(</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> <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> <tr> <td class="imdetail"><a name="getConversionEntries" class="membertitle">getConversionEntries</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>getConversionEntries</b>(</td> <td valign="top">[in] <a href="ConversionDirection.html">ConversionDirection</a></td> <td valign="bottom"> eDirection );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a list of all left or right parts of the dictionaries entries. </dd> <dt><b>Parameter eDirection</b></dt> <dd>specifies if all left or all right parts of the entries should be returned. </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
>
4123
