Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: i18n ::

interface XBreakIterator

Base Interface
com::sun::star::uno::XInterface

Description
contains the base routines for iteration in Unicode string. Iterates over Characters, Words, Sentences and Linebreaks.

There also exists a specific BreakIterator for asian languages

Assumption - StartPos is inclusive and EndPos is exclusive.



Known Services which Export this Interface

com::sun::star::i18n::zh_CNBreakIterator contains the chinese specific routines for iteration in Unicode string. It is derived from the base XBreakIterator , which contains all the base routines. Iterates over Characters, Words, Sentences and Linebreaks.
com::sun::star::i18n::BreakIterator contains the base routines for iteration in Unicode string. Iterates over Characters, Words, Sentences and Linebreaks.
com::sun::star::i18n::CJKBreakIterator contains the CJK specific routines for iteration in Unicode string. Is derived from the base XBreakIterator , which contains all the base routines. This is the base for the specific CJK-Iterators, these are the Japanese and traditional/simplified Chinese. Iterates over Characters, Words, Sentences and Linebreaks.
com::sun::star::i18n::zh_TWBreakIterator contains the chinese (taiwan) specific routines for iteration in Unicode string. It is derived from the base XBreakIterator , which contains all the base routines. Iterates over Characters, Words, Sentences and Linebreaks.
com::sun::star::i18n::ja_JPBreakIterator contains the japanese specific routines for iteration in Unicode string. Is derived from the base XBreakIterator , which contains all the base routines. Iterates over Characters, Words, Sentences and Linebreaks.

Methods' Summary

nextCharacters Traverses specfied number of characters in Text from the StartPos to the right. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character.
previousCharacters Traverses specfied number of characters in Text from the StartPos to the left. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character.
nextWord Traverses one word in Text from the StartPos to the right. The WordType specify the type of travelling.
previousWord Traverses one word in Text from the StartPos to the left. The WordType specify the type of travelling.
getWordBoundary identifies StartPos and EndPos of current word. If nPos 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 sitution, bPreferForward flag is used, if bPreferForward == 0, nPos is considered end of word and looks for beginning of word on left otherwise nPos is considered beginning of next word and looks right for end of the word.
getWordType
isBeginWord
isEndWord
beginOfSentence Traverses in Text from the StartPos to the start of a sentence.
endOfSentence Traverses in Text from the StartPos to the end of a sentence.
getLineBreak calculate the linebreak position in the Text from the specified StartPos. LineBreakHyphenationOptions defines if the hyphenator is to be used. The LineBreakUserOptions defines, how to handle hanging punctuations, the forbidden character at the start/end of a line.
beginOfScript
endOfScript
nextScript
previousScript
getScriptType
beginOfCharBlock Traverses in Text from the StartPos to the beginning of the specified character type.
endOfCharBlock Traverses in Text from the StartPos to the end of the specified character type.
nextCharBlock Traverses in Text from the StartPos to the next start of the specified character type.
previousCharBlock Traverses in Text from the StartPos to the previous start of the specified character type.

Methods' Details

nextCharacters
 
long
nextCharacters(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale rLocale,
[ in ] short nCharacterIteratorMode,
[ in ] long nCount,
[ out ] long nDone );

Description
Traverses specfied number of characters in Text from the StartPos to the right. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character.
previousCharacters
 
long
previousCharacters(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short nCharacterIteratorMode,
[ in ] long nCount,
[ out ] long nDone );

Description
Traverses specfied number of characters in Text from the StartPos to the left. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character.
nextWord
 
com::sun::star::i18n::Boundary
nextWord(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short WordType );

Description
Traverses one word in Text from the StartPos to the right. The WordType specify the type of travelling.
Returns
the Boundary of the found word. Normally used for the CTRL-Right.
previousWord
 
com::sun::star::i18n::Boundary
previousWord(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short WordType );

Description
Traverses one word in Text from the StartPos to the left. The WordType specify the type of travelling.
Returns
the Boundary of the found word. Normally used for the CTRL-Right.
getWordBoundary
 
com::sun::star::i18n::Boundary
getWordBoundary(
[ in ] string Text,
[ in ] long nPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short WordType,
[ in ] boolean bPreferForward );

Description
identifies StartPos and EndPos of current word. If nPos 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 sitution, bPreferForward flag is used, if bPreferForward == 0, nPos is considered end of word and looks for beginning of word on left otherwise nPos is considered beginning of next word and looks right for end of the word.
getWordType
 
short
getWordType(
[ in ] string Text,
[ in ] long nPos,
[ in ] com::sun::star::lang::Locale nLocale );

Returns
the kind of word that starts at the specified position.
isBeginWord
 
boolean
isBeginWord(
[ in ] string Text,
[ in ] long nPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short WordType );

Returns
true if at the specified position starts a word
isEndWord
 
boolean
isEndWord(
[ in ] string Text,
[ in ] long nPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short WordType );

Returns
true if at the specified position ends a word
beginOfSentence
 
long
beginOfSentence(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale );

Description
Traverses in Text from the StartPos to the start of a sentence.
Returns
the position where the sentence starts
endOfSentence
 
long
endOfSentence(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale );

Description
Traverses in Text from the StartPos to the end of a sentence.
Returns
the position where the sentence ends
getLineBreak
 
com::sun::star::i18n::LineBreakResults
getLineBreak(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] long nMinBreakPos,
[ in ] com::sun::star::i18n::LineBreakHyphenationOptions hOptions,
[ in ] com::sun::star::i18n::LineBreakUserOptions bOptions );

Description
calculate the linebreak position in the Text from the specified StartPos. LineBreakHyphenationOptions defines if the hyphenator is to be used. The LineBreakUserOptions defines, how to handle hanging punctuations, the forbidden character at the start/end of a line.
Returns
LineBreakResults , which contains the break position of the word and which kind of break it is.
beginOfScript
 
long
beginOfScript(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] short ScriptType );

Returns
the position where the specified skipt starts.
endOfScript
 
long
endOfScript(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] short ScriptType );

Returns
the position where the specified skipt ends.
nextScript
 
long
nextScript(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] short ScriptType );

Returns
the position where the next specified skipt starts.
previousScript
 
long
previousScript(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] short ScriptType );

Returns
the position where the previous specified skipt starts.
getScriptType
 
short
getScriptType(
[ in ] string Text,
[ in ] long nPos );

Returns
the scipts type of the current position.
beginOfCharBlock
 
long
beginOfCharBlock(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short CharType );

Description
Traverses in Text from the StartPos to the beginning of the specified character type.
Returns
the position where the character type starts
endOfCharBlock
 
long
endOfCharBlock(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short CharType );

Description
Traverses in Text from the StartPos to the end of the specified character type.
Returns
the position where the character type ends
nextCharBlock
 
long
nextCharBlock(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short CharType );

Description
Traverses in Text from the StartPos to the next start of the specified character type.
Returns
the position where the next character type starts
previousCharBlock
 
long
previousCharBlock(
[ in ] string Text,
[ in ] long nStartPos,
[ in ] com::sun::star::lang::Locale nLocale,
[ in ] short CharType );

Description
Traverses in Text from the StartPos to the previous start of the specified character type.
Returns
the position where the previous character type starts

Top of Page