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#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
24#define __com_sun_star_i18n_XForbiddenCharacters_idl__
25
26#include <com/sun/star/i18n/ForbiddenCharacters.idl>
27
28#ifndef __com_sun_star_lang_Locale_idl__
29#include <com/sun/star/lang/Locale.idl>
30#endif
31#ifndef __com_sun_star_container_NoSuchElementException_idl__
32#include <com/sun/star/container/NoSuchElementException.idl>
33#endif
34
35
36//============================================================================
37
38module com {  module sun {  module star {  module i18n {
39
40//============================================================================
41
42/**
43    provides access to forbidden character settings in a document.
44
45    <p> In some languages, particular characters are not allowed to be
46    placed at the beginning or at the end of a text line. </p>
47 */
48
49published interface XForbiddenCharacters : com::sun::star::uno::XInterface
50{
51    //------------------------------------------------------------------------
52    /** returns the forbidden characters for a given locale.
53     */
54    ForbiddenCharacters getForbiddenCharacters(
55                    [in] com::sun::star::lang::Locale aLocale )
56            raises( com::sun::star::container::NoSuchElementException );
57
58    //------------------------------------------------------------------------
59    /** determines if forbidden characters are set for a given locale.
60     */
61    boolean     hasForbiddenCharacters(
62                    [in] com::sun::star::lang::Locale aLocale );
63
64    //------------------------------------------------------------------------
65    /** sets the forbidden characters for a given Locale.
66     */
67    void        setForbiddenCharacters(
68                    [in] com::sun::star::lang::Locale aLocale,
69                    [in] ForbiddenCharacters aForbiddenCharacters );
70
71    //------------------------------------------------------------------------
72    /** removes the setting of forbidden characters for a given locale.
73     */
74    void        removeForbiddenCharacters(
75                    [in] com::sun::star::lang::Locale aLocale );
76};
77
78//============================================================================
79}; }; }; };
80
81#endif
82
83