offapi/com/sun/star/util/XLocalizedAliases.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 #ifndef __com_sun_star_util_XLocalizedAliases_idl__
  20 #define __com_sun_star_util_XLocalizedAliases_idl__
  21
  22 #include <com/sun/star/lang/Locale.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/container/ElementExistException.idl>
  27
  28 #include <com/sun/star/util/AliasProgrammaticPair.idl>
  29
  30 module com {  module sun {  module star {  module util {
  31
  32
  33 /** is the interface for binding programmatic names to aliases. Aliases
  34     can be provided in several locales for the same programmatic name.
  35  */
  36 published interface XLocalizedAliases: com::sun::star::uno::XInterface
  37 {
  38
  39     /** registers an alias for a programmatic name.
  40      */
  41     void bindAlias([in]string programmaticName,
  42                    [in]com::sun::star::lang::Locale locale,
  43                     [in]string alias)
  44         raises (com::sun::star::container::ElementExistException);
  45     /** revokes an alias for a programmatic name.
  46      */
  47     void unbindAlias([in]com::sun::star::lang::Locale locale,
  48                      [in]string alias)
  49         raises (com::sun::star::container::NoSuchElementException);
  50     /** retrieves a registered programmatic name identified by an alias.
  51      */
  52     string lookupAlias([in]com::sun::star::lang::Locale locale,
  53                          [in]string Alias)
  54         raises (com::sun::star::container::NoSuchElementException);
  55     /** retrieves a given alias for a programmatic name.
  56      */
  57     string lookupProgrammatic([in]com::sun::star::lang::Locale locale,
  58                                 [in]string programmatic)
  59         raises (com::sun::star::container::NoSuchElementException);
  60     /** removes all aliases for a programmatic name.
  61      */
  62     void unbindAliases([in]string programmaticName)
  63         raises (com::sun::star::container::NoSuchElementException);
  64     /** rebinds all aliases registered to a given URL to a new one.
  65      */
  66     void rebindAliases([in]string currentProgrammatic,
  67                         [in]string newProgrammatic)
  68         raises (com::sun::star::container::NoSuchElementException,
  69                 com::sun::star::container::ElementExistException);
  70     /** renames an alias for a programmatic name.
  71      */
  72     void renameAlias([in]com::sun::star::lang::Locale locale,
  73                      [in]string oldName,
  74                      [in]string aNewName)
  75         raises (com::sun::star::container::NoSuchElementException,
  76                 com::sun::star::container::ElementExistException);
  77     /** retrieves a list of all registered aliases for a certain language.
  78
  79          @param locale
  80             specifies the locale scope.
  81
  82          @returns
  83             a sequence of registered pair of alias and programmatic name.
  84      */
  85     sequence<AliasProgrammaticPair> listAliases([in]com::sun::star::lang::Locale locale);
  86 };
  87
  88
  89 }; }; }; };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */