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 28*cdf0e10cSrcweir 29*cdf0e10cSrcweir#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__ 30*cdf0e10cSrcweir#define __com_sun_star_script_XStorageBasedLibraryContainer_idl__ 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir#ifndef __com_sun_star_embed_XStorage_idl__ 33*cdf0e10cSrcweir#include <com/sun/star/embed/XStorage.idl> 34*cdf0e10cSrcweir#endif 35*cdf0e10cSrcweir#ifndef __com_sun_star_script_XPersistentLibraryContainer_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/script/XPersistentLibraryContainer.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweirmodule com { module sun { module star { module script { 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir/** is the interface for an <type>XLibraryContainer</type> which can be made 46*cdf0e10cSrcweir persistent in an <type scope="com::sun::star::embed">XStorage</type>. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir <p>A persistent library container is associated with a root storage. The 49*cdf0e10cSrcweir container is responsible for a particular sub storage of the root storage, 50*cdf0e10cSrcweir the container storage.</p> 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir @since OOo 2.3 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweirinterface XStorageBasedLibraryContainer 55*cdf0e10cSrcweir{ 56*cdf0e10cSrcweir interface XPersistentLibraryContainer; 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir /** denotes the root storage associated with the container. 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir <p>Effectively, this attribute is a typed version of 61*cdf0e10cSrcweir <member>XPersistentLibraryContainer::RootLocation</member>, it's guaranteed 62*cdf0e10cSrcweir that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and 63*cdf0e10cSrcweir <code>RootStorage</code> have the same value.</p> 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir <p>You should only <em>set</em> this attribute to a new value if you previously 66*cdf0e10cSrcweir called storeLibrariesToStorage with the same storage. Setting this attribute 67*cdf0e10cSrcweir to a storage into which the container has not been stored previously might 68*cdf0e10cSrcweir result in unexpected behaviour.</p> 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir [attribute] ::com::sun::star::embed::XStorage RootStorage 71*cdf0e10cSrcweir { 72*cdf0e10cSrcweir set raises ( ::com::sun::star::lang::IllegalArgumentException ); 73*cdf0e10cSrcweir }; 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** stores the libraries to a storage other than the current container storage 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir <p>Note that the library continer is not automatically associated with the 78*cdf0e10cSrcweir new root storage. Instead, you need to manually set the <type>RootStroage</type> 79*cdf0e10cSrcweir attribute afterwards. This separation allows for Save-To as well Save-As 80*cdf0e10cSrcweir operations.</p> 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir @param RootStorage 83*cdf0e10cSrcweir denotes the root storage into which the libraries should be written, which 84*cdf0e10cSrcweir must not be <NULL/>.<br/> 85*cdf0e10cSrcweir Note that the actual libraries are written into a sub storage of this 86*cdf0e10cSrcweir root storage, as usual. 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir @throws ::com::sun::star::lang::IllegalArgumentException 89*cdf0e10cSrcweir if the <code>RootStorage</code> parameter is <NULL/>, or equals 90*cdf0e10cSrcweir <member>RootStorage</member>. 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir @throws ::com::sun::star::lang::WrappedTargetException 93*cdf0e10cSrcweir if an error occurs during storing. 94*cdf0e10cSrcweir */ 95*cdf0e10cSrcweir void storeLibrariesToStorage( [in] ::com::sun::star::embed::XStorage RootStorage ) 96*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException ); 97*cdf0e10cSrcweir}; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir//============================================================================= 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir}; }; }; }; 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir//============================================================================= 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir#endif 106