1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
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.
<p> Assumption: StartPos is inclusive and EndPos is exclusive. </p>
*/
published interface XBreakIterator: com::sun::star::uno::XInterface
{
/** Traverses specified number of characters/cells in Text from
<em>nStartPos</em> forwards.
CharacterIteratorMode can be cell based or
character based. A cell is made of more than one character.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@param nCharacterIteratorMode
A constant from CharacterIteratorMode
@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.
@param nDone
Out parameter to receive the number of cells/Unicode characters
traversed.
*/
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
<em>nStartPos</em> backwards.
CharacterIteratorMode can be cell based or
character based. A cell is made of more than one character.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@param nCharacterIteratorMode
A constant from CharacterIteratorMode
@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.
@param nDone
Out parameter to receive the number of cells/Unicode characters
traversed.
*/
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 <em>nStartPos</em> forwards.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@param nWordType
One of WordType, specifies the type of
traveling.
@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 <em>nStartPos</em> backwards.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
<p> If the previous character is a space character and
<em>nWordType</em> 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 <em>aLocale</em>
referring to the Asian character, which is then the previous
character of the space character where <em>nStartPos</em>
points to. </p>
<p> <b>Note</b> 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. </p>
@param nWordType
One of WordType, specifies the type of
traveling.
@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.
<p> If <em>nPos</em> 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 <em>bPreferForward</em> flag is used. If bPreferForward ==
`FALSE`, <em>nPos</em> is considered to be the end of the word
and we look backwards for beginning of word, otherwise
<em>nPos</em> is considered to be the start of the next word and
we look forwards for the end of the word. </p>
@param aText
The input text.
@param nPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@param nWordType
One of WordType.
@param bPreferForward
If `TRUE`, nPos should be considered the start of the next
word and search proceeds forwards.
If `FALSE`, nPos should be considered the end of the
current word, and search proceeds backwards.
@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 <em>nPos</em>.
<p> 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 spell checker
or cursor traveling. It returns 0 always.
</p>
*/
short getWordType( [in] string aText, [in] long nPos,
[in] ::com::sun::star::lang::Locale aLocale);
/** If a word starts at position <em>nPos</em>.
<p> It is possible that both of this method
and following method <em>isEndWord</em> all return
`TRUE`, since StartPos of a word is inclusive
while EndPos of a word is exclusive.
</p>
*/
boolean isBeginWord( [in] string aText, [in] long nPos,
[in] ::com::sun::star::lang::Locale aLocale,
[in] short nWordType);
/** If a word ends at position <em>nPos</em>.
*/
boolean isEndWord( [in] string aText, [in] long nPos,
[in] ::com::sun::star::lang::Locale aLocale,
[in] short nWordType);
/** Traverses in Text from <em>nStartPos</em> to the start of a
sentence.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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 <em>nStartPos</em> to the end of a
sentence.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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
<em>nStartPos</em>.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@param nMinBreakPos
Defines a minimum break position for hyphenated line break.
When the position for hyphenated line break is less than
<em>nMinBreakPos</em>, 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
com::sun::star::linguistic2::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 <em>nStartPos</em> to the beginning of
the specified script type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@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 <em>nStartPos</em> to the end of the
specified script type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@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 <em>nStartPos</em> to the next start of
the specified script type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@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 <em>nStartPos</em> to the previous start
of the specified script type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@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 <em>nPos</em>.
@param aText
The input text.
@param nPos
The index in aText.
@returns
One of ScriptType.
*/
short getScriptType( [in] string aText, [in] long nPos);
/** Traverses in Text from <em>nStartPos</em> to the beginning of
the specified character type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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 <em>nStartPos</em> to the end of the
specified character type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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 <em>nStartPos</em> to the next start of
the specified character type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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 <em>nStartPos</em> to the previous start
of the specified character type.
@param aText
The input text.
@param nStartPos
The start index in aText.
@param aLocale
The locale of the character preceding <em>nStartPos</em>.
@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 );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
