xref: /AOO41X/main/offapi/com/sun/star/linguistic2/LinguProperties.idl (revision d695a2a01c88463caf485fe1626e0c4587baa3be)
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
24#ifndef __com_sun_star_linguistic2_LinguProperties_idl__
25#define __com_sun_star_linguistic2_LinguProperties_idl__
26
27#ifndef __com_sun_star_beans_XPropertySet_idl__
28#include <com/sun/star/beans/XPropertySet.idl>
29#endif
30#ifndef __com_sun_star_beans_XFastPropertySet_idl__
31#include <com/sun/star/beans/XFastPropertySet.idl>
32#endif
33#ifndef __com_sun_star_lang_XComponent_idl__
34#include <com/sun/star/lang/XComponent.idl>
35#endif
36#ifndef __com_sun_star_lang_XServiceInfo_idl__
37#include <com/sun/star/lang/XServiceInfo.idl>
38#endif
39#ifndef __com_sun_star_lang_Locale_idl__
40#include <com/sun/star/lang/Locale.idl>
41#endif
42
43//=============================================================================
44
45module com { module sun { module star { module linguistic2 {
46
47//=============================================================================
48/** the set of linguistic relevant properties.
49*/
50published service LinguProperties
51{
52    interface com::sun::star::beans::XPropertySet;
53    interface com::sun::star::beans::XFastPropertySet;
54    interface com::sun::star::lang::XComponent;
55    interface com::sun::star::lang::XServiceInfo;
56
57    //-------------------------------------------------------------------------
58    /** defines whether new German spelling rules should be used for German
59        text or not when doing spellchecking or hyphenation, or using the
60        thesaurus.
61
62        @deprecated since OpenOffice 3.0.1
63      */
64    [property, maybevoid] boolean IsGermanPreReform;
65
66    //-------------------------------------------------------------------------
67    /** defines if the dictionary-list should be used for spellchecking
68        and hyphenation or not.
69    */
70    [property] boolean IsUseDictionaryList;
71
72    //-------------------------------------------------------------------------
73    /** defines if control characters should be ignored or not, by the linguistic
74        (i.e., spellchecker, hyphenator and thesaurus).
75    */
76    [property] boolean IsIgnoreControlCharacters;
77
78    //-------------------------------------------------------------------------
79    /** defines if words with only uppercase letters should be
80        subject to spellchecking or not.
81    */
82    [property] boolean IsSpellUpperCase;
83
84    //-------------------------------------------------------------------------
85    /** defines if words containing digits (or numbers) should be
86        subject to spellchecking or not.
87    */
88    [property] boolean IsSpellWithDigits;
89
90    //-------------------------------------------------------------------------
91    /** defines if the captitalization of words should be checked or not.
92    */
93    [property] boolean IsSpellCapitalization;
94
95    //-------------------------------------------------------------------------
96    /** the minimum number of characters of a word to remain before the
97        hyphen when doing hyphenation.
98    */
99    [property] short HyphMinLeading;
100
101    //-------------------------------------------------------------------------
102    /** the minimum number of characters of a word to remain after the
103        hyphen when doing hyphenation.
104    */
105    [property] short HyphMinTrailing;
106
107    //-------------------------------------------------------------------------
108    /** the minimum length of a word in order to be hyphenated.
109    */
110    [property] short HyphMinWordLength;
111
112    //-------------------------------------------------------------------------
113    /** the default western language for new documents.
114    */
115    [property] com::sun::star::lang::Locale DefaultLocale;
116
117    //-------------------------------------------------------------------------
118    /** defines whether interactive hyphenation should be performed without
119        requiring the user to select every hyphenation position after the user
120        has triggered the hyphenation.
121    */
122    [property] boolean IsHyphAuto;
123
124    //-------------------------------------------------------------------------
125    /** defines whether hyphenation should be done in special regions of
126        documents or not.
127    */
128    [property] boolean IsHyphSpecial;
129
130    //-------------------------------------------------------------------------
131    /** indicates whether spellchecking should be done automatically or not.
132    */
133    [property] boolean IsSpellAuto;
134
135    //-------------------------------------------------------------------------
136    /** indicates whether the markings for incorrectly spelled text should be
137        hidden or not.
138
139        @deprecated since OpenOffice 3.0.1
140    */
141    [property, maybevoid] boolean IsSpellHide;
142
143    //-------------------------------------------------------------------------
144    /** indicates if spellchecking should be performed in all available
145        languages.
146
147        @deprecated since OpenOffice 3.0.1
148    */
149    [property, maybevoid] boolean IsSpellInAllLanguages;
150
151    //-------------------------------------------------------------------------
152    /** defines whether spellchecking should be done in special regions of
153        documents or not.
154    */
155    [property] boolean IsSpellSpecial;
156
157    //-------------------------------------------------------------------------
158    /** defines whether spellchecking should be done in reverse
159        direction or not.
160    */
161    [property] boolean IsWrapReverse;
162
163    //-------------------------------------------------------------------------
164    /** the default language for CJK languages.
165    */
166    [property] com::sun::star::lang::Locale DefaultLocale_CJK;
167
168    //-------------------------------------------------------------------------
169    /** the default language for CTL languages.
170    */
171    [property] com::sun::star::lang::Locale DefaultLocale_CTL;
172
173};
174
175//=============================================================================
176
177}; }; }; };
178
179#endif
180