1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
22 module com
{ module sun
{ module star
{ module script
{
25 /** is the interface for an XLibraryContainer which can be made
26 persistent in a com::sun::star::embed::XStorage.
28 <p>A persistent library container is associated with a root storage. The
29 container is responsible for a particular sub storage of the root storage,
30 the container storage.</p>
34 interface XStorageBasedLibraryContainer
36 interface XPersistentLibraryContainer
;
38 /** denotes the root storage associated with the container.
40 <p>Effectively, this attribute is a typed version of
41 XPersistentLibraryContainer::RootLocation, it's guaranteed
42 that at every time, <code>XPersistentLibraryContainer::RootLocation</code> and
43 <code>RootStorage</code> have the same value.</p>
45 <p>You should only <em>set</em> this attribute to a new value if you previously
46 called storeLibrariesToStorage with the same storage. Setting this attribute
47 to a storage into which the container has not been stored previously might
48 result in unexpected behavior.</p>
50 [attribute
] ::com
::sun
::star
::embed
::XStorage RootStorage
52 set raises
( ::com
::sun
::star
::lang
::IllegalArgumentException
);
55 /** stores the libraries to a storage other than the current container storage
57 <p>Note that the library container is not automatically associated with the
58 new root storage. Instead, you need to manually set the RootStorage
59 attribute afterwards. This separation allows for Save-To as well Save-As
63 denotes the root storage into which the libraries should be written, which
64 must not be `NULL`.<br/>
65 Note that the actual libraries are written into a sub storage of this
66 root storage, as usual.
68 @throws ::com::sun::star::lang::IllegalArgumentException
69 if the <code>RootStorage</code> parameter is `NULL`, or equals
72 @throws ::com::sun::star::lang::WrappedTargetException
73 if an error occurs during storing.
75 void storeLibrariesToStorage
( [in] ::com
::sun
::star
::embed
::XStorage RootStorage
)
76 raises
( ::com
::sun
::star
::lang
::IllegalArgumentException
, ::com
::sun
::star
::lang
::WrappedTargetException
);
83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */