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