/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
#define __com_sun_star_i18n_XForbiddenCharacters_idl__

#include <com/sun/star/i18n/ForbiddenCharacters.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/container/NoSuchElementException.idl>


//============================================================================

module com {  module sun {  module star {  module i18n {

//============================================================================

/**
    provides access to forbidden character settings in a document.

    <p> In some languages, particular characters are not allowed to be
    placed at the beginning or at the end of a text line. </p>
 */

published interface XForbiddenCharacters : com::sun::star::uno::XInterface
{
    //------------------------------------------------------------------------
    /** returns the forbidden characters for a given locale.
     */
    ForbiddenCharacters getForbiddenCharacters(
                    [in] com::sun::star::lang::Locale aLocale )
            raises( com::sun::star::container::NoSuchElementException );

    //------------------------------------------------------------------------
    /** determines if forbidden characters are set for a given locale.
     */
    boolean     hasForbiddenCharacters(
                    [in] com::sun::star::lang::Locale aLocale );

    //------------------------------------------------------------------------
    /** sets the forbidden characters for a given Locale.
     */
    void        setForbiddenCharacters(
                    [in] com::sun::star::lang::Locale aLocale,
                    [in] ForbiddenCharacters aForbiddenCharacters );

    //------------------------------------------------------------------------
    /** removes the setting of forbidden characters for a given locale.
     */
    void        removeForbiddenCharacters(
                    [in] com::sun::star::lang::Locale aLocale );
};

//============================================================================
}; }; }; };

#endif

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