<html> <head> <title>Interface XHyphenator</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="XHyphenator-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">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">linguistic2</a> :: </p> </td> </tr> <tr> <td class="title">interface XHyphenator</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XHyphenator</strong> ┗ <a href="XSupportedLocales.html">XSupportedLocales</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XSupportedLocales.html">XSupportedLocales</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Offers information about which languages are supported by the object. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides functionality for hyphenation of single words. </dd> <dd><P>Its three main functionalities are to provide a suitable position for breaking lines within a word, query about the existence of an alternative spelling at a specific position of a word and provide a list of possible hyphenation positions within a word.</P> <P>A hyphenation position for a word with n characters is represented by a value in the range from 0 to n-2, indicating the position of the character after which the hyphenation is done. That is, it is after the first and before the last character.</P> <P>A valid hyphenation position is a hyphenation position that fulfills all the restrictions implied by the properties MinLeading, MinTrailing and MinWordLength.</P> </dd> <dt><b>See also</b></dt> <dd><a href="LinguProperties.html">LinguProperties</a>, <a href="XSupportedLocales.html">XSupportedLocales</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="#hyphenate">hyphenate</a></td> <td class="imsum_right">tries to find a valid hyphenation position relative to the beginning of a word. </td> </tr> <tr> <td class="imsum_left"><a href="#queryAlternativeSpelling">queryAlternativeSpelling</a></td> <td class="imsum_right">checks whether hyphenation at a position in a word will result in an alternative spelling or not. </td> </tr> <tr> <td class="imsum_left"><a href="#createPossibleHyphens">createPossibleHyphens</a></td> <td class="imsum_right">returns information about all possible hyphenation positions of a word. </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="hyphenate" class="membertitle">hyphenate</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="XHyphenatedWord.html">XHyphenatedWord</a></td> </tr> <tr> <td valign="top"><b>hyphenate</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</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"> nMaxLeading,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValues.html">PropertyValues</a></td> <td valign="bottom"> aProperties )</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>tries to find a valid hyphenation position relative to the beginning of a word. </dd> <dd><P>Note: Some languages, for example arabic, are written from right to left.</P> </dd> <dt><b>Returns</b></dt> <dd>the XHyphenatedWord for the last valid hyphenation position that is less than or equal to nMaxLeading - 1. If there is no such valid hyphenation position, <b>NULL</b> is returned. </dd> <dt><b>Parameter aWord</b></dt> <dd>is the word to be hyphenated. </dd> <dt><b>Parameter aLocale</b></dt> <dd>defines the language to be used. <P>If the language is not supported, an IllegalArgumentException exception is raised.</P> </dd> <dt><b>Parameter nMaxLeading</b></dt> <dd>specifies the maximum number of characters to remain before the hyphen in the hyphenated word. <P>It has to be greater than or equal to 0.</P> </dd> <dt><b>Parameter aProperties</b></dt> <dd>provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. </dd> <dt><b>See also</b></dt> <dd><a href="XHyphenatedWord.html">XHyphenatedWord</a>, ::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="queryAlternativeSpelling" class="membertitle">queryAlternativeSpelling</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="XHyphenatedWord.html">XHyphenatedWord</a></td> </tr> <tr> <td valign="top"><b>queryAlternativeSpelling</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</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"> nIndex,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValues.html">PropertyValues</a></td> <td valign="bottom"> aProperties )</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>checks whether hyphenation at a position in a word will result in an alternative spelling or not. </dd> <dd><P>An alternative spelling position is a hyphen position where, if hyphenation is done here, the writing of the word changes. Example: "Bäcker" in German pre spelling-reform becomes "Bäkker" if hyphenation is done after the "c".</P> <P>The hyphenation position does not need to be a valid one to be an alternative spelling position.</P> </dd> <dt><b>Returns</b></dt> <dd>the information about the alternative spelling found at the specified position. Otherwise, if no alternative spelling was found, <b>NULL</b> is returned. </dd> <dt><b>Parameter aWord</b></dt> <dd>is the original word to be looked at for having an alternative spelling, if hyphenation is done at position nIndex. </dd> <dt><b>Parameter aLocale</b></dt> <dd>specifies the language to be used. <P>If the language is not supported, an IllegalArgumentException exception is raised.</P> </dd> <dt><b>Parameter nIndex</b></dt> <dd>is the position in the word to be looked at. <P>If the length of the word is n, the value of this parameter has to be in the range from 0 to n-2.</P> </dd> <dt><b>Parameter aProperties</b></dt> <dd>provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. </dd> <dt><b>See also</b></dt> <dd><a href="XHyphenatedWord.html">XHyphenatedWord</a>, ::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="createPossibleHyphens" class="membertitle">createPossibleHyphens</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="XPossibleHyphens.html">XPossibleHyphens</a></td> </tr> <tr> <td valign="top"><b>createPossibleHyphens</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aWord,</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] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValues.html">PropertyValues</a></td> <td valign="bottom"> aProperties )</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>returns information about all possible hyphenation positions of a word. </dd> <dt><b>Returns</b></dt> <dd>an <a href="XPossibleHyphens.html">XPossibleHyphens</a> for the given word and language if there are any hyphenation positions. <b>NULL</b> otherwise. </dd> <dt><b>Parameter aWord</b></dt> <dd>is the word for which information about the possible hyphenation positions is to be retrieved. </dd> <dt><b>Parameter aLocale</b></dt> <dd>defines the language of the word. <P>If the language is not supported, an IllegalArgumentException exception is raised.</P> </dd> <dt><b>Parameter aProperties</b></dt> <dd>provides property values to be used for this function call only. It is usually empty in order to use the default values supplied with the property set. </dd> <dt><b>See also</b></dt> <dd><a href="XPossibleHyphens.html">XPossibleHyphens</a>, ::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> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
4229
