<html> <head> <title>Interface XBreakIterator</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="XBreakIterator-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 XBreakIterator</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>contains the base routines for iteration in Unicode string. Iterates over characters, words, sentences and line breaks. </dd> <dd><p> Assumption: StartPos is inclusive and EndPos is exclusive. </p> </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#XBreakIterator">OfficeDev - Implementing a New Locale - XBreakIterator</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Overview_and_Using_the_API#XBreakIterator">OfficeDev - Overview and Using the API - XBreakIterator</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="#nextCharacters">nextCharacters</a></td> <td class="imsum_right">Traverses specified number of characters/cells in Text from <em>nStartPos</em> forwards. <a href="CharacterIteratorMode.html">CharacterIteratorMode</a> can be cell based or character based. A cell is made of more than one character. </td> </tr> <tr> <td class="imsum_left"><a href="#previousCharacters">previousCharacters</a></td> <td class="imsum_right">Traverses specified number of characters/cells in Text from <em>nStartPos</em> backwards. <a href="CharacterIteratorMode.html">CharacterIteratorMode</a> can be cell based or character based. A cell is made of more than one character. </td> </tr> <tr> <td class="imsum_left"><a href="#nextWord">nextWord</a></td> <td class="imsum_right">Traverses one word in Text from <em>nStartPos</em> forwards. </td> </tr> <tr> <td class="imsum_left"><a href="#previousWord">previousWord</a></td> <td class="imsum_right">Traverses one word in Text from <em>nStartPos</em> backwards. </td> </tr> <tr> <td class="imsum_left"><a href="#getWordBoundary">getWordBoundary</a></td> <td class="imsum_right">Identifies StartPos and EndPos of current word. </td> </tr> <tr> <td class="imsum_left"><a href="#getWordType">getWordType</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b> </td> </tr> <tr> <td class="imsum_left"><a href="#isBeginWord">isBeginWord</a></td> <td class="imsum_right">If a word starts at position <em>nPos</em>. </td> </tr> <tr> <td class="imsum_left"><a href="#isEndWord">isEndWord</a></td> <td class="imsum_right">If a word ends at position <em>nPos</em>. </td> </tr> <tr> <td class="imsum_left"><a href="#beginOfSentence">beginOfSentence</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the start of a sentence. </td> </tr> <tr> <td class="imsum_left"><a href="#endOfSentence">endOfSentence</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the end of a sentence. </td> </tr> <tr> <td class="imsum_left"><a href="#getLineBreak">getLineBreak</a></td> <td class="imsum_right">Calculate the line break position in the Text from the specified <em>nStartPos</em>. </td> </tr> <tr> <td class="imsum_left"><a href="#beginOfScript">beginOfScript</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the beginning of the specified script type. </td> </tr> <tr> <td class="imsum_left"><a href="#endOfScript">endOfScript</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the end of the specified script type. </td> </tr> <tr> <td class="imsum_left"><a href="#nextScript">nextScript</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the next start of the specified script type. </td> </tr> <tr> <td class="imsum_left"><a href="#previousScript">previousScript</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the previous start of the specified script type. </td> </tr> <tr> <td class="imsum_left"><a href="#getScriptType">getScriptType</a></td> <td class="imsum_right">Get the script type of the character at position <em>nPos</em>. </td> </tr> <tr> <td class="imsum_left"><a href="#beginOfCharBlock">beginOfCharBlock</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the beginning of the specified character type. </td> </tr> <tr> <td class="imsum_left"><a href="#endOfCharBlock">endOfCharBlock</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the end of the specified character type. </td> </tr> <tr> <td class="imsum_left"><a href="#nextCharBlock">nextCharBlock</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the next start of the specified character type. </td> </tr> <tr> <td class="imsum_left"><a href="#previousCharBlock">previousCharBlock</a></td> <td class="imsum_right">Traverses in Text from <em>nStartPos</em> to the previous start of the specified character type. </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="nextCharacters" class="membertitle">nextCharacters</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>nextCharacters</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] ::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"> nCharacterIteratorMode,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[out] long</td> <td valign="bottom"> nDone );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses specified number of characters/cells in Text from <em>nStartPos</em> forwards. <a href="CharacterIteratorMode.html">CharacterIteratorMode</a> can be cell based or character based. A cell is made of more than one character. </dd> <dt><b>Parameter nCount</b></dt> <dd>Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use <a href="XBreakIterator.html">XBreakIterator</a>::<a href="XBreakIterator.html#previousCharacters">previousCharacters()</a> instead. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="previousCharacters" class="membertitle">previousCharacters</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>previousCharacters</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] ::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"> nCharacterIteratorMode,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nCount,</td> </tr> <tr> <td/><td valign="top">[out] long</td> <td valign="bottom"> nDone );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses specified number of characters/cells in Text from <em>nStartPos</em> backwards. <a href="CharacterIteratorMode.html">CharacterIteratorMode</a> can be cell based or character based. A cell is made of more than one character. </dd> <dt><b>Parameter nCount</b></dt> <dd>Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use <a href="XBreakIterator.html">XBreakIterator</a>::<a href="XBreakIterator.html#nextCharacters">nextCharacters()</a> instead. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="nextWord" class="membertitle">nextWord</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="Boundary.html">Boundary</a></td> </tr> <tr> <td valign="top"><b>nextWord</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] ::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"> nWordType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses one word in Text from <em>nStartPos</em> forwards. </dd> <dt><b>Parameter nWordType</b></dt> <dd>One of <a href="WordType.html">WordType</a>, specifies the type of travelling. </dd> <dt><b>Returns</b></dt> <dd>The <a href="Boundary.html">Boundary</a> of the found word. Normally used for CTRL-Right. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="previousWord" class="membertitle">previousWord</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="Boundary.html">Boundary</a></td> </tr> <tr> <td valign="top"><b>previousWord</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] ::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"> nWordType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses one word in Text from <em>nStartPos</em> backwards. </dd> <dt><b>Parameter aLocale</b></dt> <dd>The locale of the character preceding <em>nStartPos</em>. <p> If the previous character is a space character and <em>nWordType</em> indicates spaces should be skipped, and if the first non-space character is an Asian character, then, since Asian word break needs language specific wordbreak dictionaries, the method will return -1 in <a href="Boundary.html">Boundary</a>::<a href="Boundary.html#endPos">endPos</a> and the position after the Asian character (i.e. the space character) in <a href="Boundary.html">Boundary</a>::<a href="Boundary.html#startPos">startPos</a>. The caller then has to call this method again with a correct <em>aLocale</em> referring to the Asian character, which is then the previous character of the space character where <em>nStartPos</em> points to. </p> <p> <b>Note</b> that the OpenOffice.org 1.0 / StarOffice 6.0 / StarSuite 6.0 i18n framework doesn't behave like this and mixed Western/CJK text may lead to wrong word iteration. This is fixed in later versions. </p> </dd> <dt><b>Parameter nWordType</b></dt> <dd>One of <a href="WordType.html">WordType</a>, specifies the type of travelling. </dd> <dt><b>Returns</b></dt> <dd>The <a href="Boundary.html">Boundary</a> of the found word. Normally used for CTRL-Left. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getWordBoundary" class="membertitle">getWordBoundary</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="Boundary.html">Boundary</a></td> </tr> <tr> <td valign="top"><b>getWordBoundary</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"> nPos,</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"> nWordType,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bPreferForward );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Identifies StartPos and EndPos of current word. </dd> <dd><p> If <em>nPos</em> is the boundary of a word, it is StartPos of one word and EndPos of previous word. In this situation, the outcome of the algorithm can be indeterminate. In this situation the <em>bPreferForward</em> flag is used. If bPreferForward == <b>false</b>, <em>nPos</em> is considered to be the end of the word and we look backwards for beginning of word, otherwise <em>nPos</em> is considered to be the start of the next word and we look forwards for the end of the word. </p> </dd> <dt><b>Parameter nWordType</b></dt> <dd>One of <a href="WordType.html">WordType</a>. </dd> <dt><b>Returns</b></dt> <dd>The Boundary of the current word. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getWordType" class="membertitle">getWordType</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>getWordType</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"> nPos,</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> </table> <hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>Get the <a href="WordType.html">WordType</a> of the word that starts at position <em>nPos</em>. <p> This method is mis-defined, since <a href="WordType.html">WordType</a> is not an attribute of a word, but a way to break words, like excluding or including tail spaces for spellchecker or cursor traveling. It returns 0 always. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isBeginWord" class="membertitle">isBeginWord</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>isBeginWord</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"> nPos,</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"> nWordType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>If a word starts at position <em>nPos</em>. </dd> <dd><p> It is possible that both of this method and following method <em>isEndWord</em> all return <b>true</b>, since StartPos of a word is inclusive while EndPos of a word is exclusive. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isEndWord" class="membertitle">isEndWord</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>isEndWord</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"> nPos,</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"> nWordType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>If a word ends at position <em>nPos</em>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="beginOfSentence" class="membertitle">beginOfSentence</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>beginOfSentence</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] ::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>Traverses in Text from <em>nStartPos</em> to the start of a sentence. </dd> <dt><b>Returns</b></dt> <dd>The position where the sentence starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endOfSentence" class="membertitle">endOfSentence</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>endOfSentence</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] ::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>Traverses in Text from <em>nStartPos</em> to the end of a sentence. </dd> <dt><b>Returns</b></dt> <dd>The position where the sentence ends. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLineBreak" class="membertitle">getLineBreak</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="LineBreakResults.html">LineBreakResults</a></td> </tr> <tr> <td valign="top"><b>getLineBreak</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] ::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"> nMinBreakPos,</td> </tr> <tr> <td/><td valign="top">[in] <a href="LineBreakHyphenationOptions.html">LineBreakHyphenationOptions</a></td> <td valign="bottom"> aHyphOptions,</td> </tr> <tr> <td/><td valign="top">[in] <a href="LineBreakUserOptions.html">LineBreakUserOptions</a></td> <td valign="bottom"> aUserOptions );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Calculate the line break position in the Text from the specified <em>nStartPos</em>. </dd> <dt><b>Parameter nMinBreakPos</b></dt> <dd>Defines a minimum break position for hyphenated line break. When the position for hyphenated line break is less than <em>nMinBreakPos</em>, break position in <a href="LineBreakResults.html">LineBreakResults</a> is set to -1. </dd> <dt><b>Parameter aHyphOptions</b></dt> <dd>Defines if the hyphenator is to be used. </dd> <dt><b>Parameter aUserOptions</b></dt> <dd>Defines how to handle hanging punctuations and forbidden characters at the start/end of a line. </dd> <dt><b>Returns</b></dt> <dd>The <a href="LineBreakResults.html">LineBreakResults</a> contain the break position of the line, <a href="BreakType.html">BreakType</a> and ::com::sun::star::<a href="../linguistic2/module-ix.html">linguistic2</a>::<a href="../linguistic2/XHyphenatedWord.html">XHyphenatedWord</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="beginOfScript" class="membertitle">beginOfScript</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>beginOfScript</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] short</td> <td valign="bottom"> nScriptType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the beginning of the specified script type. </dd> <dt><b>Parameter nScriptType</b></dt> <dd>One of <a href="ScriptType.html">ScriptType</a>. </dd> <dt><b>Returns</b></dt> <dd>The position where the script type starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endOfScript" class="membertitle">endOfScript</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>endOfScript</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] short</td> <td valign="bottom"> nScriptType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the end of the specified script type. </dd> <dt><b>Parameter nScriptType</b></dt> <dd>One of <a href="ScriptType.html">ScriptType</a>. </dd> <dt><b>Returns</b></dt> <dd>The position where the script type ends. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="nextScript" class="membertitle">nextScript</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>nextScript</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] short</td> <td valign="bottom"> nScriptType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the next start of the specified script type. </dd> <dt><b>Parameter nScriptType</b></dt> <dd>One of <a href="ScriptType.html">ScriptType</a>. </dd> <dt><b>Returns</b></dt> <dd>The position where the next script type starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="previousScript" class="membertitle">previousScript</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>previousScript</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] short</td> <td valign="bottom"> nScriptType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the previous start of the specified script type. </dd> <dt><b>Parameter nScriptType</b></dt> <dd>One of <a href="ScriptType.html">ScriptType</a>. </dd> <dt><b>Returns</b></dt> <dd>The position where the previous script type starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getScriptType" class="membertitle">getScriptType</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>getScriptType</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"> nPos );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Get the script type of the character at position <em>nPos</em>. </dd> <dt><b>Returns</b></dt> <dd>One of <a href="ScriptType.html">ScriptType</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="beginOfCharBlock" class="membertitle">beginOfCharBlock</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>beginOfCharBlock</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] ::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"> nCharType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the beginning of the specified character type. </dd> <dt><b>Parameter nCharType</b></dt> <dd>One of <a href="CharType.html">CharType</a> </dd> <dt><b>Returns</b></dt> <dd>The position where the character type starts </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endOfCharBlock" class="membertitle">endOfCharBlock</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>endOfCharBlock</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] ::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"> nCharType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the end of the specified character type. </dd> <dt><b>Parameter nCharType</b></dt> <dd>One of <a href="CharType.html">CharType</a> </dd> <dt><b>Returns</b></dt> <dd>The position where the character type ends. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="nextCharBlock" class="membertitle">nextCharBlock</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>nextCharBlock</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] ::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"> nCharType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the next start of the specified character type. </dd> <dt><b>Parameter nCharType</b></dt> <dd>One of <a href="CharType.html">CharType</a> </dd> <dt><b>Returns</b></dt> <dd>The position where the next character type starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="previousCharBlock" class="membertitle">previousCharBlock</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>previousCharBlock</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] ::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"> nCharType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Traverses in Text from <em>nStartPos</em> to the previous start of the specified character type. </dd> <dt><b>Parameter nCharType</b></dt> <dd>One of <a href="CharType.html">CharType</a> </dd> <dt><b>Returns</b></dt> <dd>The position where the previous character type starts. </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
>
3757
