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_XStringResourceWithStorage_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_resource_XStringResourceWithStorage_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_resource_XStringResourcePersistence_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/resource/XStringResourcePersistence.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski//============================================================================= 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module resource { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski/** 37*b1cdbd2cSJim Jagielski Extends <type>XStringResourcePersistence</type> by methods to handle an 38*b1cdbd2cSJim Jagielski associated <type scope="com::sun::star::embed">XStorage</type> instance. 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski @see <type>XStringResourcePersistence</type>. 41*b1cdbd2cSJim Jagielski*/ 42*b1cdbd2cSJim Jagielskiinterface XStringResourceWithStorage: com::sun::star::resource::XStringResourcePersistence 43*b1cdbd2cSJim Jagielski{ 44*b1cdbd2cSJim Jagielski /** 45*b1cdbd2cSJim Jagielski Stores all string table data to a storage and associates this storage 46*b1cdbd2cSJim Jagielski to this instance as if <member>setStorage</member> was called with 47*b1cdbd2cSJim Jagielski this storage. The modified state will be unmodified after the call. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski This method can throw all exceptions thrown by the methods of 50*b1cdbd2cSJim Jagielski <type scope="com::sun::star::embed">XStorage</type> 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski void storeAsStorage( [in] ::com::sun::star::embed::XStorage Storage ) 53*b1cdbd2cSJim Jagielski raises( com::sun::star::uno::Exception ); 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski /** 57*b1cdbd2cSJim Jagielski Associates a storage to the StringResourceWithStorage instance 58*b1cdbd2cSJim Jagielski which is used on subsequent calls of <member>store</member>. 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski @param Storage 61*b1cdbd2cSJim Jagielski the storage to be associated to the StringResourceManager 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski <p> 64*b1cdbd2cSJim Jagielski This call has to be used carefully as it removes the storage 65*b1cdbd2cSJim Jagielski previously connected to the StringResourceWithStorage. It may 66*b1cdbd2cSJim Jagielski force the implementation to reload data from the previous storage 67*b1cdbd2cSJim Jagielski before releasing it. The StringResourceManager will be modified 68*b1cdbd2cSJim Jagielski after calling this method as the data isn't stored to the new 69*b1cdbd2cSJim Jagielski storage yet. <member>storeAsStorage</member> should be prefered 70*b1cdbd2cSJim Jagielski as it directly stores the data to the new storage and afterwards 71*b1cdbd2cSJim Jagielski this storage is in sync with the resource data. 72*b1cdbd2cSJim Jagielski </p> 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @throws <type scope="com::sun::star::lang">IllegalArgumentException</type> 75*b1cdbd2cSJim Jagielski if a null interface is passed as Storage 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski void setStorage( [in] ::com::sun::star::embed::XStorage Storage ) 78*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::IllegalArgumentException ); 79*b1cdbd2cSJim Jagielski}; 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski//============================================================================= 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski}; }; }; }; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski#endif 86