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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_i18n_XForbiddenCharacters_idl__
  29 #define __com_sun_star_i18n_XForbiddenCharacters_idl__
  30
  31 #include <com/sun/star/i18n/ForbiddenCharacters.idl>
  32 #include <com/sun/star/lang/Locale.idl>
  33 #include <com/sun/star/container/NoSuchElementException.idl>
  34
  35
  36 //============================================================================
  37
  38 module 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
  49 published 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 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */