/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_i18n_XBreakIterator_idl__ #define __com_sun_star_i18n_XBreakIterator_idl__ #ifndef __com_sun_star_lang_Locale_idl__ #include #endif #ifndef __com_sun_star_i18n_LineBreakUserOptions_idl__ #include #endif #ifndef __com_sun_star_i18n_LineBreakHyphenationOptions_idl__ #include #endif #ifndef __com_sun_star_i18n_LineBreakResults_idl__ #include #endif #ifndef __com_sun_star_i18n_Boundary_idl__ #include #endif //============================================================================ module com { module sun { module star { module i18n { //============================================================================ /** contains the base routines for iteration in Unicode string. Iterates over characters, words, sentences and line breaks.

Assumption: StartPos is inclusive and EndPos is exclusive.

*/ published interface XBreakIterator: com::sun::star::uno::XInterface { //------------------------------------------------------------------------ /** Traverses specified number of characters/cells in Text from nStartPos forwards. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use XBreakIterator::previousCharacters() instead. */ 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 backwards. CharacterIteratorMode can be cell based or character based. A cell is made of more than one character. @param nCount Number of characters to traverse, it should not be less than 0. If you want to traverse in the opposite direction use XBreakIterator::nextCharacters() instead. */ 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 one word in Text from nStartPos forwards. @param nWordType One of WordType, specifies the type of travelling. @returns The Boundary of the found word. Normally used for CTRL-Right. */ 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 backwards. @param aLocale The locale of the character preceding nStartPos.

If the previous character is a space character and nWordType 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 Boundary::endPos and the position after the Asian character (i.e. the space character) in Boundary::startPos. The caller then has to call this method again with a correct aLocale referring to the Asian character, which is then the previous character of the space character where nStartPos points to.

Note 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.

@param nWordType One of WordType, specifies the type of travelling. @returns The Boundary of the found word. Normally used for CTRL-Left. */ Boundary previousWord( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType); //------------------------------------------------------------------------ /** 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 situation the bPreferForward flag is used. If bPreferForward == , nPos is considered to be the end of the word and we look backwards for beginning of word, otherwise nPos is considered to be the start of the next word and we look forwards for the end of the word.

@param nWordType One of WordType. @returns The Boundary of the current word. */ Boundary getWordBoundary( [in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType, [in] boolean bPreferForward ); //------------------------------------------------------------------------ /** @deprecated Get the WordType of the word that starts at position nPos.

This method is mis-defined, since WordType 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.

*/ short getWordType( [in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale); //------------------------------------------------------------------------ /** If a word starts at position nPos.

It is possible that both of this method and following method isEndWord all return , since StartPos of a word is inclusive while EndPos of a word is exclusive.

*/ boolean isBeginWord( [in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType); //------------------------------------------------------------------------ /** If a word ends at position nPos. */ boolean isEndWord( [in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nWordType); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the start of a sentence. @returns The position where the sentence starts. */ long beginOfSentence( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale ); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the end of a sentence. @returns The position where the sentence ends. */ long endOfSentence( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale ); //------------------------------------------------------------------------ /** Calculate the line break position in the Text from the specified nStartPos. @param nMinBreakPos Defines a minimum break position for hyphenated line break. When the position for hyphenated line break is less than nMinBreakPos, break position in LineBreakResults is set to -1. @param aHyphOptions Defines if the hyphenator is to be used. @param aUserOptions Defines how to handle hanging punctuations and forbidden characters at the start/end of a line. @returns The LineBreakResults contain the break position of the line, BreakType and XHyphenatedWord */ LineBreakResults getLineBreak( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] long nMinBreakPos, [in] LineBreakHyphenationOptions aHyphOptions, [in] LineBreakUserOptions aUserOptions ); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the beginning of the specified script type. @param nScriptType One of ScriptType. @returns The position where the script type starts. */ long beginOfScript( [in] string aText, [in] long nStartPos, [in] short nScriptType ); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the end of the specified script type. @param nScriptType One of ScriptType. @returns The position where the script type ends. */ long endOfScript( [in] string aText, [in] long nStartPos, [in] short nScriptType ); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the next start of the specified script type. @param nScriptType One of ScriptType. @returns The position where the next script type starts. */ long nextScript( [in] string aText, [in] long nStartPos, [in] short nScriptType ); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the previous start of the specified script type. @param nScriptType One of ScriptType. @returns The position where the previous script type starts. */ long previousScript( [in] string aText, [in] long nStartPos, [in] short nScriptType ); //------------------------------------------------------------------------ /** Get the script type of the character at position nPos. @returns One of ScriptType. */ short getScriptType( [in] string aText, [in] long nPos); //------------------------------------------------------------------------ /** Traverses in Text from nStartPos to the beginning of the specified character type. @param nCharType One of CharType @returns The position where the character type starts */ 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 end of the specified character type. @param nCharType One of CharType @returns The position where the character type ends. */ 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 next start of the specified character type. @param nCharType One of CharType @returns The position where the next character type starts. */ 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 previous start of the specified character type. @param nCharType One of CharType @returns The position where the previous character type starts. */ long previousCharBlock ( [in] string aText, [in] long nStartPos, [in] ::com::sun::star::lang::Locale aLocale, [in] short nCharType ); }; //============================================================================ }; }; }; }; #endif