xref: /aoo4110/main/offapi/com/sun/star/i18n/WordType.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_i18n_WordType_idl__
24#define __com_sun_star_i18n_WordType_idl__
25
26//=============================================================================
27
28module com {  module sun {  module star {  module i18n {
29
30//=============================================================================
31
32/** Constants to specify the type of words.
33
34    <p> Used with <member>XBreakIterator::nextWord()</member>,
35    <member>XBreakIterator::previousWord()</member>,
36    <member>XBreakIterator::getWordBoundary()</member>,
37    <member>XBreakIterator::getWordType()</member>,
38    <member>XBreakIterator::isBeginWord()</member>,
39    <member>XBreakIterator::isEndWord()</member> </p>
40*/
41published constants WordType
42{
43    /** Any "words" - words in the meaning of same character types,
44        collection of alphanumeric characters, or collection of
45        non-alphanumeric characters.
46	*/
47	const short ANY_WORD                 = 0;
48
49    /** Any "words" - words in the meaning of same character types,
50        collection of alphanumeric characters, or collection of
51        non-alphanumeric characters except blanks.
52	*/
53	const short ANYWORD_IGNOREWHITESPACES= 1;
54
55    /** "words" - in the meaning of a collection of alphanumeric
56        characters and some punctuations, like dot for abbreviation.
57	*/
58    const short DICTIONARY_WORD          = 2;
59
60    /** The mode for counting words, it will combine punctuations and
61        spaces as word trail.
62 	*/
63    const short WORD_COUNT               = 3;
64};
65
66//=============================================================================
67}; }; }; };
68
69#endif
70