offapi/com/sun/star/i18n/XForbiddenCharacters.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XForbiddenCharacters.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
  31 #define __com_sun_star_i18n_XForbiddenCharacters_idl__
  32
  33 #include <com/sun/star/i18n/ForbiddenCharacters.idl>
  34
  35 #ifndef __com_sun_star_lang_Locale_idl__
  36 #include <com/sun/star/lang/Locale.idl>
  37 #endif
  38 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  39 #include <com/sun/star/container/NoSuchElementException.idl>
  40 #endif
  41
  42
  43 //============================================================================
  44
  45 module com {  module sun {  module star {  module i18n {
  46
  47 //============================================================================
  48
  49 /**
  50     provides access to forbidden character settings in a document.
  51
  52     <p> In some languages, particular characters are not allowed to be
  53     placed at the beginning or at the end of a text line. </p>
  54  */
  55
  56 published interface XForbiddenCharacters : com::sun::star::uno::XInterface
  57 {
  58     //------------------------------------------------------------------------
  59     /** returns the forbidden characters for a given locale.
  60      */
  61     ForbiddenCharacters getForbiddenCharacters(
  62                     [in] com::sun::star::lang::Locale aLocale )
  63             raises( com::sun::star::container::NoSuchElementException );
  64
  65     //------------------------------------------------------------------------
  66     /** determines if forbidden characters are set for a given locale.
  67      */
  68     boolean     hasForbiddenCharacters(
  69                     [in] com::sun::star::lang::Locale aLocale );
  70
  71     //------------------------------------------------------------------------
  72     /** sets the forbidden characters for a given Locale.
  73      */
  74     void        setForbiddenCharacters(
  75                     [in] com::sun::star::lang::Locale aLocale,
  76                     [in] ForbiddenCharacters aForbiddenCharacters );
  77
  78     //------------------------------------------------------------------------
  79     /** removes the setting of forbidden characters for a given locale.
  80      */
  81     void        removeForbiddenCharacters(
  82                     [in] com::sun::star::lang::Locale aLocale );
  83 };
  84
  85 //============================================================================
  86 }; }; }; };
  87
  88 #endif
  89