1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_resource_XStringResourceResolver_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_resource_XStringResourceResolver_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_resource_MissingResourceException_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/resource/MissingResourceException.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_XModifyBroadcaster_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/util/XModifyBroadcaster.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_Locale_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/Locale.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module resource { 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski/** 45*b1cdbd2cSJim Jagielski Interface to access strings in a resource. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski The interface is derived from 48*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">XModifyBroadcaster</type> 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski All registered <type scope="com::sun::star::util">XModifyListener</type> 51*b1cdbd2cSJim Jagielski interfaces will be notified if either the current locale changes or if 52*b1cdbd2cSJim Jagielski a string is added, changed or removed. This usually will only happen if 53*b1cdbd2cSJim Jagielski the implementing object also supports the interface 54*b1cdbd2cSJim Jagielski <type scope="com::sun::star::resource">XStringResourceManager</type> 55*b1cdbd2cSJim Jagielski and is used in the design mode of a Dialog or String table editor. 56*b1cdbd2cSJim Jagielski But also changing the locale at runtime can be supported in this way. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski*/ 59*b1cdbd2cSJim Jagielskipublished interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster 60*b1cdbd2cSJim Jagielski{ 61*b1cdbd2cSJim Jagielski /** 62*b1cdbd2cSJim Jagielski Resolves the passed ResoureID for the current locale. This 63*b1cdbd2cSJim Jagielski locale is set during initalisation of the object implementing 64*b1cdbd2cSJim Jagielski this interface or - in case that also the interface 65*b1cdbd2cSJim Jagielski <type scope="com::sun::star::resource">XStringResourceManager</type> 66*b1cdbd2cSJim Jagielski is supported - by using the <code>XStringResourceManager::setLocale</code> 67*b1cdbd2cSJim Jagielski method. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param ResourceID 70*b1cdbd2cSJim Jagielski ID to specify the string inside the resource. 71*b1cdbd2cSJim Jagielski The ID can - but not needs to - be a hierarchical 72*b1cdbd2cSJim Jagielski name like "foo.nothing.invalid". 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @return the localized string for the specified ID 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @throws ::com::sun::star::resource::MissingResourceException 77*b1cdbd2cSJim Jagielski if no entry exists for the given ResourceID 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski string resolveString( [in] string ResourceID ) 80*b1cdbd2cSJim Jagielski raises( com::sun::star::resource::MissingResourceException ); 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** Resolves the passed ResoureID for a specific locale. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski It's not recommended to use this method to get the best 86*b1cdbd2cSJim Jagielski performance as the implementation may be optimized for 87*b1cdbd2cSJim Jagielski the use of the current locale. 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @param ResourceID 90*b1cdbd2cSJim Jagielski ID to specify the string inside the resource. 91*b1cdbd2cSJim Jagielski The ID can - but not needs to - be a hierarchical 92*b1cdbd2cSJim Jagielski name like "foo.nothing.invalid". 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski @param locale 95*b1cdbd2cSJim Jagielski The locale the string should be resolved for. 96*b1cdbd2cSJim Jagielski The locale has to match exactly with one of the locales provided by 97*b1cdbd2cSJim Jagielski <member>getLocales</member>. A closest match search is not supported. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski @return the localized string for the specified ID and Locale 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::resource">MissingResourceException</type> 102*b1cdbd2cSJim Jagielski if no entry exists for the given ResourceID or locale 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski string resolveStringForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale ) 105*b1cdbd2cSJim Jagielski raises( com::sun::star::resource::MissingResourceException ); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski /** 109*b1cdbd2cSJim Jagielski Checks if the resource contains an entry for the given ResourceID 110*b1cdbd2cSJim Jagielski and current locale. 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski @param ResourceID 113*b1cdbd2cSJim Jagielski ID to specify the string inside the resource. 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski @return <TRUE/> if an entry exists, otherwise <FALSE/> 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski boolean hasEntryForId( [in] string ResourceID ); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** 122*b1cdbd2cSJim Jagielski Checks if the resource contains an entry for the given ResourceID and locale. 123*b1cdbd2cSJim Jagielski 124*b1cdbd2cSJim Jagielski It's not recommended to use this method to get the best 125*b1cdbd2cSJim Jagielski performance as the implementation may be optimized for 126*b1cdbd2cSJim Jagielski the use of the current locale. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @param ResourceID 129*b1cdbd2cSJim Jagielski ID to specify the string inside the resource. 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski @param locale 132*b1cdbd2cSJim Jagielski The locale the entry should be checked for. 133*b1cdbd2cSJim Jagielski The locale has to match exactly with one of the locales provided by 134*b1cdbd2cSJim Jagielski <member>getLocales</member>. A closest match search is not supported. 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski @return <TRUE/> if an entry exists, otherwise <FALSE/> 137*b1cdbd2cSJim Jagielski */ 138*b1cdbd2cSJim Jagielski boolean hasEntryForIdAndLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale ); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski /** 142*b1cdbd2cSJim Jagielski Returns a sequence of all valid Resource IDs for the current locale 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski @return a sequence of all valid Resource IDs 145*b1cdbd2cSJim Jagielski */ 146*b1cdbd2cSJim Jagielski sequence<string> getResourceIDs(); 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski /** 150*b1cdbd2cSJim Jagielski Returns a sequence of all valid Resource IDs for a specific locale 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski It's not recommended to use this method to get the best 153*b1cdbd2cSJim Jagielski performance as the implementation may be optimized for 154*b1cdbd2cSJim Jagielski the use of the current locale. 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski @param locale 157*b1cdbd2cSJim Jagielski The locale the ResourceIDs should be returned for. 158*b1cdbd2cSJim Jagielski The locale has to match exactly with one of the locales provided by 159*b1cdbd2cSJim Jagielski <member>getLocales</member>. A closest match search is not supported. 160*b1cdbd2cSJim Jagielski 161*b1cdbd2cSJim Jagielski @return a sequence of all valid Resource IDs 162*b1cdbd2cSJim Jagielski */ 163*b1cdbd2cSJim Jagielski sequence<string> getResourceIDsForLocale( [in] com::sun::star::lang::Locale locale ); 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski /** Returns the current locale specified in the accessed resource. 167*b1cdbd2cSJim Jagielski 168*b1cdbd2cSJim Jagielski If no locale is available, the returned Locale structure 169*b1cdbd2cSJim Jagielski only contains empty strings. 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski @returns the used locale 172*b1cdbd2cSJim Jagielski */ 173*b1cdbd2cSJim Jagielski com::sun::star::lang::Locale getCurrentLocale(); 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski /** Returns the default locale of the accessed resource. In many 177*b1cdbd2cSJim Jagielski cases this will be the locale of the Office initially used 178*b1cdbd2cSJim Jagielski to create the resource. 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski @return the used locale 181*b1cdbd2cSJim Jagielski */ 182*b1cdbd2cSJim Jagielski com::sun::star::lang::Locale getDefaultLocale(); 183*b1cdbd2cSJim Jagielski 184*b1cdbd2cSJim Jagielski 185*b1cdbd2cSJim Jagielski /** 186*b1cdbd2cSJim Jagielski Returns a sequence of all supported locales 187*b1cdbd2cSJim Jagielski 188*b1cdbd2cSJim Jagielski @return a sequence of all supported locales 189*b1cdbd2cSJim Jagielski */ 190*b1cdbd2cSJim Jagielski sequence<com::sun::star::lang::Locale> getLocales(); 191*b1cdbd2cSJim Jagielski}; 192*b1cdbd2cSJim Jagielski 193*b1cdbd2cSJim Jagielski//============================================================================= 194*b1cdbd2cSJim Jagielski 195*b1cdbd2cSJim Jagielski}; }; }; }; 196*b1cdbd2cSJim Jagielski 197*b1cdbd2cSJim Jagielski#endif 198