xref: /trunk/main/offapi/com/sun/star/i18n/WordType.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_i18n_WordType_idl__
28#define __com_sun_star_i18n_WordType_idl__
29
30//=============================================================================
31
32module com {  module sun {  module star {  module i18n {
33
34//=============================================================================
35
36/** Constants to specify the type of words.
37
38    <p> Used with <member>XBreakIterator::nextWord()</member>,
39    <member>XBreakIterator::previousWord()</member>,
40    <member>XBreakIterator::getWordBoundary()</member>,
41    <member>XBreakIterator::getWordType()</member>,
42    <member>XBreakIterator::isBeginWord()</member>,
43    <member>XBreakIterator::isEndWord()</member> </p>
44*/
45published constants WordType
46{
47    /** Any "words" - words in the meaning of same character types,
48        collection of alphanumeric characters, or collection of
49        non-alphanumeric characters.
50	*/
51	const short ANY_WORD                 = 0;
52
53    /** Any "words" - words in the meaning of same character types,
54        collection of alphanumeric characters, or collection of
55        non-alphanumeric characters except blanks.
56	*/
57	const short ANYWORD_IGNOREWHITESPACES= 1;
58
59    /** "words" - in the meaning of a collection of alphanumeric
60        characters and some punctuations, like dot for abbreviation.
61	*/
62    const short DICTIONARY_WORD          = 2;
63
64    /** The mode for counting words, it will combine punctuations and
65        spaces as word trail.
66 	*/
67    const short WORD_COUNT               = 3;
68};
69
70//=============================================================================
71}; }; }; };
72
73#endif
74