summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/linguistic2/XLinguProperties.idl
blob: 5bbaf91f0b3e297e17d3047fc2688d6c36044ec3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_linguistic2_XLinguProperties_idl__
#define __com_sun_star_linguistic2_XLinguProperties_idl__

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/beans/XFastPropertySet.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/lang/Locale.idl>


module com { module sun { module star { module linguistic2 {

/**
    Interface for LinguProperties service.

    @since LibreOffice 4.1
*/
published interface XLinguProperties
{
    interface com::sun::star::beans::XPropertySet;

    /** defines if the dictionary-list should be used for spell checking
         and hyphenation or not.
    */
    [attribute] boolean IsUseDictionaryList;

    /** defines if control characters should be ignored or not, by the linguistic
         (i.e., spell checker, hyphenator and thesaurus).
    */
    [attribute] boolean IsIgnoreControlCharacters;

    /** defines if words with only uppercase letters should be
         subject to spell checking or not.
    */
    [attribute] boolean IsSpellUpperCase;

    /** defines if words containing digits (or numbers) should be
         subject to spell checking or not.
    */
    [attribute] boolean IsSpellWithDigits;

    /** defines if the capitalization of words should be checked or not.

        @deprecated
    */
    [attribute] boolean IsSpellCapitalization;

    /** the minimum number of characters of a word to remain before the
         hyphen when doing hyphenation.
    */
    [attribute] short HyphMinLeading;

    /** the minimum number of characters of a word to remain after the
         hyphen when doing hyphenation.
    */
    [attribute] short HyphMinTrailing;

    /** the minimum length of a word in order to be hyphenated.
    */
    [attribute] short HyphMinWordLength;

    /** the default western language for new documents.
    */
    [attribute] com::sun::star::lang::Locale DefaultLocale;

    /** defines whether interactive hyphenation should be performed without
        requiring the user to select every hyphenation position after the user
        has triggered the hyphenation.
    */
    [attribute] boolean IsHyphAuto;

    /** defines whether hyphenation should be done in special regions of
         documents or not.
    */
    [attribute] boolean IsHyphSpecial;

    /** indicates whether spell checking should be done automatically or not.
    */
    [attribute] boolean IsSpellAuto;

    /** defines whether spell checking should be done in special regions of
         documents or not.
    */
    [attribute] boolean IsSpellSpecial;

    /** defines whether spell checking should be done in reverse
         direction or not.
    */
    [attribute] boolean IsWrapReverse;

    /** the default language for CJK languages.
    */
    [attribute] com::sun::star::lang::Locale DefaultLocale_CJK;

    /** the default language for CTL languages.
    */
    [attribute] com::sun::star::lang::Locale DefaultLocale_CTL;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */