LibreOffice
LibreOffice 6.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 #ifndef __com_sun_star_i18n_XBreakIterator_idl__
20 #define __com_sun_star_i18n_XBreakIterator_idl__
21 
27 
28 
29 module com { module sun { module star { module i18n {
30 
31 
40 {
67  long nextCharacters( [in] string aText, [in] long nStartPos,
68  [in] ::com::sun::star::lang::Locale aLocale,
69  [in] short nCharacterIteratorMode,
70  [in] long nCount, [out] long nDone );
71 
99  long previousCharacters( [in] string aText, [in] long nStartPos,
100  [in] ::com::sun::star::lang::Locale aLocale,
101  [in] short nCharacterIteratorMode,
102  [in] long nCount, [out] long nDone );
103 
123  Boundary nextWord( [in] string aText, [in] long nStartPos,
124  [in] ::com::sun::star::lang::Locale aLocale,
125  [in] short nWordType);
126 
164  Boundary previousWord( [in] string aText, [in] long nStartPos,
165  [in] ::com::sun::star::lang::Locale aLocale,
166  [in] short nWordType);
167 
200  Boundary getWordBoundary( [in] string aText, [in] long nPos,
201  [in] ::com::sun::star::lang::Locale aLocale,
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,
228  [in] ::com::sun::star::lang::Locale aLocale,
229  [in] short nWordType);
230 
233  boolean isEndWord( [in] string aText, [in] long nPos,
234  [in] ::com::sun::star::lang::Locale aLocale,
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,
304  [in] ::com::sun::star::lang::Locale aLocale,
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,
413  [in] ::com::sun::star::lang::Locale aLocale,
414  [in] short nCharType );
415 
434  long endOfCharBlock( [in] string aText, [in] long nStartPos,
435  [in] ::com::sun::star::lang::Locale aLocale,
436  [in] short nCharType );
437 
456  long nextCharBlock( [in] string aText, [in] long nStartPos,
457  [in] ::com::sun::star::lang::Locale aLocale,
458  [in] short nCharType );
459 
478  long previousCharBlock ( [in] string aText, [in] long nStartPos,
479  [in] ::com::sun::star::lang::Locale aLocale,
480  [in] short nCharType );
481 };
482 
483 }; }; }; };
484 
485 #endif
486 
487 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Hyphenation options passed in calls to XBreakIterator::getLineBreak().
Definition: LineBreakHyphenationOptions.idl:30
Results of method XBreakIterator::getLineBreak().
Definition: LineBreakResults.idl:30
Line break options passed in calls to XBreakIterator::getLineBreak().
Definition: LineBreakUserOptions.idl:28
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:47
contains the base routines for iteration in Unicode string.
Definition: XBreakIterator.idl:39
contains start and end position of a word.
Definition: Boundary.idl:34
base interface of all UNO interfaces
Definition: XInterface.idl:47