1d1766043SAndrew Rist/**************************************************************
2*21947a42Smseidel *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*21947a42Smseidel *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*21947a42Smseidel *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19*21947a42Smseidel *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_util_XLocalizedAliases_idl__
24cdf0e10cSrcweir#define __com_sun_star_util_XLocalizedAliases_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_lang_Locale_idl__
27cdf0e10cSrcweir#include <com/sun/star/lang/Locale.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__
31cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_container_ElementExistException_idl__
35cdf0e10cSrcweir#include <com/sun/star/container/ElementExistException.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_util_AliasProgrammaticPair_idl__
39cdf0e10cSrcweir#include <com/sun/star/util/AliasProgrammaticPair.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir//=============================================================================
43cdf0e10cSrcweirmodule com {  module sun {  module star {  module util {
44cdf0e10cSrcweir
45cdf0e10cSrcweir//=============================================================================
46cdf0e10cSrcweir
47cdf0e10cSrcweir/** is the interface for binding programmatic names to aliases. Aliases
48cdf0e10cSrcweir	can be provided in several locales for the same programmatic name.
49cdf0e10cSrcweir */
50cdf0e10cSrcweirpublished interface XLocalizedAliases: com::sun::star::uno::XInterface
51cdf0e10cSrcweir{
52cdf0e10cSrcweir
53cdf0e10cSrcweir	/** registers an alias for a programmatic name.
54cdf0e10cSrcweir	 */
55cdf0e10cSrcweir	void bindAlias([in]string programmaticName,
56cdf0e10cSrcweir				   [in]com::sun::star::lang::Locale locale,
57cdf0e10cSrcweir	 			   [in]string alias)
58cdf0e10cSrcweir		raises (com::sun::star::container::ElementExistException);
59cdf0e10cSrcweir	//-------------------------------------------------------------------------
60cdf0e10cSrcweir	/** revokes an alias for a programmatic name.
61cdf0e10cSrcweir	 */
62cdf0e10cSrcweir	void unbindAlias([in]com::sun::star::lang::Locale locale,
63cdf0e10cSrcweir					 [in]string alias)
64cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException);
65cdf0e10cSrcweir	//-------------------------------------------------------------------------
66*21947a42Smseidel	/** retrieves a registered programmatic name identified by an alias.
67cdf0e10cSrcweir	 */
68cdf0e10cSrcweir	string lookupAlias([in]com::sun::star::lang::Locale locale,
69cdf0e10cSrcweir				  	   [in]string Alias)
70cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException);
71cdf0e10cSrcweir	//-------------------------------------------------------------------------
72cdf0e10cSrcweir	/** retrieves a given alias for a programmatic name.
73cdf0e10cSrcweir	 */
74cdf0e10cSrcweir	string lookupProgrammatic([in]com::sun::star::lang::Locale locale,
75cdf0e10cSrcweir				  			  [in]string programmatic)
76cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException);
77cdf0e10cSrcweir	//-------------------------------------------------------------------------
78cdf0e10cSrcweir	/** removes all aliases for a programmatic name.
79cdf0e10cSrcweir	 */
80cdf0e10cSrcweir	void unbindAliases([in]string programmaticName)
81cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException);
82cdf0e10cSrcweir	//-------------------------------------------------------------------------
83cdf0e10cSrcweir	/** rebinds all aliases registered to a given URL to a new one.
84cdf0e10cSrcweir	 */
85cdf0e10cSrcweir	void rebindAliases([in]string currentProgrammatic,
86cdf0e10cSrcweir		 			   [in]string newProgrammatic)
87cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException,
88cdf0e10cSrcweir				com::sun::star::container::ElementExistException);
89cdf0e10cSrcweir	//-------------------------------------------------------------------------
90cdf0e10cSrcweir	/** renames an alias for a programmatic name.
91cdf0e10cSrcweir	 */
92cdf0e10cSrcweir	void renameAlias([in]com::sun::star::lang::Locale locale,
93cdf0e10cSrcweir					 [in]string oldName,
94cdf0e10cSrcweir					 [in]string aNewName)
95cdf0e10cSrcweir		raises (com::sun::star::container::NoSuchElementException,
96cdf0e10cSrcweir				com::sun::star::container::ElementExistException);
97cdf0e10cSrcweir	//-------------------------------------------------------------------------
98cdf0e10cSrcweir	/** retrieves a list of all registered aliases for a certain language.
99cdf0e10cSrcweir
100cdf0e10cSrcweir		 @param locale
101cdf0e10cSrcweir			specifies the locale scope.
102cdf0e10cSrcweir
103cdf0e10cSrcweir		 @returns
104cdf0e10cSrcweir			a sequence of registered pair of alias and programmatic name.
105cdf0e10cSrcweir	 */
106cdf0e10cSrcweir	sequence<AliasProgrammaticPair> listAliases([in]com::sun::star::lang::Locale locale);
107cdf0e10cSrcweir};
108cdf0e10cSrcweir
109cdf0e10cSrcweir//=============================================================================
110cdf0e10cSrcweir
111cdf0e10cSrcweir}; }; }; };
112cdf0e10cSrcweir
113cdf0e10cSrcweir#endif
114