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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module i18n {
  23
  24
  25 /**
  26     provides access to forbidden character settings in a document.
  27
  28     <p> In some languages, particular characters are not allowed to be
  29     placed at the beginning or at the end of a text line. </p>
  30  */
  31
  32 published interface XForbiddenCharacters : com::sun::star::uno::XInterface
  33 {
  34     /** returns the forbidden characters for a given locale.
  35      */
  36     ForbiddenCharacters getForbiddenCharacters(
  37                     [in] com::sun::star::lang::Locale aLocale )
  38             raises( com::sun::star::container::NoSuchElementException );
  39
  40     /** determines if forbidden characters are set for a given locale.
  41      */
  42     boolean     hasForbiddenCharacters(
  43                     [in] com::sun::star::lang::Locale aLocale );
  44
  45     /** sets the forbidden characters for a given Locale.
  46      */
  47     void        setForbiddenCharacters(
  48                     [in] com::sun::star::lang::Locale aLocale,
  49                     [in] ForbiddenCharacters aForbiddenCharacters );
  50
  51     /** removes the setting of forbidden characters for a given locale.
  52      */
  53     void        removeForbiddenCharacters(
  54                     [in] com::sun::star::lang::Locale aLocale );
  55 };
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */