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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_linguistic2_XLinguProperties_idl__
  21 #define __com_sun_star_linguistic2_XLinguProperties_idl__
  22
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/beans/XFastPropertySet.idl>
  25 #include <com/sun/star/lang/XComponent.idl>
  26 #include <com/sun/star/lang/Locale.idl>
  27
  28
  29 module com { module sun { module star { module linguistic2 {
  30
  31 /**
  32     Interface for LinguProperties service.
  33
  34     @since LibreOffice 4.1
  35 */
  36 published interface XLinguProperties
  37 {
  38     interface com::sun::star::beans::XPropertySet;
  39
  40     /** defines if the dictionary-list should be used for spell checking
  41          and hyphenation or not.
  42     */
  43     [attribute] boolean IsUseDictionaryList;
  44
  45     /** defines if control characters should be ignored or not, by the linguistic
  46          (i.e., spell checker, hyphenator and thesaurus).
  47     */
  48     [attribute] boolean IsIgnoreControlCharacters;
  49
  50     /** defines if words with only uppercase letters should be
  51          subject to spell checking or not.
  52     */
  53     [attribute] boolean IsSpellUpperCase;
  54
  55     /** defines if words containing digits (or numbers) should be
  56          subject to spell checking or not.
  57     */
  58     [attribute] boolean IsSpellWithDigits;
  59
  60     /** defines if the capitalization of words should be checked or not.
  61
  62         @deprecated
  63     */
  64     [attribute] boolean IsSpellCapitalization;
  65
  66     /** the minimum number of characters of a word to remain before the
  67          hyphen when doing hyphenation.
  68     */
  69     [attribute] short HyphMinLeading;
  70
  71     /** the minimum number of characters of a word to remain after the
  72          hyphen when doing hyphenation.
  73     */
  74     [attribute] short HyphMinTrailing;
  75
  76     /** the minimum length of a word in order to be hyphenated.
  77     */
  78     [attribute] short HyphMinWordLength;
  79
  80     /** the default western language for new documents.
  81     */
  82     [attribute] com::sun::star::lang::Locale DefaultLocale;
  83
  84     /** defines whether interactive hyphenation should be performed without
  85         requiring the user to select every hyphenation position after the user
  86         has triggered the hyphenation.
  87     */
  88     [attribute] boolean IsHyphAuto;
  89
  90     /** defines whether hyphenation should be done in special regions of
  91          documents or not.
  92     */
  93     [attribute] boolean IsHyphSpecial;
  94
  95     /** indicates whether spell checking should be done automatically or not.
  96     */
  97     [attribute] boolean IsSpellAuto;
  98
  99     /** defines whether spell checking should be done in special regions of
 100          documents or not.
 101     */
 102     [attribute] boolean IsSpellSpecial;
 103
 104     /** defines whether spell checking should be done in reverse
 105          direction or not.
 106     */
 107     [attribute] boolean IsWrapReverse;
 108
 109     /** the default language for CJK languages.
 110     */
 111     [attribute] com::sun::star::lang::Locale DefaultLocale_CJK;
 112
 113     /** the default language for CTL languages.
 114     */
 115     [attribute] com::sun::star::lang::Locale DefaultLocale_CTL;
 116
 117 };
 118
 119
 120 }; }; }; };
 121
 122 #endif
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */