offapi/com/sun/star/linguistic2/LinguProperties.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LinguProperties.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_linguistic2_LinguProperties_idl__
  32 #define __com_sun_star_linguistic2_LinguProperties_idl__
  33
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  38 #include <com/sun/star/beans/XFastPropertySet.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_XComponent_idl__
  41 #include <com/sun/star/lang/XComponent.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_XServiceInfo_idl__
  44 #include <com/sun/star/lang/XServiceInfo.idl>
  45 #endif
  46 #ifndef __com_sun_star_lang_Locale_idl__
  47 #include <com/sun/star/lang/Locale.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module linguistic2 {
  53
  54 //=============================================================================
  55 /**     the set of linguistic relevant properties.
  56 */
  57 published service LinguProperties
  58 {
  59     interface com::sun::star::beans::XPropertySet;
  60     interface com::sun::star::beans::XFastPropertySet;
  61     interface com::sun::star::lang::XComponent;
  62     interface com::sun::star::lang::XServiceInfo;
  63
  64     //-------------------------------------------------------------------------
  65     /** defines whether new German spelling rules should be used for German
  66          text or not when doing spellchecking or hyphenation, or using the
  67          thesaurus.
  68
  69         @deprecated since OOo 3.0.1
  70       */
  71     [property, maybevoid] boolean IsGermanPreReform;
  72
  73     //-------------------------------------------------------------------------
  74     /** defines if the dictionary-list should be used for spellchecking
  75          and hyphenation or not.
  76     */
  77     [property] boolean IsUseDictionaryList;
  78
  79     //-------------------------------------------------------------------------
  80     /** defines if control characters should be ignored or not, by the linguistic
  81          (i.e., spellchecker, hyphenator and thesaurus).
  82     */
  83     [property] boolean IsIgnoreControlCharacters;
  84
  85     //-------------------------------------------------------------------------
  86     /** defines if words with only uppercase letters should be
  87          subject to spellchecking or not.
  88     */
  89     [property] boolean IsSpellUpperCase;
  90
  91     //-------------------------------------------------------------------------
  92     /** defines if words containing digits (or numbers) should be
  93          subject to spellchecking or not.
  94     */
  95     [property] boolean IsSpellWithDigits;
  96
  97     //-------------------------------------------------------------------------
  98     /** defines if the captitalization of words should be checked or not.
  99     */
 100     [property] boolean IsSpellCapitalization;
 101
 102     //-------------------------------------------------------------------------
 103     /** the minimum number of characters of a word to remain before the
 104          hyphen when doing hyphenation.
 105     */
 106     [property] short HyphMinLeading;
 107
 108     //-------------------------------------------------------------------------
 109     /** the minimum number of characters of a word to remain after the
 110          hyphen when doing hyphenation.
 111     */
 112     [property] short HyphMinTrailing;
 113
 114     //-------------------------------------------------------------------------
 115     /** the minimum length of a word in order to be hyphenated.
 116     */
 117     [property] short HyphMinWordLength;
 118
 119     //-------------------------------------------------------------------------
 120     /** the default western language for new documents.
 121     */
 122     [property] com::sun::star::lang::Locale DefaultLocale;
 123
 124     //-------------------------------------------------------------------------
 125     /** defines whether interactive hyphenation should be performed without
 126         requiring the user to select every hyphenation position after the user
 127         has triggered the hyphenation.
 128     */
 129     [property] boolean IsHyphAuto;
 130
 131     //-------------------------------------------------------------------------
 132     /** defines whether hyphenation should be done in special regions of
 133          documents or not.
 134     */
 135     [property] boolean IsHyphSpecial;
 136
 137     //-------------------------------------------------------------------------
 138     /** indicates whether spellchecking should be done automatically or not.
 139     */
 140     [property] boolean IsSpellAuto;
 141
 142     //-------------------------------------------------------------------------
 143     /** indicates whether the markings for incorrectly spelled text should be
 144          hidden or not.
 145
 146         @deprecated since OOo 3.0.1
 147     */
 148     [property, maybevoid] boolean IsSpellHide;
 149
 150     //-------------------------------------------------------------------------
 151     /** indicates if spellchecking should be performed in all available
 152          languages.
 153
 154         @deprecated since OOo 3.0.1
 155     */
 156     [property, maybevoid] boolean IsSpellInAllLanguages;
 157
 158     //-------------------------------------------------------------------------
 159     /** defines whether spellchecking should be done in special regions of
 160          documents or not.
 161     */
 162     [property] boolean IsSpellSpecial;
 163
 164     //-------------------------------------------------------------------------
 165     /** defines whether spellchecking should be done in reverse
 166          direction or not.
 167     */
 168     [property] boolean IsWrapReverse;
 169
 170     //-------------------------------------------------------------------------
 171     /** the default language for CJK languages.
 172     */
 173     [property] com::sun::star::lang::Locale DefaultLocale_CJK;
 174
 175     //-------------------------------------------------------------------------
 176     /** the default language for CTL languages.
 177     */
 178     [property] com::sun::star::lang::Locale DefaultLocale_CTL;
 179
 180 };
 181
 182 //=============================================================================
 183
 184 }; }; }; };
 185
 186 #endif