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 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_resource_StringResourceWithStorage_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_resource_StringResourceWithStorage_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_resource_XStringResourceWithStorage_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/resource/XStringResourceWithStorage.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski//============================================================================= 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module resource { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski//============================================================================= 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski/** specifies a service providing access to a resource string table implementing the 39*b1cdbd2cSJim Jagielski <type scope="com::sun::star::resource">XStringResourceWithStorage</type> interface. 40*b1cdbd2cSJim Jagielski */ 41*b1cdbd2cSJim Jagielskiservice StringResourceWithStorage : com::sun::star::resource::XStringResourceWithStorage 42*b1cdbd2cSJim Jagielski{ 43*b1cdbd2cSJim Jagielski /** is used to initialize the object on its creation. 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski @param Storage 46*b1cdbd2cSJim Jagielski Specifies the storage used to load and store - if 47*b1cdbd2cSJim Jagielski the ReadOnly state allows it - the string table data. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski @param ReadOnly 50*b1cdbd2cSJim Jagielski Specifies if the resource should be read only, 51*b1cdbd2cSJim Jagielski see <code>XStringResourceManager::isReadOnly</code> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski @param locale 54*b1cdbd2cSJim Jagielski Specifies if the locale first to be used as current locale. Internally 55*b1cdbd2cSJim Jagielski the <code>XStringResourceManager::setCurrentLocale</code> method is 56*b1cdbd2cSJim Jagielski called with FindClosestMatch=true. 57*b1cdbd2cSJim Jagielski see <code>XStringResourceManager::setCurrentLocale</code> 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski @param BaseName 60*b1cdbd2cSJim Jagielski Base string for the file names used to store the locale data. 61*b1cdbd2cSJim Jagielski The locale data is stored in Java properties files also following 62*b1cdbd2cSJim Jagielski the corresponding naming sceme. The files will be named like this: 63*b1cdbd2cSJim Jagielski "[BaseName]_[Language]_[Country].properties", 64*b1cdbd2cSJim Jagielski e.g. "MyBaseName_en_US.properties" 65*b1cdbd2cSJim Jagielski If an empty string is passed for BaseName, "strings" will be used 66*b1cdbd2cSJim Jagielski as BaseName. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param Comment 69*b1cdbd2cSJim Jagielski Comment stored first in each properties file followed by a line 70*b1cdbd2cSJim Jagielski feed character. The line feed character is added automatically 71*b1cdbd2cSJim Jagielski and hasn't to be part of the comment string. The caller is re- 72*b1cdbd2cSJim Jagielski sponsible that the passed string is a valid comment in a Java 73*b1cdbd2cSJim Jagielski properties file, e.g. "# My strings". The string may be empty. 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> 76*b1cdbd2cSJim Jagielski if a null interface is passed as Storage 77*b1cdbd2cSJim Jagielski */ 78*b1cdbd2cSJim Jagielski create( [in] ::com::sun::star::embed::XStorage Storage, 79*b1cdbd2cSJim Jagielski [in] boolean ReadOnly, [in] com::sun::star::lang::Locale locale, 80*b1cdbd2cSJim Jagielski [in] string BaseName, [in] string Comment ) 81*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::IllegalArgumentException ); 82*b1cdbd2cSJim Jagielski}; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski//============================================================================= 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski}; }; }; }; 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski#endif 89