merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / util / XLocalizedAliases.idl
blob253e4726bd03b9b05e136a0056e11c9ba41276cc
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XLocalizedAliases.idl,v $
10 * $Revision: 1.8 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_util_XLocalizedAliases_idl__
31 #define __com_sun_star_util_XLocalizedAliases_idl__
33 #ifndef __com_sun_star_lang_Locale_idl__
34 #include <com/sun/star/lang/Locale.idl>
35 #endif
37 #ifndef __com_sun_star_container_NoSuchElementException_idl__
38 #include <com/sun/star/container/NoSuchElementException.idl>
39 #endif
41 #ifndef __com_sun_star_container_ElementExistException_idl__
42 #include <com/sun/star/container/ElementExistException.idl>
43 #endif
45 #ifndef __com_sun_star_util_AliasProgrammaticPair_idl__
46 #include <com/sun/star/util/AliasProgrammaticPair.idl>
47 #endif
49 //=============================================================================
50 module com { module sun { module star { module util {
52 //=============================================================================
54 /** is the interface for binding programmatic names to aliases. Aliases
55 can be provided in several locales for the same programmatic name.
57 published interface XLocalizedAliases: com::sun::star::uno::XInterface
60 /** registers an alias for a programmatic name.
62 void bindAlias([in]string programmaticName,
63 [in]com::sun::star::lang::Locale locale,
64 [in]string alias)
65 raises (com::sun::star::container::ElementExistException);
66 //-------------------------------------------------------------------------
67 /** revokes an alias for a programmatic name.
69 void unbindAlias([in]com::sun::star::lang::Locale locale,
70 [in]string alias)
71 raises (com::sun::star::container::NoSuchElementException);
72 //-------------------------------------------------------------------------
73 /** retrieves a registered porgrammatic name identified by an alias.
75 string lookupAlias([in]com::sun::star::lang::Locale locale,
76 [in]string Alias)
77 raises (com::sun::star::container::NoSuchElementException);
78 //-------------------------------------------------------------------------
79 /** retrieves a given alias for a programmatic name.
81 string lookupProgrammatic([in]com::sun::star::lang::Locale locale,
82 [in]string programmatic)
83 raises (com::sun::star::container::NoSuchElementException);
84 //-------------------------------------------------------------------------
85 /** removes all aliases for a programmatic name.
87 void unbindAliases([in]string programmaticName)
88 raises (com::sun::star::container::NoSuchElementException);
89 //-------------------------------------------------------------------------
90 /** rebinds all aliases registered to a given URL to a new one.
92 void rebindAliases([in]string currentProgrammatic,
93 [in]string newProgrammatic)
94 raises (com::sun::star::container::NoSuchElementException,
95 com::sun::star::container::ElementExistException);
96 //-------------------------------------------------------------------------
97 /** renames an alias for a programmatic name.
99 void renameAlias([in]com::sun::star::lang::Locale locale,
100 [in]string oldName,
101 [in]string aNewName)
102 raises (com::sun::star::container::NoSuchElementException,
103 com::sun::star::container::ElementExistException);
104 //-------------------------------------------------------------------------
105 /** retrieves a list of all registered aliases for a certain language.
107 @param locale
108 specifies the locale scope.
110 @returns
111 a sequence of registered pair of alias and programmatic name.
113 sequence<AliasProgrammaticPair> listAliases([in]com::sun::star::lang::Locale locale);
116 //=============================================================================
118 }; }; }; };
120 #endif