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