LibreOffice LibreOffice 25.2 SDK API Reference

XBreakIterator.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module i18n {
22
23
31published interface XBreakIterator: com::sun::star::uno::XInterface
32{
59 long nextCharacters( [in] string aText, [in] long nStartPos,
60 [in] ::com::sun::star::lang::Locale aLocale,
61 [in] short nCharacterIteratorMode,
62 [in] long nCount, [out] long nDone );
63
91 long previousCharacters( [in] string aText, [in] long nStartPos,
92 [in] ::com::sun::star::lang::Locale aLocale,
93 [in] short nCharacterIteratorMode,
94 [in] long nCount, [out] long nDone );
95
115 Boundary nextWord( [in] string aText, [in] long nStartPos,
116 [in] ::com::sun::star::lang::Locale aLocale,
117 [in] short nWordType);
118
156 Boundary previousWord( [in] string aText, [in] long nStartPos,
157 [in] ::com::sun::star::lang::Locale aLocale,
158 [in] short nWordType);
159
192 Boundary getWordBoundary( [in] string aText, [in] long nPos,
193 [in] ::com::sun::star::lang::Locale aLocale,
194 [in] short nWordType,
195 [in] boolean bPreferForward );
196
207 short getWordType( [in] string aText, [in] long nPos,
208 [in] ::com::sun::star::lang::Locale aLocale);
209
219 boolean isBeginWord( [in] string aText, [in] long nPos,
220 [in] ::com::sun::star::lang::Locale aLocale,
221 [in] short nWordType);
222
225 boolean isEndWord( [in] string aText, [in] long nPos,
226 [in] ::com::sun::star::lang::Locale aLocale,
227 [in] short nWordType);
228
244 long beginOfSentence( [in] string aText, [in] long nStartPos,
245 [in] ::com::sun::star::lang::Locale aLocale );
246
262 long endOfSentence( [in] string aText, [in] long nStartPos,
263 [in] ::com::sun::star::lang::Locale aLocale );
264
295 LineBreakResults getLineBreak( [in] string aText, [in] long nStartPos,
296 [in] ::com::sun::star::lang::Locale aLocale,
297 [in] long nMinBreakPos,
298 [in] LineBreakHyphenationOptions aHyphOptions,
299 [in] LineBreakUserOptions aUserOptions );
300
316 long beginOfScript( [in] string aText, [in] long nStartPos,
317 [in] short nScriptType );
318
334 long endOfScript( [in] string aText, [in] long nStartPos,
335 [in] short nScriptType );
336
352 long nextScript( [in] string aText, [in] long nStartPos,
353 [in] short nScriptType );
354
370 long previousScript( [in] string aText, [in] long nStartPos,
371 [in] short nScriptType );
372
384 short getScriptType( [in] string aText, [in] long nPos);
385
404 long beginOfCharBlock( [in] string aText, [in] long nStartPos,
405 [in] ::com::sun::star::lang::Locale aLocale,
406 [in] short nCharType );
407
426 long endOfCharBlock( [in] string aText, [in] long nStartPos,
427 [in] ::com::sun::star::lang::Locale aLocale,
428 [in] short nCharType );
429
448 long nextCharBlock( [in] string aText, [in] long nStartPos,
449 [in] ::com::sun::star::lang::Locale aLocale,
450 [in] short nCharType );
451
470 long previousCharBlock ( [in] string aText, [in] long nStartPos,
471 [in] ::com::sun::star::lang::Locale aLocale,
472 [in] short nCharType );
473};
474
475}; }; }; };
476
477/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::i18n::XBreakIterator
contains the base routines for iteration in Unicode string.
Definition: XBreakIterator.idl:32
com::sun::star::i18n::XBreakIterator::previousScript
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.
com::sun::star::i18n::XBreakIterator::beginOfCharBlock
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.
com::sun::star::i18n::XBreakIterator::getScriptType
short getScriptType([in] string aText, [in] long nPos)
Get the script type of the character at position nPos.
com::sun::star::i18n::XBreakIterator::nextWord
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.
com::sun::star::i18n::XBreakIterator::previousCharacters
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.
com::sun::star::i18n::XBreakIterator::endOfCharBlock
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.
com::sun::star::i18n::XBreakIterator::beginOfScript
long beginOfScript([in] string aText, [in] long nStartPos, [in] short nScriptType)
Traverses in Text from nStartPos to the beginning of the specified script type.
com::sun::star::i18n::XBreakIterator::nextCharacters
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.
com::sun::star::i18n::XBreakIterator::endOfScript
long endOfScript([in] string aText, [in] long nStartPos, [in] short nScriptType)
Traverses in Text from nStartPos to the end of the specified script type.
com::sun::star::i18n::XBreakIterator::getLineBreak
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.
com::sun::star::i18n::XBreakIterator::getWordBoundary
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.
com::sun::star::i18n::XBreakIterator::endOfSentence
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.
com::sun::star::i18n::XBreakIterator::nextScript
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.
com::sun::star::i18n::XBreakIterator::nextCharBlock
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.
com::sun::star::i18n::XBreakIterator::getWordType
short getWordType([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale)
com::sun::star::i18n::XBreakIterator::previousWord
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.
com::sun::star::i18n::XBreakIterator::beginOfSentence
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.
com::sun::star::i18n::XBreakIterator::isEndWord
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.
com::sun::star::i18n::XBreakIterator::previousCharBlock
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.
com::sun::star::i18n::XBreakIterator::isBeginWord
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.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::i18n::Boundary
contains start and end position of a word.
Definition: Boundary.idl:33
com::sun::star::i18n::LineBreakHyphenationOptions
Hyphenation options passed in calls to XBreakIterator::getLineBreak().
Definition: LineBreakHyphenationOptions.idl:27
com::sun::star::i18n::LineBreakResults
Results of method XBreakIterator::getLineBreak().
Definition: LineBreakResults.idl:27
com::sun::star::i18n::LineBreakUserOptions
Line break options passed in calls to XBreakIterator::getLineBreak().
Definition: LineBreakUserOptions.idl:27
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34