| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
contains the base routines for iteration in Unicode string. More...
import "BreakIterator.idl";
 
  
| Additional Inherited Members | |
| Public Member Functions inherited from XBreakIterator | |
| long | nextCharacters ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharacterIteratorMode, [in] long nCount, [out] long nDone) | 
| Traverses specified number of characters/cells in Text from nStartPos forwards. | |
| long | previousCharacters ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharacterIteratorMode, [in] long nCount, [out] long nDone) | 
| Traverses specified number of characters/cells in Text from nStartPos backwards. | |
| Boundary | nextWord ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType) | 
| Traverses one word in Text from nStartPos forwards. | |
| Boundary | previousWord ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType) | 
| Traverses one word in Text from nStartPos backwards. | |
| Boundary | getWordBoundary ([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType, [in] boolean bPreferForward) | 
| Identifies StartPos and EndPos of current word. | |
| short | getWordType ([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale) | 
| boolean | isBeginWord ([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType) | 
| If a word starts at position nPos. | |
| boolean | isEndWord ([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType) | 
| If a word ends at position nPos. | |
| long | beginOfSentence ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale) | 
| Traverses in Text from nStartPos to the start of a sentence. | |
| long | endOfSentence ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale) | 
| Traverses in Text from nStartPos to the end of a sentence. | |
| LineBreakResults | getLineBreak ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] long nMinBreakPos, [in] LineBreakHyphenationOptions aHyphOptions, [in] LineBreakUserOptions aUserOptions) | 
| Calculate the line break position in the Text from the specified nStartPos. | |
| long | beginOfScript ([in] string aText, [in] long nStartPos, [in] short nScriptType) | 
| Traverses in Text from nStartPos to the beginning of the specified script type. | |
| long | endOfScript ([in] string aText, [in] long nStartPos, [in] short nScriptType) | 
| Traverses in Text from nStartPos to the end of the specified script type. | |
| long | nextScript ([in] string aText, [in] long nStartPos, [in] short nScriptType) | 
| Traverses in Text from nStartPos to the next start of the specified script type. | |
| long | previousScript ([in] string aText, [in] long nStartPos, [in] short nScriptType) | 
| Traverses in Text from nStartPos to the previous start of the specified script type. | |
| short | getScriptType ([in] string aText, [in] long nPos) | 
| Get the script type of the character at position nPos. | |
| long | beginOfCharBlock ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharType) | 
| Traverses in Text from nStartPos to the beginning of the specified character type. | |
| long | endOfCharBlock ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharType) | 
| Traverses in Text from nStartPos to the end of the specified character type. | |
| long | nextCharBlock ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharType) | 
| Traverses in Text from nStartPos to the next start of the specified character type. | |
| long | previousCharBlock ([in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharType) | 
| Traverses in Text from nStartPos to the previous start of the specified character type. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
contains the base routines for iteration in Unicode string.
Iterates over characters, words, sentences and line breaks.
It also contains a BreakIterator service for Asian languages.