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