<html> <head> <title>Interface XTextConversion</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="XTextConversion-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"><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">i18n</a> :: </p> </td> </tr> <tr> <td class="title">interface XTextConversion</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Method to convert text from one type to another </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</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#XTextConversion">OfficeDev - Implementing a New Locale - XTextConversion</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Overview_and_Using_the_API#XTextConversion">OfficeDev - Overview and Using the API - XTextConversion</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="#getConversions">getConversions</a></td> <td class="imsum_right">Method to search dictionaries for the conversion candidates. </td> </tr> <tr> <td class="imsum_left"><a href="#getConversion">getConversion</a></td> <td class="imsum_right">Method to search dictionaries for the conversion candidate, if there are multiple candidates, it will return first one. This is for the conversion in non-interactive mode. </td> </tr> <tr> <td class="imsum_left"><a href="#interactiveConversion">interactiveConversion</a></td> <td class="imsum_right">Method to query if the conversion type should be interactive or non-interactive mode. </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="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"><a href="TextConversionResult.html">TextConversionResult</a></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] ::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"> nTextConversionType,</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>Method to search dictionaries for the conversion candidates. </dd> <dt><b>Parameter aText</b></dt> <dd>Text string to be converted. </dd> <dt><b>Parameter nStartPos</b></dt> <dd>The start position in aText for the conversion </dd> <dt><b>Parameter nLength</b></dt> <dd>The length of the partion in aText for the conversion </dd> <dt><b>Parameter aLocal</b></dt> <dd>Locale the conversion is referring to. </dd> <dt><b>Parameter nTextConversionType</b></dt> <dd>One of <a href="TextConversionType.html">TextConversionType</a> values. </dd> <dt><b>Parameter nTextConversionOptions</b></dt> <dd>Combination of <a href="TextConversionOption.html">TextConversionOption</a> values. </dd> <dt><b>Returns</b></dt> <dd><a href="TextConversionResult.html">TextConversionResult</a> </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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getConversion" class="membertitle">getConversion</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>getConversion</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"> nTextConversionType,</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>Method to search dictionaries for the conversion candidate, if there are multiple candidates, it will return first one. This is for the conversion in non-interactive mode. </dd> <dt><b>Parameter aText</b></dt> <dd>Text string to be converted. </dd> <dt><b>Parameter nStartPos</b></dt> <dd>The start position in aText for the conversion </dd> <dt><b>Parameter nLength</b></dt> <dd>The length of the partion in aText for the conversion </dd> <dt><b>Parameter aLocal</b></dt> <dd>Locale the conversion is referring to. </dd> <dt><b>Parameter nTextConversionType</b></dt> <dd>One of <a href="TextConversionType.html">TextConversionType</a> values. </dd> <dt><b>Parameter nTextConversionOptions</b></dt> <dd>Combination of <a href="TextConversionOption.html">TextConversionOption</a> values. </dd> <dt><b>Returns</b></dt> <dd>Converted text </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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="interactiveConversion" class="membertitle">interactiveConversion</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>interactiveConversion</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"> nTextConversionType,</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>Method to query if the conversion type should be interactive or non-interactive mode. </dd> <dt><b>Parameter aLocal</b></dt> <dd>Locale the conversion is referring to. </dd> <dt><b>Parameter nTextConversionType</b></dt> <dd>One of <a href="TextConversionType.html">TextConversionType</a> values. </dd> <dt><b>Parameter nTextConversionOptions</b></dt> <dd>Combination of <a href="TextConversionOption.html">TextConversionOption</a> values. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the entry is a valid entry for the dictionary <b>false</b> otherwise. </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. </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
>
3793
