LibreOffice
LibreOffice 7.4 SDK API Reference
Loading...
Searching...
No Matches
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#ifndef __com_sun_star_i18n_XBreakIterator_idl__
20#define __com_sun_star_i18n_XBreakIterator_idl__
21
27
28
29module com { module sun { module star { module i18n {
30
31
40{
67 long nextCharacters( [in] string aText, [in] long nStartPos,
69 [in] short nCharacterIteratorMode,
70 [in] long nCount, [out] long nDone );
71
99 long previousCharacters( [in] string aText, [in] long nStartPos,
101 [in] short nCharacterIteratorMode,
102 [in] long nCount, [out] long nDone );
103
123 Boundary nextWord( [in] string aText, [in] long nStartPos,
125 [in] short nWordType);
126
164 Boundary previousWord( [in] string aText, [in] long nStartPos,
166 [in] short nWordType);
167
200 Boundary getWordBoundary( [in] string aText, [in] long nPos,
202 [in] short nWordType,
203 [in] boolean bPreferForward );
204
215 short getWordType( [in] string aText, [in] long nPos,
216 [in] ::com::sun::star::lang::Locale aLocale);
217
227 boolean isBeginWord( [in] string aText, [in] long nPos,
229 [in] short nWordType);
230
233 boolean isEndWord( [in] string aText, [in] long nPos,
235 [in] short nWordType);
236
252 long beginOfSentence( [in] string aText, [in] long nStartPos,
253 [in] ::com::sun::star::lang::Locale aLocale );
254
270 long endOfSentence( [in] string aText, [in] long nStartPos,
271 [in] ::com::sun::star::lang::Locale aLocale );
272
303 LineBreakResults getLineBreak( [in] string aText, [in] long nStartPos,
305 [in] long nMinBreakPos,
306 [in] LineBreakHyphenationOptions aHyphOptions,
307 [in] LineBreakUserOptions aUserOptions );
308
324 long beginOfScript( [in] string aText, [in] long nStartPos,
325 [in] short nScriptType );
326
342 long endOfScript( [in] string aText, [in] long nStartPos,
343 [in] short nScriptType );
344
360 long nextScript( [in] string aText, [in] long nStartPos,
361 [in] short nScriptType );
362
378 long previousScript( [in] string aText, [in] long nStartPos,
379 [in] short nScriptType );
380
392 short getScriptType( [in] string aText, [in] long nPos);
393
412 long beginOfCharBlock( [in] string aText, [in] long nStartPos,
414 [in] short nCharType );
415
434 long endOfCharBlock( [in] string aText, [in] long nStartPos,
436 [in] short nCharType );
437
456 long nextCharBlock( [in] string aText, [in] long nStartPos,
458 [in] short nCharType );
459
478 long previousCharBlock ( [in] string aText, [in] long nStartPos,
480 [in] short nCharType );
481};
482
483}; }; }; };
484
485#endif
486
487/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
contains the base routines for iteration in Unicode string.
Definition XBreakIterator.idl:40
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.
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.
short getScriptType([in] string aText, [in] long nPos)
Get the script type of the character at position nPos.
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.
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.
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 beginOfScript([in] string aText, [in] long nStartPos, [in] short nScriptType)
Traverses in Text from nStartPos to the beginning of the specified script type.
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 endOfScript([in] string aText, [in] long nStartPos, [in] short nScriptType)
Traverses in Text from nStartPos to the end of the specified script type.
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.
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.
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.
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 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.
short getWordType([in] string aText, [in] long nPos, [in] ::com::sun::star::lang::Locale aLocale)
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.
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.
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 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.
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.
base interface of all UNO interfaces
Definition XInterface.idl:48
Definition Ambiguous.idl:22
contains start and end position of a word.
Definition Boundary.idl:35
Hyphenation options passed in calls to XBreakIterator::getLineBreak().
Definition LineBreakHyphenationOptions.idl:31
Results of method XBreakIterator::getLineBreak().
Definition LineBreakResults.idl:31
Line break options passed in calls to XBreakIterator::getLineBreak().
Definition LineBreakUserOptions.idl:29
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:38