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