1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_script_DocumentScriptLibraryContainer_idl__
29#define __com_sun_star_script_DocumentScriptLibraryContainer_idl__
30
31#ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
32#include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
33#endif
34#ifndef __com_sun_star_embed_XStorageBasedDocument_idl__
35#include <com/sun/star/document/XStorageBasedDocument.idl>
36#endif
37#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
38#include <com/sun/star/lang/IllegalArgumentException.idl>
39#endif
40
41
42//=============================================================================
43
44module com { module sun { module star { module script {
45
46//=============================================================================
47
48/** defines a container of StarBasic script libraries, which is to be made
49    persistent in a sub storage of a document storage.
50
51    @since OOo 2.3
52 */
53service DocumentScriptLibraryContainer : XStorageBasedLibraryContainer
54{
55    /** creates an instance of the <code>DocumentScriptLibraryContainer</code>, belonging to a document
56
57        <p>The current storage of the document will be set as initial root storage
58        (see <member>XPersistentLibraryContainer::RootStorage</member>) of the container.</p>
59
60        <p>Usually, you will only create a <code>DocumentScriptLibraryContainer</code> within
61        the implementation of the document to which the container should belong.</p>
62
63        @param Document
64            The document to which the container should belong to. Must not be
65            <NULL/>.
66
67        @throws ::com::sun::star::lang::IllegalArgumentException
68            if <code>Document</code> does not denote a valid
69            <type scope="com::sun::star::document">OfficeDocument</type>.
70    */
71    create( [in] ::com::sun::star::document::XStorageBasedDocument Document )
72        raises( ::com::sun::star::lang::IllegalArgumentException );
73
74};
75
76//=============================================================================
77
78}; }; }; };
79
80//=============================================================================
81
82#endif
83
84