LibreOffice LibreOffice 26.2 SDK API Reference

List of all members
BreakIterator Service Referencepublished

contains the base routines for iteration in Unicode string. More...

`import"BreakIterator.idl";`

Inheritance diagram for BreakIterator:

## 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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
long | beginOfScript ([in] string aText, [in] long nStartPos, [in] short nScriptType)
| Traverses in Text from nStartPos to the beginning of the specified script type. More...
long | endOfScript ([in] string aText, [in] long nStartPos, [in] short nScriptType)
| Traverses in Text from nStartPos to the end of the specified script type. More...
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. More...
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. More...
short | getScriptType ([in] string aText, [in] long nPos)
| Get the script type of the character at position nPos. More...
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. More...
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. More...
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. More...
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. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...

## Detailed Description

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.

The documentation for this service was generated from the following file:

- com/sun/star/i18n/BreakIterator.idl