1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_script_DocumentScriptLibraryContainer_idl__
25#define __com_sun_star_script_DocumentScriptLibraryContainer_idl__
26
27#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
28#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
29#endif
30#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__
31#include <com/sun/star/document/XStorageBasedDocument.idl>
32#endif
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36
37
38//=============================================================================
39
40module com { module sun { module star { module script {
41
42//=============================================================================
43
44/** defines a container of StarBasic script libraries, which is to be made
45    persistent in a sub storage of a document storage.
46
47    @since OpenOffice 2.3
48 */
49service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
50{
51    /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document
52
53        <p>The current storage of the document will be set as initial root storage
54        (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p>
55
56        <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
57        the implementation of the document to which the container should belong.</p>
58
59        @param Document
60            The document to which the container should belong to. Must not be
61            <NULL/>.
62
63        @throws ::com::sun::star::lang::IllegalArgumentException
64            if <code>Document</code> does not denote a valid
65            <type scope="com::sun::star::document">OfficeDocument</type>.
66    */
67    create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
68        raises( ::com::sun::star::lang::IllegalArgumentException );
69
70};
71
72//=============================================================================
73
74}; }; }; };
75
76//=============================================================================
77
78#endif
79
80