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