LibreOffice
LibreOffice 4.3 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 {
51  long nextCharacters( [in] string aText, [in] long nStartPos,
52  [in] ::com::sun::star::lang::Locale aLocale,
53  [in] short nCharacterIteratorMode,
54  [in] long nCount, [out] long nDone );
55 
66  long previousCharacters( [in] string aText, [in] long nStartPos,
67  [in] ::com::sun::star::lang::Locale aLocale,
68  [in] short nCharacterIteratorMode,
69  [in] long nCount, [out] long nDone );
70 
81  Boundary nextWord( [in] string aText, [in] long nStartPos,
82  [in] ::com::sun::star::lang::Locale aLocale,
83  [in] short nWordType);
84 
116  Boundary previousWord( [in] string aText, [in] long nStartPos,
117  [in] ::com::sun::star::lang::Locale aLocale,
118  [in] short nWordType);
119 
137  Boundary getWordBoundary( [in] string aText, [in] long nPos,
138  [in] ::com::sun::star::lang::Locale aLocale,
139  [in] short nWordType,
140  [in] boolean bPreferForward );
141 
152  short getWordType( [in] string aText, [in] long nPos,
153  [in] ::com::sun::star::lang::Locale aLocale);
154 
164  boolean isBeginWord( [in] string aText, [in] long nPos,
165  [in] ::com::sun::star::lang::Locale aLocale,
166  [in] short nWordType);
167 
170  boolean isEndWord( [in] string aText, [in] long nPos,
171  [in] ::com::sun::star::lang::Locale aLocale,
172  [in] short nWordType);
173 
180  long beginOfSentence( [in] string aText, [in] long nStartPos,
181  [in] ::com::sun::star::lang::Locale aLocale );
182 
189  long endOfSentence( [in] string aText, [in] long nStartPos,
190  [in] ::com::sun::star::lang::Locale aLocale );
191 
213  LineBreakResults getLineBreak( [in] string aText, [in] long nStartPos,
214  [in] ::com::sun::star::lang::Locale aLocale,
215  [in] long nMinBreakPos,
216  [in] LineBreakHyphenationOptions aHyphOptions,
217  [in] LineBreakUserOptions aUserOptions );
218 
228  long beginOfScript( [in] string aText, [in] long nStartPos,
229  [in] short nScriptType );
230 
240  long endOfScript( [in] string aText, [in] long nStartPos,
241  [in] short nScriptType );
242 
252  long nextScript( [in] string aText, [in] long nStartPos,
253  [in] short nScriptType );
254 
264  long previousScript( [in] string aText, [in] long nStartPos,
265  [in] short nScriptType );
266 
272  short getScriptType( [in] string aText, [in] long nPos);
273 
283  long beginOfCharBlock( [in] string aText, [in] long nStartPos,
284  [in] ::com::sun::star::lang::Locale aLocale,
285  [in] short nCharType );
286 
296  long endOfCharBlock( [in] string aText, [in] long nStartPos,
297  [in] ::com::sun::star::lang::Locale aLocale,
298  [in] short nCharType );
299 
309  long nextCharBlock( [in] string aText, [in] long nStartPos,
310  [in] ::com::sun::star::lang::Locale aLocale,
311  [in] short nCharType );
312 
322  long previousCharBlock ( [in] string aText, [in] long nStartPos,
323  [in] ::com::sun::star::lang::Locale aLocale,
324  [in] short nCharType );
325 };
326 
327 }; }; }; };
328 
329 #endif
330 
331 /* 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
– idl definition –
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:52
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